#include <pytypes.h>

Inheritance diagram for dict:

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

bool Args	dict (Args &&...args)

size_t	size () const

bool	empty () const

detail::dict_iterator	begin () const

detail::dict_iterator	end () const

void	clear () const

template<typename T >
bool	contains (T &&key) 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_dict (PyObject *op)
	Call the `dict` Python type – always returns a new reference. More...

Detailed Description

Definition at line 1211 of file pytypes.h.

Constructor & Destructor Documentation

◆ dict()

bool Args dict ( Args &&... args )

inlineexplicit

Definition at line 1221 of file pytypes.h.

Member Function Documentation

◆ attribute()

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

◆ begin()

detail::dict_iterator begin ( ) const

inline

Definition at line 1225 of file pytypes.h.

◆ clear()

void clear ( ) const

inline

Definition at line 1227 of file pytypes.h.

◆ contains()

bool contains ( T && key ) const

inline

Definition at line 1228 of file pytypes.h.

◆ empty()

bool empty ( ) const

inline

Definition at line 1224 of file pytypes.h.

◆ end()

detail::dict_iterator end ( ) const

inline

Definition at line 1226 of file pytypes.h.

◆ raw_dict()

static PyObject* raw_dict ( PyObject * op )

inlinestaticprivate

Call the dict Python type – always returns a new reference.

Definition at line 1234 of file pytypes.h.

◆ size()

size_t size ( ) const

inline

Definition at line 1223 of file pytypes.h.

Member Data Documentation

◆ borrowed_t

bool borrowed_t

Initial value:

{}) :  object (h, stolen_t{})) { }    dict (handle h, borrowed_t) :  object (h, borrowed_t{}) { }    dict (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)  PyDict_Check (m_ptr); }   static bool check_(handle h) { return h.ptr() != nullptr &&  PyDict_Check (h.ptr()); }       dict (const object &o)   :  object (check_(o) ? o.inc_ref().ptr() :  raw_dict (o.ptr()), stolen_t{})   { if (!m_ptr) throw error_already_set(); }    dict (object &&o)   :  object (check_(o) ? o.release().ptr() :  raw_dict (o.ptr()), stolen_t{})   { if (!m_ptr) throw error_already_set(); }   template <typename Policy_>    dict (const ::pybind11::detail::accessor<Policy_> &a) :  dict (object(a)) { }
    dict() : object(PyDict_New(), stolen_t{}) {
        if (!m_ptr) pybind11_fail("Could not allocate dict object!");
    }
    template <typename... Args,
              typename = detail::enable_if_t<detail::all_of<detail::is_keyword_or_ds<Args>...>::value>,
              
              typename collector = detail::deferred_t<detail::unpacking_collector<>

Definition at line 1213 of file pytypes.h.

◆ is_borrowed

bool is_borrowed

Definition at line 1213 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

Detailed Description

Constructor & Destructor Documentation

◆ dict()

Member Function Documentation

◆ __attribute__()

◆ begin()

◆ clear()

◆ contains()

◆ empty()

◆ end()

◆ raw_dict()

◆ size()

Member Data Documentation

◆ borrowed_t

◆ is_borrowed

◆ attribute()