reference.rst revision 12391
111986Sandreas.sandberg@arm.com.. _reference: 211986Sandreas.sandberg@arm.com 311986Sandreas.sandberg@arm.com.. warning:: 411986Sandreas.sandberg@arm.com 511986Sandreas.sandberg@arm.com Please be advised that the reference documentation discussing pybind11 611986Sandreas.sandberg@arm.com internals is currently incomplete. Please refer to the previous sections 711986Sandreas.sandberg@arm.com and the pybind11 header files for the nitty gritty details. 811986Sandreas.sandberg@arm.com 911986Sandreas.sandberg@arm.comReference 1011986Sandreas.sandberg@arm.com######### 1111986Sandreas.sandberg@arm.com 1212391Sjason@lowepower.com.. _macros: 1312391Sjason@lowepower.com 1411986Sandreas.sandberg@arm.comMacros 1511986Sandreas.sandberg@arm.com====== 1611986Sandreas.sandberg@arm.com 1712391Sjason@lowepower.com.. doxygendefine:: PYBIND11_MODULE 1811986Sandreas.sandberg@arm.com 1911986Sandreas.sandberg@arm.com.. _core_types: 2011986Sandreas.sandberg@arm.com 2111986Sandreas.sandberg@arm.comConvenience classes for arbitrary Python types 2211986Sandreas.sandberg@arm.com============================================== 2311986Sandreas.sandberg@arm.com 2412037Sandreas.sandberg@arm.comCommon member functions 2512037Sandreas.sandberg@arm.com----------------------- 2612037Sandreas.sandberg@arm.com 2712037Sandreas.sandberg@arm.com.. doxygenclass:: object_api 2812037Sandreas.sandberg@arm.com :members: 2912037Sandreas.sandberg@arm.com 3011986Sandreas.sandberg@arm.comWithout reference counting 3111986Sandreas.sandberg@arm.com-------------------------- 3211986Sandreas.sandberg@arm.com 3312037Sandreas.sandberg@arm.com.. doxygenclass:: handle 3412037Sandreas.sandberg@arm.com :members: 3511986Sandreas.sandberg@arm.com 3611986Sandreas.sandberg@arm.comWith reference counting 3711986Sandreas.sandberg@arm.com----------------------- 3811986Sandreas.sandberg@arm.com 3912037Sandreas.sandberg@arm.com.. doxygenclass:: object 4012037Sandreas.sandberg@arm.com :members: 4111986Sandreas.sandberg@arm.com 4212037Sandreas.sandberg@arm.com.. doxygenfunction:: reinterpret_borrow 4311986Sandreas.sandberg@arm.com 4412037Sandreas.sandberg@arm.com.. doxygenfunction:: reinterpret_steal 4511986Sandreas.sandberg@arm.com 4611986Sandreas.sandberg@arm.comConvenience classes for specific Python types 4711986Sandreas.sandberg@arm.com============================================= 4811986Sandreas.sandberg@arm.com 4912037Sandreas.sandberg@arm.com.. doxygenclass:: module 5012037Sandreas.sandberg@arm.com :members: 5111986Sandreas.sandberg@arm.com 5212037Sandreas.sandberg@arm.com.. doxygengroup:: pytypes 5312037Sandreas.sandberg@arm.com :members: 5411986Sandreas.sandberg@arm.com 5511986Sandreas.sandberg@arm.com.. _extras: 5611986Sandreas.sandberg@arm.com 5712037Sandreas.sandberg@arm.comPassing extra arguments to ``def`` or ``class_`` 5812037Sandreas.sandberg@arm.com================================================ 5911986Sandreas.sandberg@arm.com 6012037Sandreas.sandberg@arm.com.. doxygengroup:: annotations 6112037Sandreas.sandberg@arm.com :members: 6211986Sandreas.sandberg@arm.com 6312391Sjason@lowepower.comEmbedding the interpreter 6412391Sjason@lowepower.com========================= 6512391Sjason@lowepower.com 6612391Sjason@lowepower.com.. doxygendefine:: PYBIND11_EMBEDDED_MODULE 6712391Sjason@lowepower.com 6812391Sjason@lowepower.com.. doxygenfunction:: initialize_interpreter 6912391Sjason@lowepower.com 7012391Sjason@lowepower.com.. doxygenfunction:: finalize_interpreter 7112391Sjason@lowepower.com 7212391Sjason@lowepower.com.. doxygenclass:: scoped_interpreter 7312391Sjason@lowepower.com 7412391Sjason@lowepower.comRedirecting C++ streams 7512391Sjason@lowepower.com======================= 7612391Sjason@lowepower.com 7712391Sjason@lowepower.com.. doxygenclass:: scoped_ostream_redirect 7812391Sjason@lowepower.com 7912391Sjason@lowepower.com.. doxygenclass:: scoped_estream_redirect 8012391Sjason@lowepower.com 8112391Sjason@lowepower.com.. doxygenfunction:: add_ostream_redirect 8212391Sjason@lowepower.com 8312037Sandreas.sandberg@arm.comPython build-in functions 8412037Sandreas.sandberg@arm.com========================= 8511986Sandreas.sandberg@arm.com 8612037Sandreas.sandberg@arm.com.. doxygengroup:: python_builtins 8712037Sandreas.sandberg@arm.com :members: 8811986Sandreas.sandberg@arm.com 8912037Sandreas.sandberg@arm.comExceptions 9012037Sandreas.sandberg@arm.com========== 9111986Sandreas.sandberg@arm.com 9212037Sandreas.sandberg@arm.com.. doxygenclass:: error_already_set 9312037Sandreas.sandberg@arm.com :members: 9411986Sandreas.sandberg@arm.com 9512037Sandreas.sandberg@arm.com.. doxygenclass:: builtin_exception 9612037Sandreas.sandberg@arm.com :members: 9711986Sandreas.sandberg@arm.com 9811986Sandreas.sandberg@arm.com 9912037Sandreas.sandberg@arm.comLiterals 10012037Sandreas.sandberg@arm.com======== 10111986Sandreas.sandberg@arm.com 10212037Sandreas.sandberg@arm.com.. doxygennamespace:: literals 103