Struct PyDict

#[repr(transparent)]
pub struct PyDict(PyAny);

Represents a Python dict.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyDict> or Bound<'py, PyDict>.

For APIs available on dict objects, see the PyDictMethods trait which is implemented for Bound<'py, PyDict>.

Tuple Fields

0: PyAny

Implementations

impl PyDict

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self>

impl PyDict

pub fn new(py: Python<'_>) -> Bound<'_, PyDict>

Creates a new empty dictionary.

pub fn new_bound(py: Python<'_>) -> Bound<'_, PyDict>

👎Deprecated since 0.23.0: renamed to PyDict::new

Deprecated name for PyDict::new.

pub fn from_sequence<'py>( seq: &Bound<'py, PyAny>, ) -> PyResult<Bound<'py, PyDict>>

Available on neither PyPy nor GraalPy.

Creates a new dictionary from the sequence given.

The sequence must consist of (PyObject, PyObject). This is equivalent to dict([("a", 1), ("b", 2)]).

Returns an error on invalid input. In the case of key collisions, this keeps the last entry seen.

pub fn from_sequence_bound<'py>( seq: &Bound<'py, PyAny>, ) -> PyResult<Bound<'py, PyDict>>

👎Deprecated since 0.23.0: renamed to PyDict::from_sequence

Available on neither PyPy nor GraalPy.

Deprecated name for PyDict::from_sequence.

Trait Implementations

impl PyClassBaseType for PyDict

Available on non-Py_LIMITED_API only.

type LayoutAsBase = PyClassObjectBase<PyDictObject>

type BaseNativeType = PyDict

type Initializer = PyNativeTypeInitializer<PyDict>

type PyClassMutability = ImmutableClass

impl PyTypeInfo for PyDict

const NAME: &'static str = "PyDict"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyDict

impl PyLayout<PyDict> for PyDictObject

impl PySizedLayout<PyDict> for PyDictObject