Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / pybind11 / 51ca6b08327810c0edfc70c0c1a3cc074dc39b5f / . / docs / reference.rst
blob: a9fbe60015ca466e71a37f6f9cd9866bfa7adfe5 [file] [log] [blame]
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]1.. _reference:
2
Wenzel Jakob93296692015-10-13 23:21:54 +0200[diff] [blame]3.. warning::
4
5 Please be advised that the reference documentation discussing pybind11
6 internals is currently incomplete. Please refer to the previous sections
Wenzel Jakob8f4eb002015-10-15 18:13:33 +0200[diff] [blame]7 and the pybind11 header files for the nitty gritty details.
Wenzel Jakob93296692015-10-13 23:21:54 +0200[diff] [blame]8
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]9Reference
10#########
11
Dean Moldovandb46a892017-08-13 22:25:15 +0200[diff] [blame]12.. _macros:
13
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]14Macros
15======
16
Dean Moldovan443ab592017-04-24 01:51:44 +0200[diff] [blame]17.. doxygendefine:: PYBIND11_MODULE
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]18
19.. _core_types:
20
21Convenience classes for arbitrary Python types
22==============================================
23
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]24Common member functions
25-----------------------
26
27.. doxygenclass:: object_api
28 :members:
29
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]30Without reference counting
31--------------------------
32
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]33.. doxygenclass:: handle
34 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]35
36With reference counting
37-----------------------
38
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]39.. doxygenclass:: object
40 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]41
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]42.. doxygenfunction:: reinterpret_borrow
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]43
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]44.. doxygenfunction:: reinterpret_steal
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]45
46Convenience classes for specific Python types
47=============================================
48
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]49.. doxygenclass:: module
50 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]51
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]52.. doxygengroup:: pytypes
53 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]54
55.. _extras:
56
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]57Passing extra arguments to ``def`` or ``class_``
58================================================
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]59
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]60.. doxygengroup:: annotations
61 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]62
Dean Moldovan22c413b2017-03-30 00:20:42 +0200[diff] [blame]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
Henry Schreiner8b405052017-08-24 17:12:43 -0700[diff] [blame]74Redirecting C++ streams
75=======================
76
77.. doxygenclass:: scoped_ostream_redirect
78
79.. doxygenclass:: scoped_estream_redirect
80
81.. doxygenfunction:: add_ostream_redirect
82
Boris Dalsteinb30734e2018-07-01 17:47:22 +0200[diff] [blame]83Python built-in functions
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]84=========================
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]85
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]86.. doxygengroup:: python_builtins
87 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]88
Ivor Wanders2b045752019-06-10 16:12:28 -0400[diff] [blame]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
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]104Exceptions
105==========
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]106
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]107.. doxygenclass:: error_already_set
108 :members:
Wenzel Jakob93296692015-10-13 23:21:54 +0200[diff] [blame]109
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]110.. doxygenclass:: builtin_exception
111 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]112
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]113
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]114Literals
115========
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]116
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]117.. doxygennamespace:: literals