handle Class Reference

#include <pytypes.h>

Inheritance diagram for handle:

Public Member Functions
template<typename T >
T	cast () const
template<>
void	cast () const
bool	check () const
const handle &	dec_ref () const &
	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...
const handle &	inc_ref () const &
	operator bool () const
	Return true when the handle wraps a valid Python object. More...
bool	operator!= (const handle &h) const
bool	operator== (const handle &h) const
PyObject *	ptr () const
	Return the underlying PyObject * pointer. More...
PyObject *&	ptr ()

Protected Attributes
PyObject *	m_ptr = nullptr

Detailed Description

Holds a reference to a Python object (no reference counting)

The handle class is a thin wrapper around an arbitrary Python object (i.e. a PyObject * in Python's C API). It does not perform any automatic reference counting and merely provides a basic C++ interface to various Python API functions.

.. seealso:: The object class inherits from handle and adds automatic reference counting features.

Definition at line 176 of file pytypes.h.

Constructor & Destructor Documentation

handle::handle ( )

default

The default constructor creates a handle with a nullptr-valued pointer.

handle::handle ( PyObject *  ptr )

inline

Creates a handle from the given raw Python object pointer.

Definition at line 181 of file pytypes.h.

Member Function Documentation

template<typename T >

T handle::cast

(

)

const

Attempt to cast the Python object into the given C++ type. A cast_error will be throw upon failure.

Definition at line 1752 of file cast.h.

template<>

void handle::cast ( ) const

inline

Definition at line 1753 of file cast.h.

bool handle::check ( ) const

inline

Definition at line 217 of file pytypes.h.

const handle& handle::dec_ref ( ) const

inline

Manually decrease the reference count of the Python object. Usually, it is preferable to use the object class which derives from handle and calls this function automatically. Returns a reference to itself.

Definition at line 199 of file pytypes.h.

const handle& handle::inc_ref ( ) const

inline

Manually increase the reference count of the Python object. Usually, it is preferable to use the object class which derives from handle and calls this function automatically. Returns a reference to itself.

Definition at line 192 of file pytypes.h.

handle::operator bool ( ) const

inlineexplicit

Return true when the handle wraps a valid Python object.

Definition at line 207 of file pytypes.h.

bool handle::operator!= ( const handle &  h ) const

inline

Definition at line 215 of file pytypes.h.

bool handle::operator== ( const handle &  h ) const

inline

Deprecated: Check that the underlying pointers are the same. Equivalent to obj1 is obj2 in Python.

Definition at line 213 of file pytypes.h.

PyObject* handle::ptr ( ) const

inline

Return the underlying PyObject * pointer.

Definition at line 184 of file pytypes.h.

PyObject*& handle::ptr ( )

inline

Definition at line 185 of file pytypes.h.

Member Data Documentation

PyObject* handle::m_ptr = nullptr

protected

Definition at line 219 of file pytypes.h.

---

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

• pytypes.h
• cast.h