μHAL (v2.8.17)
Part of the IPbus software repository
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Private Member Functions | List of all members
dict Class Reference

#include </builds/ipbus/ipbus-software/uhal/python/pybind11-python2/include/pybind11/pytypes.h>

Inheritance diagram for dict:
[legend]
Collaboration diagram for dict:
[legend]

Public Member Functions

 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)
 
size_t size () const
 
bool empty () const
 
detail::dict_iterator begin () const
 
detail::dict_iterator end () 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)
 
size_t size () const
 
bool empty () const
 
detail::dict_iterator begin () const
 
detail::dict_iterator end () const
 
void clear ()
 
template<typename T >
bool contains (T &&key) const
 
- Public Member Functions inherited from object
 object ()=default
 
 PYBIND11_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 ()
 \rst Resets the internal pointer to nullptr without decreasing the object's reference count. More...
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
template<typename T >
cast () const &
 
template<typename T >
cast () &&
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
 object ()=default
 
 PYBIND11_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 ()
 \rst Resets the internal pointer to nullptr without decreasing the object's reference count. More...
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
template<typename T >
cast () const &
 
template<typename T >
cast () &&
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
template<typename T >
cast () const &
 
template<typename 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 handleinc_ref () const &
 \rst Manually increase the reference count of the Python object. More...
 
const handledec_ref () const &
 \rst Manually decrease the reference count of the Python object. More...
 
template<typename T >
cast () const
 \rst Attempt to cast the Python object into the given C++ type. More...
 
 operator bool () const
 Return true when the handle wraps a valid Python object. More...
 
bool operator== (const handle &h) const
 \rst Deprecated: Check that the underlying pointers are the same. More...
 
bool operator!= (const handle &h) const
 
bool check () const
 
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer. More...
 
template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
 handle (T ptr)
 Enable implicit conversion from PyObject * and nullptr. 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...
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 
const handleinc_ref () const &
 \rst Manually increase the reference count of the Python object. More...
 
const handledec_ref () const &
 \rst Manually decrease the reference count of the Python object. More...
 
template<typename T >
cast () const
 \rst Attempt to cast the Python object into the given C++ type. More...
 
 operator bool () const
 Return true when the handle wraps a valid Python object. More...
 
bool operator== (const handle &h) const
 \rst Deprecated: Check that the underlying pointers are the same. More...
 
bool operator!= (const handle &h) const
 
bool check () const
 
template<>
void cast () const
 

Static Private Member Functions

static PyObject * raw_dict (PyObject *op)
 Call the dict Python type – always returns a new reference. More...
 
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 1694 of file pytypes.h.

Constructor & Destructor Documentation

◆ dict() [1/4]

dict::dict ( )
inline

Definition at line 1697 of file pytypes.h.

◆ dict() [2/4]

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

◆ dict() [3/4]

dict::dict ( )
inline

Definition at line 1998 of file pytypes.h.

◆ dict() [4/4]

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

Member Function Documentation

◆ begin() [1/2]

detail::dict_iterator dict::begin ( ) const
inline

Definition at line 1711 of file pytypes.h.

◆ begin() [2/2]

detail::dict_iterator dict::begin ( ) const
inline

Definition at line 2012 of file pytypes.h.

◆ clear() [1/2]

void dict::clear ( )
inline

Definition at line 1713 of file pytypes.h.

References handle::ptr().

◆ clear() [2/2]

void dict::clear ( )
inline

Definition at line 2014 of file pytypes.h.

References handle::ptr().

◆ contains() [1/2]

template<typename T >
bool dict::contains ( T &&  key) const
inline

◆ contains() [2/2]

template<typename T >
bool dict::contains ( T &&  key) const
inline

Definition at line 2016 of file pytypes.h.

References handle::m_ptr, and handle::ptr().

◆ empty() [1/2]

bool dict::empty ( ) const
inline

Definition at line 1710 of file pytypes.h.

References size().

Referenced by cpp_function::dispatcher().

◆ empty() [2/2]

bool dict::empty ( ) const
inline

Definition at line 2011 of file pytypes.h.

References size().

◆ end() [1/2]

detail::dict_iterator dict::end ( ) const
inline

Definition at line 1712 of file pytypes.h.

◆ end() [2/2]

detail::dict_iterator dict::end ( ) const
inline

Definition at line 2013 of file pytypes.h.

◆ raw_dict() [1/2]

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

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

Definition at line 1721 of file pytypes.h.

References handle::inc_ref(), and handle::ptr().

◆ raw_dict() [2/2]

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

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

Definition at line 2026 of file pytypes.h.

References handle::inc_ref(), and handle::ptr().

◆ size() [1/2]

size_t dict::size ( ) const
inline

Definition at line 1709 of file pytypes.h.

References handle::m_ptr.

Referenced by empty(), and map_caster< Type, Key, Value >::reserve_maybe().

◆ size() [2/2]

size_t dict::size ( ) const
inline

Definition at line 2010 of file pytypes.h.

References handle::m_ptr.


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