.. _reference:

.. 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.

Reference
#########

.. _macros:

Macros
======

.. doxygendefine:: PYBIND11_MODULE

.. _core_types:

Convenience classes for arbitrary Python types
==============================================

Common member functions
-----------------------

.. doxygenclass:: object_api
    :members:

Without reference counting
--------------------------

.. doxygenclass:: handle
    :members:

With reference counting
-----------------------

.. doxygenclass:: object
    :members:

.. doxygenfunction:: reinterpret_borrow

.. doxygenfunction:: reinterpret_steal

Convenience classes for specific Python types
=============================================

.. doxygenclass:: module
    :members:

.. doxygengroup:: pytypes
    :members:

.. _extras:

Passing extra arguments to ``def`` or ``class_``
================================================

.. doxygengroup:: annotations
    :members:

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

Python built-in functions
=========================

.. doxygengroup:: python_builtins
    :members:

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
==========

.. doxygenclass:: error_already_set
    :members:

.. doxygenclass:: builtin_exception
    :members:


Literals
========

.. doxygennamespace:: literals
a href='/cgit/openwrt/em-br6478acv2/master-187ad058/commit/target/linux/generic/patches-3.18/653-disable_netlink_trim.patch?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>commit</a><a href='/cgit/openwrt/em-br6478acv2/master-187ad058/diff/target/linux/generic/patches-3.18/653-disable_netlink_trim.patch?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>diff</a><a href='/cgit/openwrt/em-br6478acv2/master-187ad058/stats/target/linux/generic/patches-3.18/653-disable_netlink_trim.patch'>stats</a></td><td class='form'><form class='right' method='get' action='/cgit/openwrt/em-br6478acv2/master-187ad058/log/target/linux/generic/patches-3.18/653-disable_netlink_trim.patch'>
<input type='hidden' name='id' value='55a91bf13e0983ca302ca382305a23e8507e71a2'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/cgit/openwrt/em-br6478acv2/master-187ad058/tree/?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>root</a>/<a href='/cgit/openwrt/em-br6478acv2/master-187ad058/tree/target?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>target</a>/<a href='/cgit/openwrt/em-br6478acv2/master-187ad058/tree/target/linux?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>linux</a>/<a href='/cgit/openwrt/em-br6478acv2/master-187ad058/tree/target/linux/generic?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>generic</a>/<a href='/cgit/openwrt/em-br6478acv2/master-187ad058/tree/target/linux/generic/patches-3.18?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>patches-3.18</a>/<a href='/cgit/openwrt/em-br6478acv2/master-187ad058/tree/target/linux/generic/patches-3.18/653-disable_netlink_trim.patch?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>653-disable_netlink_trim.patch</a></div><div class='content'>blob: 5732596792912ff7fd6d24633110dc69e1b08700 (<a href='/cgit/openwrt/em-br6478acv2/master-187ad058/plain/target/linux/generic/patches-3.18/653-disable_netlink_trim.patch?id=55a91bf13e0983ca302ca382305a23e8507e71a2'>plain</a>)
<table summary='blob content' class='blob'>
<tr><td class='linenumbers'><pre><a id='n1' href='#n1'>1</a>
<a id='n2' href='#n2'>2</a>
<a id='n3' href='#n3'>3</a>
<a id='n4' href='#n4'>4</a>
<a id='n5' href='#n5'>5</a>
<a id='n6' href='#n6'>6</a>
<a id='n7' href='#n7'>7</a>
<a id='n8' href='#n8'>8</a>
<a id='n9' href='#n9'>9</a>
<a id='n10' href='#n10'>10</a>
<a id='n11' href='#n11'>11</a>
<a id='n12' href='#n12'>12</a>
<a id='n13' href='#n13'>13</a>
<a id='n14' href='#n14'>14</a>
<a id='n15' href='#n15'>15</a>
<a id='n16' href='#n16'>16</a>
<a id='n17' href='#n17'>17</a>
<a id='n18' href='#n18'>18</a>
<a id='n19' href='#n19'>19</a>
<a id='n20' href='#n20'>20</a>
<a id='n21' href='#n21'>21</a>
<a id='n22' href='#n22'>22</a>
<a id='n23' href='#n23'>23</a>
<a id='n24' href='#n24'>24</a>
<a id='n25' href='#n25'>25</a>
<a id='n26' href='#n26'>26</a>
<a id='n27' href='#n27'>27</a>
<a id='n28' href='#n28'>28</a>
<a id='n29' href='#n29'>29</a>
<a id='n30' href='#n30'>30</a>
</pre></td>
<td class='lines'><pre><code>