github.com/kaydxh/golang@v0.0.131/pkg/gocv/cgo/third_path/pybind11/docs/reference.rst (about)

     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  
     9  Reference
    10  #########
    11  
    12  .. _macros:
    13  
    14  Macros
    15  ======
    16  
    17  .. doxygendefine:: PYBIND11_MODULE
    18  
    19  .. _core_types:
    20  
    21  Convenience classes for arbitrary Python types
    22  ==============================================
    23  
    24  Common member functions
    25  -----------------------
    26  
    27  .. doxygenclass:: object_api
    28      :members:
    29  
    30  Without reference counting
    31  --------------------------
    32  
    33  .. doxygenclass:: handle
    34      :members:
    35  
    36  With reference counting
    37  -----------------------
    38  
    39  .. doxygenclass:: object
    40      :members:
    41  
    42  .. doxygenfunction:: reinterpret_borrow
    43  
    44  .. doxygenfunction:: reinterpret_steal
    45  
    46  Convenience classes for specific Python types
    47  =============================================
    48  
    49  .. doxygenclass:: module_
    50      :members:
    51  
    52  .. doxygengroup:: pytypes
    53      :members:
    54  
    55  Convenience functions converting to Python types
    56  ================================================
    57  
    58  .. doxygenfunction:: make_tuple(Args&&...)
    59  
    60  .. doxygenfunction:: make_iterator(Iterator, Sentinel, Extra &&...)
    61  .. doxygenfunction:: make_iterator(Type &, Extra&&...)
    62  
    63  .. doxygenfunction:: make_key_iterator(Iterator, Sentinel, Extra &&...)
    64  .. doxygenfunction:: make_key_iterator(Type &, Extra&&...)
    65  
    66  .. doxygenfunction:: make_value_iterator(Iterator, Sentinel, Extra &&...)
    67  .. doxygenfunction:: make_value_iterator(Type &, Extra&&...)
    68  
    69  .. _extras:
    70  
    71  Passing extra arguments to ``def`` or ``class_``
    72  ================================================
    73  
    74  .. doxygengroup:: annotations
    75      :members:
    76  
    77  Embedding the interpreter
    78  =========================
    79  
    80  .. doxygendefine:: PYBIND11_EMBEDDED_MODULE
    81  
    82  .. doxygenfunction:: initialize_interpreter
    83  
    84  .. doxygenfunction:: finalize_interpreter
    85  
    86  .. doxygenclass:: scoped_interpreter
    87  
    88  Redirecting C++ streams
    89  =======================
    90  
    91  .. doxygenclass:: scoped_ostream_redirect
    92  
    93  .. doxygenclass:: scoped_estream_redirect
    94  
    95  .. doxygenfunction:: add_ostream_redirect
    96  
    97  Python built-in functions
    98  =========================
    99  
   100  .. doxygengroup:: python_builtins
   101      :members:
   102  
   103  Inheritance
   104  ===========
   105  
   106  See :doc:`/classes` and :doc:`/advanced/classes` for more detail.
   107  
   108  .. doxygendefine:: PYBIND11_OVERRIDE
   109  
   110  .. doxygendefine:: PYBIND11_OVERRIDE_PURE
   111  
   112  .. doxygendefine:: PYBIND11_OVERRIDE_NAME
   113  
   114  .. doxygendefine:: PYBIND11_OVERRIDE_PURE_NAME
   115  
   116  .. doxygenfunction:: get_override
   117  
   118  Exceptions
   119  ==========
   120  
   121  .. doxygenclass:: error_already_set
   122      :members:
   123  
   124  .. doxygenclass:: builtin_exception
   125      :members:
   126  
   127  Literals
   128  ========
   129  
   130  .. doxygennamespace:: literals