Warning, /jana2/src/python/externals/pybind11-2.10.3/docs/reference.rst is written in an unsupported language. File is not indexed.
0001 .. _reference:
0002
0003 .. warning::
0004
0005 Please be advised that the reference documentation discussing pybind11
0006 internals is currently incomplete. Please refer to the previous sections
0007 and the pybind11 header files for the nitty gritty details.
0008
0009 Reference
0010 #########
0011
0012 .. _macros:
0013
0014 Macros
0015 ======
0016
0017 .. doxygendefine:: PYBIND11_MODULE
0018
0019 .. _core_types:
0020
0021 Convenience classes for arbitrary Python types
0022 ==============================================
0023
0024 Common member functions
0025 -----------------------
0026
0027 .. doxygenclass:: object_api
0028 :members:
0029
0030 Without reference counting
0031 --------------------------
0032
0033 .. doxygenclass:: handle
0034 :members:
0035
0036 With reference counting
0037 -----------------------
0038
0039 .. doxygenclass:: object
0040 :members:
0041
0042 .. doxygenfunction:: reinterpret_borrow
0043
0044 .. doxygenfunction:: reinterpret_steal
0045
0046 Convenience classes for specific Python types
0047 =============================================
0048
0049 .. doxygenclass:: module_
0050 :members:
0051
0052 .. doxygengroup:: pytypes
0053 :members:
0054
0055 Convenience functions converting to Python types
0056 ================================================
0057
0058 .. doxygenfunction:: make_tuple(Args&&...)
0059
0060 .. doxygenfunction:: make_iterator(Iterator, Sentinel, Extra &&...)
0061 .. doxygenfunction:: make_iterator(Type &, Extra&&...)
0062
0063 .. doxygenfunction:: make_key_iterator(Iterator, Sentinel, Extra &&...)
0064 .. doxygenfunction:: make_key_iterator(Type &, Extra&&...)
0065
0066 .. doxygenfunction:: make_value_iterator(Iterator, Sentinel, Extra &&...)
0067 .. doxygenfunction:: make_value_iterator(Type &, Extra&&...)
0068
0069 .. _extras:
0070
0071 Passing extra arguments to ``def`` or ``class_``
0072 ================================================
0073
0074 .. doxygengroup:: annotations
0075 :members:
0076
0077 Embedding the interpreter
0078 =========================
0079
0080 .. doxygendefine:: PYBIND11_EMBEDDED_MODULE
0081
0082 .. doxygenfunction:: initialize_interpreter
0083
0084 .. doxygenfunction:: finalize_interpreter
0085
0086 .. doxygenclass:: scoped_interpreter
0087
0088 Redirecting C++ streams
0089 =======================
0090
0091 .. doxygenclass:: scoped_ostream_redirect
0092
0093 .. doxygenclass:: scoped_estream_redirect
0094
0095 .. doxygenfunction:: add_ostream_redirect
0096
0097 Python built-in functions
0098 =========================
0099
0100 .. doxygengroup:: python_builtins
0101 :members:
0102
0103 Inheritance
0104 ===========
0105
0106 See :doc:`/classes` and :doc:`/advanced/classes` for more detail.
0107
0108 .. doxygendefine:: PYBIND11_OVERRIDE
0109
0110 .. doxygendefine:: PYBIND11_OVERRIDE_PURE
0111
0112 .. doxygendefine:: PYBIND11_OVERRIDE_NAME
0113
0114 .. doxygendefine:: PYBIND11_OVERRIDE_PURE_NAME
0115
0116 .. doxygenfunction:: get_override
0117
0118 Exceptions
0119 ==========
0120
0121 .. doxygenclass:: error_already_set
0122 :members:
0123
0124 .. doxygenclass:: builtin_exception
0125 :members:
0126
0127 Literals
0128 ========
0129
0130 .. doxygennamespace:: literals
