pybind11/docs/reference.rst

118 lines
2.1 KiB
ReStructuredText
Raw Normal View History

2015-10-13 00:57:16 +00:00
.. _reference:
2015-10-13 21:21:54 +00:00
.. warning::
Please be advised that the reference documentation discussing pybind11
internals is currently incomplete. Please refer to the previous sections
and the pybind11 header files for the nitty gritty details.
2015-10-13 21:21:54 +00:00
2015-10-13 00:57:16 +00:00
Reference
#########
2017-08-13 20:25:15 +00:00
.. _macros:
2015-10-13 00:57:16 +00:00
Macros
======
.. doxygendefine:: PYBIND11_MODULE
2015-10-13 00:57:16 +00:00
.. _core_types:
Convenience classes for arbitrary Python types
==============================================
Common member functions
-----------------------
2015-10-13 00:57:16 +00:00
.. doxygenclass:: object_api
:members:
2015-10-13 00:57:16 +00:00
Without reference counting
--------------------------
2015-10-13 00:57:16 +00:00
.. doxygenclass:: handle
:members:
2015-10-13 00:57:16 +00:00
With reference counting
-----------------------
.. doxygenclass:: object
:members:
.. doxygenfunction:: reinterpret_borrow
.. doxygenfunction:: reinterpret_steal
2015-10-13 00:57:16 +00:00
Convenience classes for specific Python types
=============================================
.. doxygenclass:: module
:members:
2015-10-13 00:57:16 +00:00
.. doxygengroup:: pytypes
:members:
2015-10-13 00:57:16 +00:00
.. _extras:
Passing extra arguments to ``def`` or ``class_``
================================================
2015-10-13 00:57:16 +00:00
.. doxygengroup:: annotations
:members:
2015-10-13 00:57:16 +00:00
Embedding the interpreter
=========================
.. doxygendefine:: PYBIND11_EMBEDDED_MODULE
.. doxygenfunction:: initialize_interpreter
.. doxygenfunction:: finalize_interpreter
.. doxygenclass:: scoped_interpreter
Redirecting C++ streams
=======================
.. doxygenclass:: scoped_ostream_redirect
.. doxygenclass:: scoped_estream_redirect
.. doxygenfunction:: add_ostream_redirect
2018-07-01 15:47:22 +00:00
Python built-in functions
=========================
2015-10-13 00:57:16 +00:00
.. doxygengroup:: python_builtins
:members:
2015-10-13 00:57:16 +00:00
Inheritance
===========
See :doc:`/classes` and :doc:`/advanced/classes` for more detail.
.. doxygendefine:: PYBIND11_OVERLOAD
.. doxygendefine:: PYBIND11_OVERLOAD_PURE
.. doxygendefine:: PYBIND11_OVERLOAD_NAME
.. doxygendefine:: PYBIND11_OVERLOAD_PURE_NAME
.. doxygenfunction:: get_overload
Exceptions
==========
2015-10-13 00:57:16 +00:00
.. doxygenclass:: error_already_set
:members:
2015-10-13 00:57:16 +00:00
.. doxygenclass:: builtin_exception
:members:
2015-10-13 00:57:16 +00:00
Literals
========
2016-06-09 14:10:26 +00:00
.. doxygennamespace:: literals