type Class Reference

#include </builds/ipbus/ipbus-software/uhal/python/pybind11-python2/include/pybind11/pytypes.h>

Inheritance diagram for type:

Collaboration diagram for type:

Static Public Member Functions
static handle	handle_of (handle h)
	Return a type handle from a handle or an object. More...
static type	of (handle h)
	Return a type object from a handle or an object. More...
template<typename T >
static handle	handle_of ()
	Convert C++ type to handle if previously registered. More...
template<typename T >
static type	of ()
	Convert C++ type to type if previously registered. More...
static handle	handle_of (handle h)
	Return a type handle from a handle or an object. More...
static type	of (handle h)
	Return a type object from a handle or an object. More...
template<typename T >
static handle	handle_of ()
	Convert C++ type to handle if previously registered. More...
template<typename T >
static type	of ()
	Convert C++ type to type if previously registered. More...
Static Public Member Functions inherited from handle
static std::size_t	inc_ref_counter ()

Additional Inherited Members
Public Member Functions inherited from object
	object ()=default
	PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
	object (const object &o)
	Copy constructor; always increases the reference count. More...
	object (object &&other) noexcept
	Move constructor; steals the object from other and preserves its reference count. More...
	~object ()
	Destructor; automatically calls handle::dec_ref() More...
handle	release ()
	\rst Resets the internal pointer to nullptr without decreasing the object's reference count. More...
object &	operator= (const object &other)
object &	operator= (object &&other) noexcept
template<typename T >
T	cast () const &
template<typename T >
T	cast () &&
	object (handle h, borrowed_t)
	object (handle h, stolen_t)
	object ()=default
	PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
	object (const object &o)
	Copy constructor; always increases the reference count. More...
	object (object &&other) noexcept
	Move constructor; steals the object from other and preserves its reference count. More...
	~object ()
	Destructor; automatically calls handle::dec_ref() More...
handle	release ()
	\rst Resets the internal pointer to nullptr without decreasing the object's reference count. More...
object &	operator= (const object &other)
object &	operator= (object &&other) noexcept
template<typename T >
T	cast () const &
template<typename T >
T	cast () &&
	object (handle h, borrowed_t)
	object (handle h, stolen_t)
template<typename T >
T	cast () const &
template<typename T >
T	cast () &&
template<>
void	cast () const &
template<>
void	cast () &&
Public Member Functions inherited from handle
	handle ()=default
	The default constructor creates a handle with a nullptr-valued pointer. More...
	handle (PyObject *ptr)
	Creates a handle from the given raw Python object pointer. More...
PyObject *	ptr () const
	Return the underlying PyObject * pointer. More...
PyObject *&	ptr ()
const handle &	inc_ref () const &
	\rst Manually increase the reference count of the Python object. More...
const handle &	dec_ref () const &
	\rst Manually decrease the reference count of the Python object. More...
template<typename T >
T	cast () const
	\rst Attempt to cast the Python object into the given C++ type. More...
	operator bool () const
	Return true when the handle wraps a valid Python object. More...
bool	operator== (const handle &h) const
	\rst Deprecated: Check that the underlying pointers are the same. More...
bool	operator!= (const handle &h) const
bool	check () const
	handle ()=default
	The default constructor creates a handle with a nullptr-valued pointer. More...
template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
	handle (T ptr)
	Enable implicit conversion from PyObject * and nullptr. More...
template<typename T , detail::enable_if_t< detail::all_of< detail::none_of< std::is_base_of< handle, T >, detail::is_pyobj_ptr_or_nullptr_t< T > >, std::is_convertible< T, PyObject * > >::value, int > = 0>
	handle (T &obj)
	Enable implicit conversion through T::operator PyObject *(). More...
PyObject *	ptr () const
	Return the underlying PyObject * pointer. More...
PyObject *&	ptr ()
const handle &	inc_ref () const &
	\rst Manually increase the reference count of the Python object. More...
const handle &	dec_ref () const &
	\rst Manually decrease the reference count of the Python object. More...
template<typename T >
T	cast () const
	\rst Attempt to cast the Python object into the given C++ type. More...
	operator bool () const
	Return true when the handle wraps a valid Python object. More...
bool	operator== (const handle &h) const
	\rst Deprecated: Check that the underlying pointers are the same. More...
bool	operator!= (const handle &h) const
bool	check () const
template<>
void	cast () const
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) { inc_ref()
Protected Attributes inherited from handle
PyObject *	m_ptr = nullptr

Detailed Description

Definition at line 1167 of file pytypes.h.

Member Function Documentation

handle_of() [1/4]

template<typename T >

handle type::handle_of

static

Convert C++ type to handle if previously registered.

Does not convert standard types, like int, float. etc. yet. See https://github.com/pybind/pybind11/issues/2486

Definition at line 1643 of file cast.h.

Referenced by object_api< Derived >::get_type(), get_type_override(), enum_base::init(), type_caster< void >::load(), type_caster< Type, enable_if_t< is_eigen_sparse< Type >::value > >::load(), load_type(), move(), of(), and type_caster_generic::try_load_foreign_module_local().

handle_of() [2/4]

template<typename T >

static handle type::handle_of ( )

static

Convert C++ type to handle if previously registered.

Does not convert standard types, like int, float. etc. yet. See https://github.com/pybind/pybind11/issues/2486

handle_of() [3/4]

static handle type::handle_of ( handle  h )

inlinestatic

Return a type handle from a handle or an object.

Definition at line 1172 of file pytypes.h.

handle_of() [4/4]

static handle type::handle_of ( handle  h )

inlinestatic

Return a type handle from a handle or an object.

Definition at line 1437 of file pytypes.h.

of() [1/4]

template<typename T >

static type type::of ( )

inlinestatic

Convert C++ type to type if previously registered.

Does not convert standard types, like int, float. etc. yet. See https://github.com/pybind/pybind11/issues/2486

Definition at line 1188 of file pytypes.h.

of() [2/4]

template<typename T >

static type type::of ( )

inlinestatic

Convert C++ type to type if previously registered.

Does not convert standard types, like int, float. etc. yet. See https://github.com/pybind/pybind11/issues/2486

Definition at line 1453 of file pytypes.h.

of() [3/4]

static type type::of ( handle  h )

inlinestatic

Return a type object from a handle or an object.

Definition at line 1175 of file pytypes.h.

References handle_of().

of() [4/4]

static type type::of ( handle  h )

inlinestatic

Return a type object from a handle or an object.

Definition at line 1440 of file pytypes.h.

References handle_of().

---

The documentation for this class was generated from the following files:

• python/pybind11-python2/include/pybind11/pytypes.h
• python/pybind11/include/pybind11/pytypes.h
• python/pybind11-python2/include/pybind11/cast.h
• python/pybind11/include/pybind11/cast.h