Struct cpython::PyDict

pub struct PyDict(_);

Represents a Python dict.

Implementations

impl PyDict

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

Creates a new empty dictionary.

May panic when running out of memory.

pub fn copy(&self, py: Python<'_>) -> PyResult<PyDict>

Return a new dictionary that contains the same key-value pairs as self. Corresponds to dict(self) in Python.

pub fn clear(&self, _py: Python<'_>)

Empty an existing dictionary of all key-value pairs.

pub fn len(&self, _py: Python<'_>) -> usize

Return the number of items in the dictionary. This is equivalent to len(p) on a dictionary.

pub fn contains<K>(&self, py: Python<'_>, key: K) -> PyResult<bool>where
    K: ToPyObject,

Determine if the dictionary contains the specified key. This is equivalent to the Python expression key in self.

pub fn get_item<K>(&self, py: Python<'_>, key: K) -> Option<PyObject>where
    K: ToPyObject,

Gets an item from the dictionary. Returns None if the item is not present, or if an error occurs.

pub fn set_item<K, V>(&self, py: Python<'_>, key: K, value: V) -> PyResult<()>where
    K: ToPyObject,
    V: ToPyObject,

Sets an item value. This is equivalent to the Python expression self[key] = value.

pub fn del_item<K>(&self, py: Python<'_>, key: K) -> PyResult<()>where
    K: ToPyObject,

Deletes an item. This is equivalent to the Python expression del self[key].

pub fn items_list(&self, py: Python<'_>) -> PyList

pub fn items(&self, py: Python<'_>) -> Vec<(PyObject, PyObject)>

Returns the list of (key,value) pairs in this dictionary.

Trait Implementations

impl<'s> FromPyObject<'s> for &'s PyDict

fn extract(py: Python<'_>, obj: &'s PyObject) -> PyResult<&'s PyDict>

Extracts Self from the source PyObject.

impl<'s> FromPyObject<'s> for PyDict

fn extract(py: Python<'_>, obj: &'s PyObject) -> PyResult<PyDict>

Extracts Self from the source PyObject.

impl PythonObject for PyDict

unsafe fn unchecked_downcast_from(obj: PyObject) -> Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

unsafe fn unchecked_downcast_borrow_from<'a>(obj: &'a PyObject) -> &'a Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

fn as_object(&self) -> &PyObject

Casts the Python object to PyObject.

fn into_object(self) -> PyObject

Casts the Python object to PyObject.

impl PythonObjectWithCheckedDowncast for PyDict

fn downcast_from<'p>(
    py: Python<'p>,
    obj: PyObject
) -> Result<PyDict, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

fn downcast_borrow_from<'a, 'p>(
    py: Python<'p>,
    obj: &'a PyObject
) -> Result<&'a PyDict, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

impl PythonObjectWithTypeObject for PyDict

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

Retrieves the type object for this Python object type.

impl ToPyObject for PyDict

Identity conversion: allows using existing PyObject instances where T: ToPyObject is expected.

type ObjectType = PyDict

fn to_py_object(&self, py: Python<'_>) -> PyDict

Converts self into a Python object.

fn into_py_object(self, _py: Python<'_>) -> PyDict

Converts self into a Python object.

fn with_borrowed_ptr<F, R>(&self, _py: Python<'_>, f: F) -> Rwhere
    F: FnOnce(*mut PyObject) -> R,

Converts self into a Python object and calls the specified closure on the native FFI pointer underlying the Python object.