pytypes.h File Reference

#include "detail/common.h"
#include "buffer_info.h"
#include <utility>
#include <type_traits>

Go to the source code of this file.

Classes
class	pyobject_tag
	Tag and check to identify a class which implements the Python object API. More...
class	object_api< Derived >
class	handle
class	object
struct	object::borrowed_t
struct	object::stolen_t
class	error_already_set
class	accessor< Policy >
struct	obj_attr
struct	str_attr
struct	generic_item
struct	sequence_item
struct	list_item
struct	tuple_item
class	generic_iterator< Policy >
	STL iterator template used for tuple, list, sequence and dict. More...
struct	arrow_proxy< T >
	Quick proxy class needed to implement operator-> for iterators which can't return pointers. More...
class	sequence_fast_readonly
	Lightweight iterator policy using just a simple pointer: see PySequence_Fast_ITEMS More...
class	sequence_slow_readwrite
	Full read and write access using the sequence protocol: see detail::sequence_accessor More...
class	dict_readonly
	Python's dictionary protocol permits this to be a forward iterator. More...
class	kwargs_proxy
class	args_proxy
class	iterator
class	type
class	iterable
class	str
class	bytes
class	none
class	ellipsis
class	bool_
class	int_
class	float_
class	weakref
class	slice
class	capsule
class	tuple
class	dict
class	sequence
class	list
class	args
class	kwargs
class	set
class	function
class	staticmethod
class	buffer
class	memoryview

Namespaces
	accessor_policies
	literals

Macros
#define	PYBIND11_STR_CHECK_FUN   PyUnicode_Check
#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_CHECK_FAILED(Name, o_ptr)
#define	PYBIND11_OBJECT(Name, Parent, CheckFun)
#define	PYBIND11_OBJECT_DEFAULT(Name, Parent, CheckFun)
#define	PYBIND11_MATH_OPERATOR_UNARY(op, fn)
#define	PYBIND11_MATH_OPERATOR_BINARY(op, fn)

Typedefs
using	obj_attr_accessor = accessor< accessor_policies::obj_attr >
using	str_attr_accessor = accessor< accessor_policies::str_attr >
using	item_accessor = accessor< accessor_policies::generic_item >
using	sequence_accessor = accessor< accessor_policies::sequence_item >
using	list_accessor = accessor< accessor_policies::list_item >
using	tuple_accessor = accessor< accessor_policies::tuple_item >
template<typename T >
using	is_pyobject = std::is_base_of< pyobject_tag, remove_reference_t< T > >
using	tuple_iterator = generic_iterator< iterator_policies::sequence_fast_readonly >
using	list_iterator = generic_iterator< iterator_policies::sequence_fast_readonly >
using	sequence_iterator = generic_iterator< iterator_policies::sequence_slow_readwrite >
using	dict_iterator = generic_iterator< iterator_policies::dict_readonly >
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_s_unpacking = std::is_same< args_proxy, T >
template<typename T >
using	is_ds_unpacking = std::is_same< kwargs_proxy, T >
template<typename T >
using	is_positional = satisfies_none_of< T, is_keyword, is_s_unpacking, is_ds_unpacking >
template<typename T >
using	is_keyword_or_ds = satisfies_any_of< T, is_keyword, is_ds_unpacking >

Functions
bool	isinstance_generic (handle obj, const std::type_info &tp)
template<typename T >
T	reinterpret_borrow (handle h)
template<typename T >
T	reinterpret_steal (handle h)
std::string	error_string ()
template<typename T , detail::enable_if_t< std::is_base_of< object, T >::value, int > = 0>
bool	isinstance (handle obj)
template<>
bool	isinstance< handle > (handle)=delete
template<>
bool	isinstance< object > (handle obj)
bool	isinstance (handle obj, handle type)
bool	hasattr (handle obj, handle name)
bool	hasattr (handle obj, const char *name)
void	delattr (handle obj, handle name)
void	delattr (handle obj, const char *name)
object	getattr (handle obj, handle name)
object	getattr (handle obj, const char *name)
object	getattr (handle obj, handle name, handle default_)
object	getattr (handle obj, const char *name, handle default_)
void	setattr (handle obj, handle name, handle value)
void	setattr (handle obj, const char *name, handle value)
ssize_t	hash (handle obj)
handle	get_function (handle value)
template<typename T , enable_if_t< is_pyobject< T >::value, int > = 0>
auto	object_or_cast (T &&o) -> decltype(std::forward< T >(o))
template<typename T , enable_if_t<!is_pyobject< T >::value, int > = 0>
object	object_or_cast (T &&o)
handle	object_or_cast (PyObject *ptr)
bool	PyIterable_Check (PyObject *obj)
bool	PyNone_Check (PyObject *o)
bool	PyEllipsis_Check (PyObject *o)
bool	PyStaticMethod_Check (PyObject *o)
str	literals::operator""_s (const char *s, size_t size)
template<typename Unsigned >
Unsigned	as_unsigned (PyObject *o)
template<typename... Args>
constexpr bool	args_are_all_keyword_or_ds ()
size_t	len (handle h)
	Get the length of a Python object. More...
size_t	len_hint (handle h)
str	repr (handle h)
iterator	iter (handle obj)

Macro Definition Documentation

PYBIND11_MATH_OPERATOR_BINARY

#define PYBIND11_MATH_OPERATOR_BINARY	(		op,
			fn
	)

Value:

    template <typename D>                                                      \
    object object_api<D>::op(object_api const &other) const {                  \
        object result = reinterpret_steal<object>(                             \
            fn(derived().ptr(), other.derived().ptr()));                       \
        if (!result.ptr())                                                     \
            throw error_already_set();                                         \
        return result;                                                         \
    }

Definition at line 1650 of file pytypes.h.

PYBIND11_MATH_OPERATOR_UNARY

#define PYBIND11_MATH_OPERATOR_UNARY	(		op,
			fn
	)

Value:

    template <typename D> object object_api<D>::op() const {                   \
        object result = reinterpret_steal<object>(fn(derived().ptr()));        \
        if (!result.ptr())                                                     \
            throw error_already_set();                                         \
        return result;                                                         \
    }

Definition at line 1642 of file pytypes.h.

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: */ \
    Name(const object &o) : Parent(o) \
    { if (m_ptr && !check_(m_ptr)) throw PYBIND11_OBJECT_CHECK_FAILED(Name, m_ptr); } \
    Name(object &&o) : Parent(std::move(o)) \
    { if (m_ptr && !check_(m_ptr)) throw PYBIND11_OBJECT_CHECK_FAILED(Name, m_ptr); }

Definition at line 832 of file pytypes.h.

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 "'")

Definition at line 827 of file pytypes.h.

PYBIND11_OBJECT_COMMON

#define PYBIND11_OBJECT_COMMON	(		Name,
			Parent,
			CheckFun
	)

Value:

    public: \
        PYBIND11_DEPRECATED("Use reinterpret_borrow<"#Name">() or reinterpret_steal<"#Name">()") \
        Name(handle h, bool is_borrowed) : Parent(is_borrowed ? Parent(h, borrowed_t{}) : Parent(h, stolen_t{})) { } \
        Name(handle h, borrowed_t) : Parent(h, borrowed_t{}) { } \
        Name(handle h, stolen_t) : Parent(h, stolen_t{}) { } \
        PYBIND11_DEPRECATED("Use py::isinstance<py::python_type>(obj) instead") \
        bool check() const { return m_ptr != nullptr && (bool) CheckFun(m_ptr); } \
        static bool check_(handle h) { return h.ptr() != nullptr && CheckFun(h.ptr()); } \
        template <typename Policy_> \
        Name(const ::pybind11::detail::accessor<Policy_> &a) : Name(object(a)) { }

Definition at line 801 of file pytypes.h.

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: */ \
    Name(const object &o) \
    : Parent(check_(o) ? o.inc_ref().ptr() : ConvertFun(o.ptr()), stolen_t{}) \
    { if (!m_ptr) throw error_already_set(); } \
    Name(object &&o) \
    : Parent(check_(o) ? o.release().ptr() : ConvertFun(o.ptr()), stolen_t{}) \
    { if (!m_ptr) throw error_already_set(); }

Definition at line 813 of file pytypes.h.

PYBIND11_OBJECT_CVT_DEFAULT

#define PYBIND11_OBJECT_CVT_DEFAULT	(		Name,
			Parent,
			CheckFun,
			ConvertFun
	)

Value:

    PYBIND11_OBJECT_CVT(Name, Parent, CheckFun, ConvertFun) \
    Name() : Parent() { }

Definition at line 823 of file pytypes.h.

PYBIND11_OBJECT_DEFAULT

#define PYBIND11_OBJECT_DEFAULT	(		Name,
			Parent,
			CheckFun
	)

Value:

    PYBIND11_OBJECT(Name, Parent, CheckFun) \
    Name() : Parent() { }

Definition at line 840 of file pytypes.h.

PYBIND11_STR_CHECK_FUN

#define PYBIND11_STR_CHECK_FUN   PyUnicode_Check

Definition at line 764 of file pytypes.h.

Typedef Documentation

dict_iterator

using dict_iterator = generic_iterator<iterator_policies::dict_readonly>

Definition at line 743 of file pytypes.h.

is_ds_unpacking

template<typename T >

using is_ds_unpacking = std::is_same<kwargs_proxy, T>

Definition at line 782 of file pytypes.h.

is_keyword

template<typename T >

using is_keyword = std::is_base_of<arg, T>

Python argument categories (using PEP 448 terms)

Definition at line 780 of file pytypes.h.

is_keyword_or_ds

template<typename T >

using is_keyword_or_ds = satisfies_any_of<T, is_keyword, is_ds_unpacking>

Definition at line 786 of file pytypes.h.

is_positional

template<typename T >

using is_positional = satisfies_none_of<T, is_keyword, is_s_unpacking, is_ds_unpacking >

Definition at line 783 of file pytypes.h.

is_pyobject

template<typename T >

using is_pyobject = std::is_base_of<pyobject_tag, remove_reference_t<T> >

Definition at line 48 of file pytypes.h.

is_s_unpacking

template<typename T >

using is_s_unpacking = std::is_same<args_proxy, T>

Definition at line 781 of file pytypes.h.

item_accessor

using item_accessor = accessor<accessor_policies::generic_item>

Definition at line 41 of file pytypes.h.

list_accessor

using list_accessor = accessor<accessor_policies::list_item>

Definition at line 43 of file pytypes.h.

list_iterator

using list_iterator = generic_iterator<iterator_policies::sequence_fast_readonly>

Definition at line 736 of file pytypes.h.

obj_attr_accessor

using obj_attr_accessor = accessor<accessor_policies::obj_attr>

Definition at line 39 of file pytypes.h.

sequence_accessor

using sequence_accessor = accessor<accessor_policies::sequence_item>

Definition at line 42 of file pytypes.h.

sequence_iterator

using sequence_iterator = generic_iterator<iterator_policies::sequence_slow_readwrite>

Definition at line 742 of file pytypes.h.

str_attr_accessor

using str_attr_accessor = accessor<accessor_policies::str_attr>

Definition at line 40 of file pytypes.h.

tuple_accessor

using tuple_accessor = accessor<accessor_policies::tuple_item>

Definition at line 44 of file pytypes.h.

tuple_iterator

using tuple_iterator = generic_iterator<iterator_policies::sequence_fast_readonly>

Definition at line 735 of file pytypes.h.

Function Documentation

error_string()

std::string error_string ( )

inline

Definition at line 423 of file cast.h.

get_function()

handle get_function ( handle  value )

inline

Definition at line 468 of file pytypes.h.

isinstance< handle >()

template<>

bool isinstance< handle > ( handle  )

inlinedelete

isinstance< object >()

template<>

bool isinstance< object > ( handle  obj )

inline

Definition at line 392 of file pytypes.h.

isinstance_generic()

bool isinstance_generic ( handle  obj, const std::type_info &  tp  )

inline

Definition at line 416 of file cast.h.

object_or_cast() [1/3]

handle object_or_cast ( PyObject *  ptr )

inline

Definition at line 490 of file pytypes.h.

object_or_cast() [2/3]

template<typename T , enable_if_t<!is_pyobject< T >::value, int > = 0>

object object_or_cast

(

T &&

o

)

Definition at line 1840 of file cast.h.

object_or_cast() [3/3]

template<typename T , enable_if_t< is_pyobject< T >::value, int > = 0>

auto object_or_cast

(

T &&

o

)

-> decltype(std::forward<T>(o))

Definition at line 485 of file pytypes.h.

PyEllipsis_Check()

bool PyEllipsis_Check ( PyObject *  o )

inline

Definition at line 757 of file pytypes.h.

PyIterable_Check()

bool PyIterable_Check ( PyObject *  obj )

inline

Definition at line 745 of file pytypes.h.

PyNone_Check()

bool PyNone_Check ( PyObject *  o )

inline

Definition at line 756 of file pytypes.h.

PyStaticMethod_Check()

bool PyStaticMethod_Check ( PyObject *  o )

inline

Definition at line 766 of file pytypes.h.

reinterpret_borrow()

template<typename T >

T reinterpret_borrow

(

handle

h

)

\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

Definition at line 306 of file pytypes.h.

reinterpret_steal()

template<typename T >

T reinterpret_steal

(

handle

h

)

\rst Like reinterpret_borrow, but steals the reference.

.. code-block:: cpp

PyObject *p = PyObject_Str(obj); py::str s = reinterpret_steal<py::str>(p); // <– p must be already be a str \endrst

Definition at line 316 of file pytypes.h.