Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / pybind11 / d400f60c96312f32fafcb15168bbf56970ff3d3a / . / docs / reference.rst
blob: 3d211f7e96b0c425ddfd358c23c7f5ac2d48acd2 [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
12Macros
13======
14
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]15.. doxygendefine:: PYBIND11_PLUGIN
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]16
17.. _core_types:
18
19Convenience classes for arbitrary Python types
20==============================================
21
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]22Common member functions
23-----------------------
24
25.. doxygenclass:: object_api
26 :members:
27
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]28Without reference counting
29--------------------------
30
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]31.. doxygenclass:: handle
32 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]33
34With reference counting
35-----------------------
36
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]37.. doxygenclass:: object
38 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]39
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]40.. doxygenfunction:: reinterpret_borrow
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]41
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]42.. doxygenfunction:: reinterpret_steal
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]43
44Convenience classes for specific Python types
45=============================================
46
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]47.. doxygenclass:: module
48 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]49
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]50.. doxygengroup:: pytypes
51 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]52
53.. _extras:
54
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]55Passing extra arguments to ``def`` or ``class_``
56================================================
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]57
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]58.. doxygengroup:: annotations
59 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]60
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]61Python build-in functions
62=========================
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]63
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]64.. doxygengroup:: python_builtins
65 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]66
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]67Exceptions
68==========
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]69
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]70.. doxygenclass:: error_already_set
71 :members:
Wenzel Jakob93296692015-10-13 23:21:54 +0200[diff] [blame]72
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]73.. doxygenclass:: builtin_exception
74 :members:
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]75
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]76
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]77Literals
78========
Wenzel Jakob28f98aa2015-10-13 02:57:16 +0200[diff] [blame]79
Dean Moldovan57a9bbc2017-01-31 16:54:08 +0100[diff] [blame]80.. doxygennamespace:: literals