#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 >
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.
Member Function Documentation
◆ attr() [1/2]
| obj_attr_accessor attr | ( | handle | key | ) | const |
◆ attr() [2/2]
| str_attr_accessor attr | ( | const char * | key | ) | const |
◆ begin()
| iterator begin | ( | ) | const |
◆ contains()
| bool contains | ( | T && | item | ) | const |
◆ doc()
| str_attr_accessor doc | ( | ) | const |
◆ end()
| iterator end | ( | ) | const |
◆ equal()
|
inline |
◆ is()
|
inline |
◆ is_none()
|
inline |
◆ operator()()
| object operator() | ( | Args &&... | args | ) | const |
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.
◆ operator*()
| args_proxy operator* | ( | ) | const |
◆ operator[]() [1/2]
| item_accessor operator[] | ( | handle | key | ) | const |
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__.
◆ operator[]() [2/2]
| item_accessor operator[] | ( | const char * | key | ) | const |
◆ ref_count()
|
inline |
The documentation for this class was generated from the following files:
