HepMC3 event record library
Public Member Functions | Private Member Functions
object_api< Derived > Class Template Reference

#include <pytypes.h>

+ Inheritance diagram for object_api< Derived >:
+ Collaboration diagram for object_api< Derived >:

Public Member Functions

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
 
template<typename T >
bool contains (T &&item) const
 Check if the given item is contained within this object, i.e. item in obj. More...
 
template<return_value_policy policy = return_value_policy::automatic_reference, typename... Args>
object operator() (Args &&...args) const
 
template<return_value_policy policy = return_value_policy::automatic_reference, typename... Args>
 PYBIND11_DEPRECATED ("call(...) was deprecated in favor of operator()(...)") object call(Args &&...args) const
 
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~ () 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
 
object operator>> (object_api const &other) const
 
object operator>>= (object_api const &other) const
 
pybind11::str str () const
 
str_attr_accessor doc () const
 Get or set the object's docstring, i.e. obj.__doc__. More...
 
int ref_count () const
 Return the object's current reference count. More...
 
handle get_type () const
 

Private Member Functions

const Derived & derived () const
 
bool rich_compare (object_api const &other, int value) const
 

Detailed Description

template<typename Derived>
class object_api< Derived >

\rst
A mixin class which adds common functions to `handle`, `object` and various accessors.
The only requirement for `Derived` is to implement ``PyObject *Derived::ptr() const``.

Definition at line 55 of file pytypes.h.

Member Function Documentation

obj_attr_accessor attr ( handle  key) const
\rst
Return an internal functor to access the object's attributes. Casting the
returned ``detail::obj_attr_accessor`` instance to a `handle` or `object`
subclass causes a corresponding call to ``getattr``. Assigning a `handle`
or `object` subclass causes a call to ``setattr``.

Definition at line 1586 of file pytypes.h.

str_attr_accessor attr ( const char *  key) const

See above (the only difference is that they key is provided as a string literal)

Definition at line 1589 of file pytypes.h.

iterator begin ( ) const
\rst
Return an iterator equivalent to calling ``iter()`` in Python. The object
must be a collection which supports the iteration protocol.

Definition at line 1578 of file pytypes.h.

bool contains ( T &&  item) const

Check if the given item is contained within this object, i.e. item in obj.

Definition at line 1595 of file pytypes.h.

Get or set the object's docstring, i.e. obj.__doc__.

Definition at line 1603 of file pytypes.h.

iterator end ( ) const

Return a sentinel which ends iteration.

Definition at line 1579 of file pytypes.h.

References iterator::sentinel().

bool equal ( object_api< Derived > const &  other) const
inline

Equivalent to obj == other in Python.

Definition at line 119 of file pytypes.h.

bool is ( object_api< Derived > const &  other) const
inline

Equivalent to obj is other in Python.

Definition at line 115 of file pytypes.h.

bool is_none ( ) const
inline

Equivalent to obj is None in Python.

Definition at line 117 of file pytypes.h.

object operator() ( Args &&...  args) const
\rst
Assuming the Python object is a function or implements the ``__call__``
protocol, ``operator()`` invokes the underlying function, passing an
arbitrary set of parameters. The result is returned as a `object` and
may need to be converted back into a Python object using `handle::cast()`.

When some of the arguments cannot be converted to Python objects, the
function will throw a `cast_error` exception. When the Python function
call fails, a `error_already_set` exception is thrown.
args_proxy operator* ( ) const
\rst
Matches * unpacking in Python, e.g. to unpack arguments out of a ``tuple``
or ``list`` for a function call. Applying another * to the result yields
   unpacking, e.g. to unpack a dict as function keyword arguments.
See :ref:`calling_python_functions`.

Definition at line 1592 of file pytypes.h.

item_accessor operator[] ( handle  key) const
\rst
Return an internal functor to invoke the object's sequence protocol. Casting
the returned ``detail::item_accessor`` instance to a `handle` or `object`
subclass causes a corresponding call to ``__getitem__``. Assigning a `handle`
or `object` subclass causes a call to ``__setitem__``.

Definition at line 1580 of file pytypes.h.

item_accessor operator[] ( const char *  key) const

See above (the only difference is that they key is provided as a string literal)

Definition at line 1583 of file pytypes.h.

int ref_count ( ) const
inline

Return the object's current reference count.

Definition at line 154 of file pytypes.h.


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