#include "detail/common.h"#include "buffer_info.h"#include <assert.h>#include <cstddef>#include <exception>#include <frameobject.h>#include <iterator>#include <memory>#include <string>#include <type_traits>#include <typeinfo>#include <utility>
Include dependency graph for pytypes.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Classes | |
| class | accessor< Policy > |
| class | anyset |
| class | args |
| class | args_proxy |
| struct | arrow_proxy< T > |
Quick proxy class needed to implement operator-> for iterators which can't return pointers. More... | |
| class | bool_ |
| struct | object::borrowed_t |
| class | buffer |
| class | bytearray |
| class | bytes |
| class | capsule |
| class | dict |
| class | dict_readonly |
| Python's dictionary protocol permits this to be a forward iterator. More... | |
| class | ellipsis |
| class | error_already_set |
| struct | error_fetch_and_normalize |
| class | float_ |
| class | frozenset |
| class | function |
| struct | generic_item |
| class | generic_iterator< Policy > |
| STL iterator template used for tuple, list, sequence and dict. More... | |
| class | handle |
| class | int_ |
| class | iterable |
| class | iterator |
| class | kwargs |
| class | kwargs_proxy |
| class | list |
| struct | list_item |
| class | memoryview |
| class | none |
| struct | obj_attr |
| class | object |
| class | object_api< Derived > |
| class | pyobject_tag |
| Tag and check to identify a class which implements the Python object API. More... | |
| class | sequence |
| class | sequence_fast_readonly |
Lightweight iterator policy using just a simple pointer: see PySequence_Fast_ITEMS More... | |
| struct | sequence_item |
| class | sequence_slow_readwrite |
Full read and write access using the sequence protocol: see detail::sequence_accessor More... | |
| class | set |
| class | simple_collector< policy > |
| class | slice |
| class | staticmethod |
| struct | object::stolen_t |
| class | str |
| struct | str_attr |
| class | tuple |
| struct | tuple_item |
| class | type |
| class | unpacking_collector< policy > |
| Helper class which collects positional, keyword, * and ** arguments for a Python function call. More... | |
| class | weakref |
Namespaces | |
| accessor_policies | |
| literals | |
Macros | |
| #define | PYBIND11_HANDLE_REF_DEBUG |
| #define | PYBIND11_INPLACE_OP(iop) object iop(object_api const &other) { return operator=(handle::iop(other)); } |
| #define | PYBIND11_MATH_OPERATOR_BINARY(op, fn) |
| #define | PYBIND11_MATH_OPERATOR_BINARY_INPLACE(iop, fn) |
| #define | PYBIND11_MATH_OPERATOR_UNARY(op, fn) |
| #define | PYBIND11_OBJECT(Name, Parent, CheckFun) |
| #define | PYBIND11_OBJECT_CHECK_FAILED(Name, o_ptr) |
| #define | PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) |
| #define | PYBIND11_OBJECT_CVT(Name, Parent, CheckFun, ConvertFun) |
| #define | PYBIND11_OBJECT_CVT_DEFAULT(Name, Parent, CheckFun, ConvertFun) |
| #define | PYBIND11_OBJECT_DEFAULT(Name, Parent, CheckFun) |
| #define | PYBIND11_STR_CHECK_FUN PyUnicode_Check |
Typedefs | |
| using | dict_iterator = generic_iterator< iterator_policies::dict_readonly > |
| template<typename T > | |
| using | is_ds_unpacking = std::is_same< kwargs_proxy, T > |
| template<typename T > | |
| using | is_keyword = std::is_base_of< arg, T > |
| Python argument categories (using PEP 448 terms) More... | |
| template<typename T > | |
| using | is_keyword_or_ds = satisfies_any_of< T, is_keyword, is_ds_unpacking > |
| template<typename T > | |
| using | is_positional = satisfies_none_of< T, is_keyword, is_s_unpacking, is_ds_unpacking > |
| template<typename T > | |
| using | is_pyobj_ptr_or_nullptr_t = detail::any_of< std::is_same< T, PyObject * >, std::is_same< T, PyObject *const >, std::is_same< T, std::nullptr_t > > |
| template<typename T > | |
| using | is_pyobject = std::is_base_of< pyobject_tag, remove_reference_t< T > > |
| template<typename T > | |
| using | is_s_unpacking = std::is_same< args_proxy, T > |
| using | item_accessor = accessor< accessor_policies::generic_item > |
| using | list_accessor = accessor< accessor_policies::list_item > |
| using | list_iterator = generic_iterator< iterator_policies::sequence_fast_readonly > |
| using | obj_attr_accessor = accessor< accessor_policies::obj_attr > |
| using | sequence_accessor = accessor< accessor_policies::sequence_item > |
| using | sequence_iterator = generic_iterator< iterator_policies::sequence_slow_readwrite > |
| using | str_attr_accessor = accessor< accessor_policies::str_attr > |
| using | tuple_accessor = accessor< accessor_policies::tuple_item > |
| using | tuple_iterator = generic_iterator< iterator_policies::sequence_fast_readonly > |
Functions | |
| template<typename... Args> | |
| constexpr bool | args_are_all_keyword_or_ds () |
| template<typename Unsigned > | |
| Unsigned | as_unsigned (PyObject *o) |
| void | delattr (handle obj, const char *name) |
| void | delattr (handle obj, handle name) |
| PyObject * | dict_getitem (PyObject *v, PyObject *key) |
| PyObject * | dict_getitemstring (PyObject *v, const char *key) |
| std::string | error_string () |
| handle | get_function (handle value) |
| object | getattr (handle obj, const char *name) |
| object | getattr (handle obj, const char *name, handle default_) |
| object | getattr (handle obj, handle name) |
| object | getattr (handle obj, handle name, handle default_) |
| bool | hasattr (handle obj, const char *name) |
| bool | hasattr (handle obj, handle name) |
| ssize_t | hash (handle obj) |
| template<typename T , detail::enable_if_t< std::is_base_of< object, T >::value, int > = 0> | |
| bool | isinstance (handle obj) |
| bool | isinstance (handle obj, handle type) |
| template<> | |
| bool | isinstance< handle > (handle)=delete |
| template<> | |
| bool | isinstance< object > (handle obj) |
| bool | isinstance_generic (handle obj, const std::type_info &tp) |
| iterator | iter (handle obj) |
| size_t | len (handle h) |
| Get the length of a Python object. More... | |
| size_t | len_hint (handle h) |
| const char * | obj_class_name (PyObject *obj) |
| handle | object_or_cast (PyObject *ptr) |
| template<typename T , enable_if_t<!is_pyobject< T >::value, int > = 0> | |
| object | object_or_cast (T &&o) |
| template<typename T , enable_if_t< is_pyobject< T >::value, int > = 0> | |
| auto | object_or_cast (T &&o) -> decltype(std::forward< T >(o)) |
| str | literals::operator""_s (const char *s, size_t size) |
| bool | PyEllipsis_Check (PyObject *o) |
| bool | PyIterable_Check (PyObject *obj) |
| bool | PyNone_Check (PyObject *o) |
| bool | PyStaticMethod_Check (PyObject *o) |
| void | raise_from (error_already_set &err, PyObject *type, const char *message) |
| void | raise_from (PyObject *type, const char *message) |
| template<typename T > | |
| T | reinterpret_borrow (handle h) |
| template<typename T > | |
| T | reinterpret_steal (handle h) |
| str | repr (handle h) |
| void | setattr (handle obj, const char *name, handle value) |
| void | setattr (handle obj, handle name, handle value) |
Macro Definition Documentation
◆ PYBIND11_HANDLE_REF_DEBUG
◆ PYBIND11_INPLACE_OP
| #define PYBIND11_INPLACE_OP | ( | iop | ) | object iop(object_api const &other) { return operator=(handle::iop(other)); } |
◆ PYBIND11_MATH_OPERATOR_BINARY
| #define PYBIND11_MATH_OPERATOR_BINARY | ( | op, | |
| fn | |||
| ) |
Value:
◆ PYBIND11_MATH_OPERATOR_BINARY_INPLACE
| #define PYBIND11_MATH_OPERATOR_BINARY_INPLACE | ( | iop, | |
| fn | |||
| ) |
Value:
◆ PYBIND11_MATH_OPERATOR_UNARY
| #define PYBIND11_MATH_OPERATOR_UNARY | ( | op, | |
| fn | |||
| ) |
Value:
template <typename D> \
object object_api<D>::op() const { \
if (!result.ptr()) \
throw error_already_set(); \
return result; \
}
◆ PYBIND11_OBJECT
| #define PYBIND11_OBJECT | ( | Name, | |
| Parent, | |||
| CheckFun | |||
| ) |
Value:
PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \
/* This is deliberately not 'explicit' to allow implicit conversion from object: */ \
/* NOLINTNEXTLINE(google-explicit-constructor) */ \
Name(const object &o) : Parent(o) { \
if (m_ptr && !check_(m_ptr)) \
throw PYBIND11_OBJECT_CHECK_FAILED(Name, m_ptr); \
} \
/* NOLINTNEXTLINE(google-explicit-constructor) */ \
if (m_ptr && !check_(m_ptr)) \
throw PYBIND11_OBJECT_CHECK_FAILED(Name, m_ptr); \
}
◆ PYBIND11_OBJECT_CHECK_FAILED
| #define PYBIND11_OBJECT_CHECK_FAILED | ( | Name, | |
| o_ptr | |||
| ) |
Value:
::pybind11::type_error("Object of type '" \
+ ::pybind11::detail::get_fully_qualified_tp_name(Py_TYPE(o_ptr)) \
+ "' is not an instance of '" #Name "'")
◆ PYBIND11_OBJECT_COMMON
| #define PYBIND11_OBJECT_COMMON | ( | Name, | |
| Parent, | |||
| CheckFun | |||
| ) |
Value:
public: \
PYBIND11_DEPRECATED("Use reinterpret_borrow<" #Name ">() or reinterpret_steal<" #Name ">()") \
PYBIND11_DEPRECATED("Use py::isinstance<py::python_type>(obj) instead") \
template <typename Policy_> /* NOLINTNEXTLINE(google-explicit-constructor) */ \
◆ PYBIND11_OBJECT_CVT
| #define PYBIND11_OBJECT_CVT | ( | Name, | |
| Parent, | |||
| CheckFun, | |||
| ConvertFun | |||
| ) |
Value:
PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \
/* This is deliberately not 'explicit' to allow implicit conversion from object: */ \
/* NOLINTNEXTLINE(google-explicit-constructor) */ \
Name(const object &o) \
: Parent(check_(o) ? o.inc_ref().ptr() : ConvertFun(o.ptr()), stolen_t{}) { \
if (!m_ptr) \
throw ::pybind11::error_already_set(); \
} \
/* NOLINTNEXTLINE(google-explicit-constructor) */ \
Name(object &&o) : Parent(check_(o) ? o.release().ptr() : ConvertFun(o.ptr()), stolen_t{}) { \
if (!m_ptr) \
throw ::pybind11::error_already_set(); \
}
◆ PYBIND11_OBJECT_CVT_DEFAULT
| #define PYBIND11_OBJECT_CVT_DEFAULT | ( | Name, | |
| Parent, | |||
| CheckFun, | |||
| ConvertFun | |||
| ) |
Value:
PYBIND11_OBJECT_CVT(Name, Parent, CheckFun, ConvertFun) \
Name() = default;
◆ PYBIND11_OBJECT_DEFAULT
| #define PYBIND11_OBJECT_DEFAULT | ( | Name, | |
| Parent, | |||
| CheckFun | |||
| ) |
Value:
PYBIND11_OBJECT(Name, Parent, CheckFun) \
Name() = default;
◆ PYBIND11_STR_CHECK_FUN
Typedef Documentation
◆ dict_iterator
| using dict_iterator = generic_iterator<iterator_policies::dict_readonly> |
◆ is_ds_unpacking
template<typename T >
| using is_ds_unpacking = std::is_same<kwargs_proxy, T> |
◆ is_keyword
template<typename T >
| using is_keyword = std::is_base_of<arg, T> |
◆ is_keyword_or_ds
template<typename T >
| using is_keyword_or_ds = satisfies_any_of<T, is_keyword, is_ds_unpacking> |
◆ is_positional
template<typename T >
| using is_positional = satisfies_none_of<T, is_keyword, is_s_unpacking, is_ds_unpacking> |
◆ is_pyobj_ptr_or_nullptr_t
template<typename T >
| using is_pyobj_ptr_or_nullptr_t = detail::any_of<std::is_same<T, PyObject *>, std::is_same<T, PyObject *const>, std::is_same<T, std::nullptr_t> > |
◆ is_pyobject
template<typename T >
| using is_pyobject = std::is_base_of<pyobject_tag, remove_reference_t<T> > |
◆ is_s_unpacking
template<typename T >
| using is_s_unpacking = std::is_same<args_proxy, T> |
◆ item_accessor
| using item_accessor = accessor<accessor_policies::generic_item> |
◆ list_accessor
| using list_accessor = accessor<accessor_policies::list_item> |
◆ list_iterator
| using list_iterator = generic_iterator<iterator_policies::sequence_fast_readonly> |
◆ obj_attr_accessor
| using obj_attr_accessor = accessor<accessor_policies::obj_attr> |
◆ sequence_accessor
| using sequence_accessor = accessor<accessor_policies::sequence_item> |
◆ sequence_iterator
| using sequence_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite> |
◆ str_attr_accessor
| using str_attr_accessor = accessor<accessor_policies::str_attr> |
◆ tuple_accessor
| using tuple_accessor = accessor<accessor_policies::tuple_item> |
◆ tuple_iterator
| using tuple_iterator = generic_iterator<iterator_policies::sequence_fast_readonly> |
Function Documentation
◆ dict_getitem()
|
inline |
◆ dict_getitemstring()
|
inline |
◆ error_string()
◆ get_function()
◆ isinstance< handle >()
template<>
|
inlinedelete |
◆ isinstance< object >()
template<>
|
inline |
◆ isinstance_generic()
| bool isinstance_generic | ( | handle | obj, |
| const std::type_info & | tp | ||
| ) |
Definition at line 465 of file type_caster_base.h.
◆ obj_class_name()
◆ object_or_cast() [1/3]
◆ object_or_cast() [2/3]
◆ object_or_cast() [3/3]
◆ PyEllipsis_Check()
◆ PyIterable_Check()
◆ PyNone_Check()
◆ PyStaticMethod_Check()
◆ raise_from() [1/2]
|
inline |
Sets the current Python error indicator with the chosen error, performing a 'raise from' from the error contained in error_already_set to indicate that the chosen error was caused by the original error.
◆ raise_from() [2/2]
|
inline |
◆ reinterpret_borrow()
\rst Declare that a handle or PyObject * is a certain type and borrow the reference. The target type T must be object or one of its derived classes. The function doesn't do any conversions or checks. It's up to the user to make sure that the target type is correct.
.. code-block:: cpp
PyObject *p = PyList_GetItem(obj, index); py::object o = reinterpret_borrow<py::object>(p);
or py::tuple t = reinterpret_borrow<py::tuple>(p); // <– p must be already be a tuple \endrst