reference.rst revision 14299:2fbea9df56d2
1955SN/A.. _reference: 2955SN/A 314209Sandreas.sandberg@arm.com.. warning:: 49812Sandreas.hansson@arm.com 59812Sandreas.hansson@arm.com Please be advised that the reference documentation discussing pybind11 69812Sandreas.hansson@arm.com internals is currently incomplete. Please refer to the previous sections 79812Sandreas.hansson@arm.com and the pybind11 header files for the nitty gritty details. 89812Sandreas.hansson@arm.com 99812Sandreas.hansson@arm.comReference 109812Sandreas.hansson@arm.com######### 119812Sandreas.hansson@arm.com 129812Sandreas.hansson@arm.com.. _macros: 139812Sandreas.hansson@arm.com 149812Sandreas.hansson@arm.comMacros 157816Ssteve.reinhardt@amd.com====== 165871Snate@binkert.org 171762SN/A.. doxygendefine:: PYBIND11_MODULE 18955SN/A 19955SN/A.. _core_types: 20955SN/A 21955SN/AConvenience classes for arbitrary Python types 22955SN/A============================================== 23955SN/A 24955SN/ACommon member functions 25955SN/A----------------------- 26955SN/A 27955SN/A.. doxygenclass:: object_api 28955SN/A :members: 29955SN/A 30955SN/AWithout reference counting 31955SN/A-------------------------- 32955SN/A 33955SN/A.. doxygenclass:: handle 34955SN/A :members: 35955SN/A 36955SN/AWith reference counting 37955SN/A----------------------- 38955SN/A 39955SN/A.. doxygenclass:: object 40955SN/A :members: 41955SN/A 422665Ssaidi@eecs.umich.edu.. doxygenfunction:: reinterpret_borrow 432665Ssaidi@eecs.umich.edu 445863Snate@binkert.org.. doxygenfunction:: reinterpret_steal 45955SN/A 46955SN/AConvenience classes for specific Python types 47955SN/A============================================= 48955SN/A 49955SN/A.. doxygenclass:: module 508878Ssteve.reinhardt@amd.com :members: 512632Sstever@eecs.umich.edu 528878Ssteve.reinhardt@amd.com.. doxygengroup:: pytypes 532632Sstever@eecs.umich.edu :members: 54955SN/A 558878Ssteve.reinhardt@amd.com.. _extras: 562632Sstever@eecs.umich.edu 572761Sstever@eecs.umich.eduPassing extra arguments to ``def`` or ``class_`` 582632Sstever@eecs.umich.edu================================================ 592632Sstever@eecs.umich.edu 602632Sstever@eecs.umich.edu.. doxygengroup:: annotations 612761Sstever@eecs.umich.edu :members: 622761Sstever@eecs.umich.edu 632761Sstever@eecs.umich.eduEmbedding the interpreter 648878Ssteve.reinhardt@amd.com========================= 658878Ssteve.reinhardt@amd.com 662761Sstever@eecs.umich.edu.. doxygendefine:: PYBIND11_EMBEDDED_MODULE 672761Sstever@eecs.umich.edu 682761Sstever@eecs.umich.edu.. doxygenfunction:: initialize_interpreter 692761Sstever@eecs.umich.edu 702761Sstever@eecs.umich.edu.. doxygenfunction:: finalize_interpreter 718878Ssteve.reinhardt@amd.com 728878Ssteve.reinhardt@amd.com.. doxygenclass:: scoped_interpreter 732632Sstever@eecs.umich.edu 742632Sstever@eecs.umich.eduRedirecting C++ streams 758878Ssteve.reinhardt@amd.com======================= 768878Ssteve.reinhardt@amd.com 772632Sstever@eecs.umich.edu.. doxygenclass:: scoped_ostream_redirect 78955SN/A 79955SN/A.. doxygenclass:: scoped_estream_redirect 80955SN/A 8112563Sgabeblack@google.com.. doxygenfunction:: add_ostream_redirect 8212563Sgabeblack@google.com 836654Snate@binkert.orgPython built-in functions 8410196SCurtis.Dunham@arm.com========================= 85955SN/A 865396Ssaidi@eecs.umich.edu.. doxygengroup:: python_builtins 8711401Sandreas.sandberg@arm.com :members: 885863Snate@binkert.org 895863Snate@binkert.orgInheritance 904202Sbinkertn@umich.edu=========== 915863Snate@binkert.org 925863Snate@binkert.orgSee :doc:`/classes` and :doc:`/advanced/classes` for more detail. 935863Snate@binkert.org 945863Snate@binkert.org.. doxygendefine:: PYBIND11_OVERLOAD 9513541Sandrea.mondelli@ucf.edu 96955SN/A.. doxygendefine:: PYBIND11_OVERLOAD_PURE 976654Snate@binkert.org 985273Sstever@gmail.com.. doxygendefine:: PYBIND11_OVERLOAD_NAME 995871Snate@binkert.org 10013758Sgabeblack@google.com.. doxygendefine:: PYBIND11_OVERLOAD_PURE_NAME 1015273Sstever@gmail.com 1026654Snate@binkert.org.. doxygenfunction:: get_overload 1035396Ssaidi@eecs.umich.edu 1048120Sgblack@eecs.umich.eduExceptions 1058120Sgblack@eecs.umich.edu========== 1068120Sgblack@eecs.umich.edu 1078120Sgblack@eecs.umich.edu.. doxygenclass:: error_already_set 1088120Sgblack@eecs.umich.edu :members: 1098120Sgblack@eecs.umich.edu 1108120Sgblack@eecs.umich.edu.. doxygenclass:: builtin_exception 1118120Sgblack@eecs.umich.edu :members: 1128879Ssteve.reinhardt@amd.com 1138879Ssteve.reinhardt@amd.com 1148879Ssteve.reinhardt@amd.comLiterals 1158879Ssteve.reinhardt@amd.com======== 1168879Ssteve.reinhardt@amd.com 1178879Ssteve.reinhardt@amd.com.. doxygennamespace:: literals 1188879Ssteve.reinhardt@amd.com