Skip to main content

PyDict

Struct PyDict 

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

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§

Source§

impl PyDict

Source

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

Source

#[doc(hidden)]
pub const _PYO3_INTROSPECTION_ID: &'static str = ":: core :: option :: Option :: Some(\"builtins\")PyDict"

Source§

impl PyDict

Source

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

Creates a new empty dictionary.

Source

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

Available on neither GraalPy nor PyPy.

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.

Trait Implementations§

Source§

impl DerefToPyAny for PyDict

Source§

impl PyClassBaseType for PyDict

Available on non-Py_LIMITED_API only.
Source§

impl PyLayout<PyDict> for PyDictObject

Source§

impl PySizedLayout<PyDict> for PyDictObject

Source§

impl PyTypeInfo for PyDict

Source§

const NAME: &'static str = "PyDict"

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.
Source§

const MODULE: Option<&'static str>

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.
Source§

const TYPE_HINT: PyStaticExpr

Available on crate feature experimental-inspect only.
Provides the full python type as a type hint.
Source§

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

Returns the PyTypeObject instance for this type.
Source§

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

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

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

Returns the safe abstraction over the type object.
Source§

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

Checks if object is an instance of this type.

Auto Trait Implementations§

§

impl !Freeze for PyDict

§

impl !RefUnwindSafe for PyDict

§

impl !Send for PyDict

§

impl !Sync for PyDict

§

impl Unpin for PyDict

§

impl UnsafeUnpin for PyDict

§

impl UnwindSafe for PyDict

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

const TYPE_HINT: PyStaticExpr = const TYPE_HINT: PyStaticExpr = <T as PyTypeInfo>::TYPE_HINT;

Available on crate feature experimental-inspect only.
Provides the full python type of the allowed values as a Python type hint.
Source§

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

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> SizedTypeProperties for T

Source§

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)
Source§

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
Source§

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)
The largest safe length for a [Self]. Read more
Source§

impl<T> SomeWrap<T> for T

Source§

fn wrap(self) -> Option<T>

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here