HepMC3 event record library
Public Member Functions | Data Fields | Protected Attributes | Static Private Member Functions
str Class Reference
+ Inheritance diagram for str:
+ Collaboration diagram for str:

Public Member Functions

 str (const char *c, size_t n)
 
 str (const char *c="")
 
 str (const std::string &s)
 
 str (const bytes &b)
 
 str (handle h)
 
 operator std::string () const
 
template<typename... Args>
str format (Args &&...args) const
 
 PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
 
handle release ()
 
template<typename T >
cast () const &
 
template<typename T >
cast ()&&
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 
const handleinc_ref () const &
 
const handledec_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
 
bool check () const
 

Data Fields

bool is_borrowed: handle(h) { if (is_borrowed) inc_ref()
 

Protected Attributes

PyObject * m_ptr = nullptr
 

Static Private Member Functions

static PyObject * raw_str (PyObject *op)
 Return string representation – always returns a new reference, even if already a str. More...
 

Detailed Description

Definition at line 935 of file pytypes.h.

Constructor & Destructor Documentation

str ( handle  h)
inlineexplicit
\rst
Return a string representation of the object. This is analogous to
the ``str()`` function in Python.

Definition at line 958 of file pytypes.h.

Member Function Documentation

const handle& dec_ref ( ) const
inlineinherited
\rst
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& inc_ref ( ) const
inlineinherited
\rst
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.

operator bool ( ) const
inlineexplicitinherited

Return true when the handle wraps a valid Python object.

Definition at line 207 of file pytypes.h.

bool operator== ( const handle h) const
inlineinherited
\rst
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* ptr ( ) const
inlineinherited

Return the underlying PyObject * pointer.

Definition at line 184 of file pytypes.h.

static PyObject* raw_str ( PyObject *  op)
inlinestaticprivate

Return string representation – always returns a new reference, even if already a str.

Definition at line 981 of file pytypes.h.

handle release ( )
inlineinherited
\rst
Resets the internal pointer to ``nullptr`` without decreasing the
object's reference count. The function returns a raw handle to the original
Python object.

Definition at line 249 of file pytypes.h.

References handle::handle().


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