dict Class Reference

#include <pytypes.h>

Inheritance diagram for dict:

Public Member Functions
detail::dict_iterator	begin () const
void	clear ()
template<typename T >
bool	contains (T &&key) const
	dict ()
template<typename... Args, typename = detail::enable_if_t<args_are_all_keyword_or_ds<Args...>()>, typename collector = detail::deferred_t<detail::unpacking_collector<>, Args...>>
	dict (Args &&...args)
bool	empty () const
detail::dict_iterator	end () const
size_t	size () const
Public Member Functions inherited from object
template<typename T >
T	cast () &&
template<typename T >
T	cast () const &
template<>
void	cast () const &
	object ()=default
	object (const object &o)
	Copy constructor; always increases the reference count. More...
	object (handle h, borrowed_t)
	object (handle h, stolen_t)
	object (object &&other) noexcept
	Move constructor; steals the object from other and preserves its reference count. More...
object &	operator= (const object &other)
object &	operator= (object &&other) noexcept
	PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
handle	release ()
	~object ()
	Destructor; automatically calls handle::dec_ref() More...
Public Member Functions inherited from handle
template<typename T >
T	cast () const
template<>
void	cast () const
bool	check () const
const handle &	dec_ref () const &
	handle ()=default
	The default constructor creates a handle with a nullptr-valued pointer. More...
template<typename T , detail::enable_if_t< detail::all_of< detail::none_of< std::is_base_of< handle, T >, detail::is_pyobj_ptr_or_nullptr_t< T >>, std::is_convertible< T, PyObject * >>::value, int > = 0>
	handle (T &obj)
	Enable implicit conversion through T::operator PyObject *(). More...
template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
	handle (T ptr)
const handle &	inc_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
PyObject *&	ptr ()
PyObject *	ptr () const
	Return the underlying PyObject * pointer. More...

Static Private Member Functions
static PyObject *	raw_dict (PyObject *op)
	Call the dict Python type – always returns a new reference. More...

Additional Inherited Members
Static Public Member Functions inherited from handle
static std::size_t	inc_ref_counter ()
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) { inc_ref()
Protected Attributes inherited from handle
PyObject *	m_ptr = nullptr

Detailed Description

Definition at line 2107 of file pytypes.h.

Constructor & Destructor Documentation

dict() [1/2]

dict::dict ( )

inline

Definition at line 2110 of file pytypes.h.

dict() [2/2]

template<typename... Args, typename = detail::enable_if_t<args_are_all_keyword_or_ds<Args...>()>, typename collector = detail::deferred_t<detail::unpacking_collector<>, Args...>>

dict::dict ( Args &&...  args )

inlineexplicit

Definition at line 2120 of file pytypes.h.

Member Function Documentation

begin()

detail::dict_iterator dict::begin ( ) const

inline

Definition at line 2124 of file pytypes.h.

clear()

void dict::clear ( )

inline

Definition at line 2126 of file pytypes.h.

contains()

template<typename T >

bool dict::contains ( T &&  key ) const

inline

Definition at line 2128 of file pytypes.h.

empty()

bool dict::empty ( ) const

inline

Definition at line 2123 of file pytypes.h.

end()

detail::dict_iterator dict::end ( ) const

inline

Definition at line 2125 of file pytypes.h.

raw_dict()

static PyObject* dict::raw_dict ( PyObject *  op )

inlinestaticprivate

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

Definition at line 2138 of file pytypes.h.

size()

size_t dict::size ( ) const

inline

Definition at line 2122 of file pytypes.h.

---

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

• pytypes.h