Trait FromPyObject

Source

pub trait FromPyObject<'py>: Sized {
    // Required method
    fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self>;

    // Provided methods
    fn extract(ob: &'py PyAny) -> PyResult<Self> { ... }
    fn type_input() -> TypeInfo { ... }
}

Expand description

Extract a type from a Python object.

Normal usage is through the extract methods on Bound and Py, which forward to this trait.

§Examples

use pyo3::prelude::*;
use pyo3::types::PyString;

Python::with_gil(|py| {
    // Calling `.extract()` on a `Bound` smart pointer
    let obj: Bound<'_, PyString> = PyString::new_bound(py, "blah");
    let s: String = obj.extract()?;

    // Calling `.extract(py)` on a `Py` smart pointer
    let obj: Py<PyString> = obj.unbind();
    let s: String = obj.extract(py)?;
})

During the migration of PyO3 from the “GIL Refs” API to the Bound<T> smart pointer, this trait has two methods extract and extract_bound which are defaulted to call each other. To avoid infinite recursion, implementors must implement at least one of these methods. The recommendation is to implement extract_bound and leave extract as the default implementation.

Required Methods§

Source

fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

Implementors are encouraged to implement this method and leave extract defaulted, as this will be most compatible with PyO3’s future API.

Provided Methods§

Source

fn extract(ob: &'py PyAny) -> PyResult<Self>

Available on crate feature gil-refs only.

Extracts Self from the source GIL Ref obj.

Implementors are encouraged to implement extract_bound and leave this method as the default implementation, which will forward calls to extract_bound.

Source

fn type_input() -> TypeInfo

Available on crate feature experimental-inspect only.

Extracts the type hint information for this type when it appears as an argument.

For example, Vec<u32> would return Sequence[int]. The default implementation returns Any, which is correct for any type.

For most types, the return value for this method will be identical to that of IntoPy::type_output. It may be different for some types, such as Dict, to allow duck-typing: functions return Dict but take Mapping as argument.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait FromPyObjectCopy item path

§Examples

Required Methods§

fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self>

Provided Methods§

fn extract(ob: &'py PyAny) -> PyResult<Self>

fn type_input() -> TypeInfo

Dyn Compatibility§

Implementations on Foreign Types§

impl FromPyObject<'_> for IpAddr

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

impl FromPyObject<'_> for Tz

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<Tz>

impl FromPyObject<'_> for bool

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for char

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for i128

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<i128>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for u64

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<u64>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for u128

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<u128>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for usize

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for String

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for Duration

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

impl FromPyObject<'_> for OsString

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<Self>

impl FromPyObject<'_> for PathBuf

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<Self>

impl FromPyObject<'_> for SystemTime

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

impl FromPyObject<'_> for NaiveDate

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<NaiveDate>

impl FromPyObject<'_> for NaiveDateTime

fn extract_bound(dt: &Bound<'_, PyAny>) -> PyResult<NaiveDateTime>

impl FromPyObject<'_> for NaiveTime

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<NaiveTime>

impl FromPyObject<'_> for FixedOffset

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<FixedOffset>

impl FromPyObject<'_> for Utc

fn extract_bound(ob: &Bound<'_, PyAny>) -> PyResult<Utc>

impl FromPyObject<'_> for Complex<f32>

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Complex<f32>>

impl FromPyObject<'_> for Complex<f64>

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Complex<f64>>

impl FromPyObject<'_> for Decimal

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

impl FromPyObject<'_> for NonZeroI8

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for NonZeroI16

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for NonZeroI32

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for NonZeroI64

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for NonZeroI128

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for NonZeroIsize

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for NonZeroU8

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

fn type_input() -> TypeInfo

impl FromPyObject<'_> for NonZeroU16

Trait FromPyObject