handle Class Reference

#include <pytypes.h>

Inheritance diagram for handle:

Public Member Functions
	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 &
const handle &	dec_ref () const &
template<typename T >
T	cast () const
	operator bool () const
	Return true when the handle wraps a valid Python object. More...
	__attribute__ ((deprecated("Use obj1.is(obj2) instead"))) bool operator
template<>
void	cast () const
Public Member Functions inherited from object_api< handle >
iterator	begin () const
iterator	end () const
	Return a sentinel which ends iteration. More...
item_accessor	operator[] (handle key) const
item_accessor	operator[] (const char *key) const
	See above (the only difference is that they key is provided as a string literal) More...
obj_attr_accessor	attr (handle key) const
str_attr_accessor	attr (const char *key) const
	See above (the only difference is that they key is provided as a string literal) More...
args_proxy	operator* () const
object	operator* (object_api const &other) const
bool	contains (T &&item) const
	Check if the given item is contained within this object, i.e. item in obj. More...
object	operator() (Args &&...args) const
	__attribute__ ((deprecated("call(...) was deprecated in favor of operator()(...)"))) object call(Args &&... args) const
	Get or set the object's docstring, i.e. obj.__doc__. More...
bool	is (object_api const &other) const
	Equivalent to obj is other in Python. More...
bool	is_none () const
	Equivalent to obj is None in Python. More...
bool	equal (object_api const &other) const
	Equivalent to obj == other in Python. More...
bool	not_equal (object_api const &other) const
bool	operator< (object_api const &other) const
bool	operator<= (object_api const &other) const
bool	operator> (object_api const &other) const
bool	operator>= (object_api const &other) const
object	operator- () const
object	operator- (object_api const &other) const
object	operator~ () const
object	operator+ (object_api const &other) const
object	operator+= (object_api const &other) const
object	operator-= (object_api const &other) const
object	operator*= (object_api const &other) const
object	operator/ (object_api const &other) const
object	operator/= (object_api const &other) const
object	operator| (object_api const &other) const
object	operator|= (object_api const &other) const
object	operator& (object_api const &other) const
object	operator&= (object_api const &other) const
object	operator^ (object_api const &other) const
object	operator^= (object_api const &other) const
object	operator<< (object_api const &other) const
object	operator<<= (object_api const &other) const
object	operator>> (object_api const &other) const
object	operator>>= (object_api const &other) const
int	ref_count () const
	Return the object's current reference count. More...
handle	get_type () const
	Return a handle to the Python type object underlying the instance. More...

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 174 of file pytypes.h.

Constructor & Destructor Documentation

handle() [1/2]

handle ( )

default

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

handle() [2/2]

handle ( PyObject *  ptr )

inline

Creates a handle from the given raw Python object pointer.

Definition at line 179 of file pytypes.h.

Member Function Documentation

__attribute__()

__attribute__

(

(deprecated("Use obj1.is(obj2) instead"))

)

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

cast() [1/2]

T cast

(

)

const

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

Definition at line 1681 of file cast.h.

cast() [2/2]

void cast ( ) const

inline

Definition at line 1682 of file cast.h.

dec_ref()

const 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 197 of file pytypes.h.

inc_ref()

const 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 190 of file pytypes.h.

operator bool()

operator bool ( ) const

inlineexplicit

Return true when the handle wraps a valid Python object.

Definition at line 205 of file pytypes.h.

ptr() [1/2]

PyObject* ptr ( ) const

inline

Return the underlying PyObject * pointer.

Definition at line 182 of file pytypes.h.

ptr() [2/2]

PyObject*& ptr ( )

inline

Definition at line 183 of file pytypes.h.

---

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

• pytypes.h
• cast.h