#include <pytypes.h>

Inheritance diagram for str:

Public Member Functions
	__attribute__ ((deprecated("Use reinterpret_borrow<""str"">() or reinterpret_steal<""str"">()"))) str(handle h

	str (handle h)

	operator std::string () const

template<typename... Args>
str	format (Args &&...args) const

Public Member Functions inherited from object
	object ()=default

	__attribute__ ((deprecated("Use reinterpret_borrow<object>() or reinterpret_steal<object>()"))) object(handle h

	object (const object &o)
	Copy constructor; always increases the reference count. More...

	object (object &&other) noexcept
	Move constructor; steals the object from `other` and preserves its reference count. More...

	~object ()
	Destructor; automatically calls `handle::dec_ref()` More...

handle	release ()

object &	operator= (const object &other)

object &	operator= (object &&other) noexcept

template<typename T >
T	cast () const &

template<typename T >
T	cast () &&

	object (handle h, borrowed_t)

	object (handle h, stolen_t)

template<typename T >
T	cast () const &

template<typename T >
T	cast () &&

template<>
void	cast () const &

template<>
void	cast () &&

Public Member Functions inherited from handle
	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...

Public Attributes
bool	is_borrowed: object (is_borrowed ? object (h

bool	borrowed_t

Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) inc_ref()

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

Member Function Documentation

◆ attribute()

__attribute__ ( (deprecated("Use reinterpret_borrow<""str"">() or reinterpret_steal<""str"">()")) )

◆ format()

str format ( Args &&... args ) const

inline

Definition at line 928 of file pytypes.h.

◆ operator std::string()

operator std::string ( ) const

inline

Definition at line 913 of file pytypes.h.

◆ raw_str()

static PyObject* raw_str ( PyObject * op )

inlinestaticprivate

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

Definition at line 934 of file pytypes.h.

Member Data Documentation

◆ borrowed_t

bool borrowed_t

Initial value:

{}) :  object (h, stolen_t{})) { }    str (handle h, borrowed_t) :  object (h, borrowed_t{}) { }    str (handle h, stolen_t) :  object (h, stolen_t{}) { }   PYBIND11_DEPRECATED("Use py::isinstance<py::python_type>(obj) instead")   bool check() const { return m_ptr != nullptr && (bool)  detail::PyUnicode_Check_Permissive (m_ptr); }   static bool check_(handle h) { return h.ptr() != nullptr &&  detail::PyUnicode_Check_Permissive (h.ptr()); }       str (const object &o)   :  object (check_(o) ? o.inc_ref().ptr() :  raw_str (o.ptr()), stolen_t{})   { if (!m_ptr) throw error_already_set(); }    str (object &&o)   :  object (check_(o) ? o.release().ptr() :  raw_str (o.ptr()), stolen_t{})   { if (!m_ptr) throw error_already_set(); }   template <typename Policy_>    str (const ::pybind11::detail::accessor<Policy_> &a) :  str (object(a)) { }
    str(const char *c, size_t n)
        : object(PyUnicode_FromStringAndSize(c, (ssize_t) n), stolen_t{}) {
        if (!m_ptr) pybind11_fail("Could not allocate string object!");
    }
    
    str(const char *c = "")
        : object(PyUnicode_FromString(c), stolen_t{}) {
        if (!m_ptr) pybind11_fail("Could not allocate string object!");
    }
    str(const std::string &s) : str(s.data(), s.size()) { }
    explicit str(const bytes &b)

Definition at line 890 of file pytypes.h.

◆ is_borrowed

bool is_borrowed

Definition at line 890 of file pytypes.h.

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

pytypes.h

Public Member Functions

Public Attributes

Static Private Member Functions