reference.rst revision 14299:2fbea9df56d2 
1.. _reference:
2
3.. warning::
4
5    Please be advised that the reference documentation discussing pybind11
6    internals is currently incomplete. Please refer to the previous sections
7    and the pybind11 header files for the nitty gritty details.
8
9Reference
10#########
11
12.. _macros:
13
14Macros
15======
16
17.. doxygendefine:: PYBIND11_MODULE
18
19.. _core_types:
20
21Convenience classes for arbitrary Python types
22==============================================
23
24Common member functions
25-----------------------
26
27.. doxygenclass:: object_api
28    :members:
29
30Without reference counting
31--------------------------
32
33.. doxygenclass:: handle
34    :members:
35
36With reference counting
37-----------------------
38
39.. doxygenclass:: object
40    :members:
41
42.. doxygenfunction:: reinterpret_borrow
43
44.. doxygenfunction:: reinterpret_steal
45
46Convenience classes for specific Python types
47=============================================
48
49.. doxygenclass:: module
50    :members:
51
52.. doxygengroup:: pytypes
53    :members:
54
55.. _extras:
56
57Passing extra arguments to ``def`` or ``class_``
58================================================
59
60.. doxygengroup:: annotations
61    :members:
62
63Embedding the interpreter
64=========================
65
66.. doxygendefine:: PYBIND11_EMBEDDED_MODULE
67
68.. doxygenfunction:: initialize_interpreter
69
70.. doxygenfunction:: finalize_interpreter
71
72.. doxygenclass:: scoped_interpreter
73
74Redirecting C++ streams
75=======================
76
77.. doxygenclass:: scoped_ostream_redirect
78
79.. doxygenclass:: scoped_estream_redirect
80
81.. doxygenfunction:: add_ostream_redirect
82
83Python built-in functions
84=========================
85
86.. doxygengroup:: python_builtins
87    :members:
88
89Inheritance
90===========
91
92See :doc:`/classes` and :doc:`/advanced/classes` for more detail.
93
94.. doxygendefine:: PYBIND11_OVERLOAD
95
96.. doxygendefine:: PYBIND11_OVERLOAD_PURE
97
98.. doxygendefine:: PYBIND11_OVERLOAD_NAME
99
100.. doxygendefine:: PYBIND11_OVERLOAD_PURE_NAME
101
102.. doxygenfunction:: get_overload
103
104Exceptions
105==========
106
107.. doxygenclass:: error_already_set
108    :members:
109
110.. doxygenclass:: builtin_exception
111    :members:
112
113
114Literals
115========
116
117.. doxygennamespace:: literals
118