pyo3::conversion

Trait FromPyObject

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

    // Provided method
    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(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 type_input() -> TypeInfo

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.

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

source§

impl FromPyObject<'_> for IpAddr

source§

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

source§

impl FromPyObject<'_> for bool

Converts a Python bool to a Rust bool.

Fails with TypeError if the input is not a Python bool.

source§

impl FromPyObject<'_> for char

source§

impl FromPyObject<'_> for i128

source§

impl FromPyObject<'_> for u8

source§

impl FromPyObject<'_> for u64

source§

impl FromPyObject<'_> for u128

source§

impl FromPyObject<'_> for usize

source§

impl FromPyObject<'_> for String

Allows extracting strings from Python objects. Accepts Python str and unicode objects.

source§

impl FromPyObject<'_> for Duration

source§

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

source§

impl FromPyObject<'_> for OsString

source§

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

source§

impl FromPyObject<'_> for PathBuf

source§

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

source§

impl FromPyObject<'_> for SystemTime

source§

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

source§

impl FromPyObject<'_> for NaiveDate

source§

impl FromPyObject<'_> for NaiveDateTime

source§

impl FromPyObject<'_> for NaiveTime

source§

impl FromPyObject<'_> for FixedOffset

source§

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

Convert python tzinfo to rust FixedOffset.

Note that the conversion will result in precision lost in microseconds as chrono offset does not supports microseconds.

source§

impl FromPyObject<'_> for Utc

source§

impl FromPyObject<'_> for Complex<f32>

source§

impl FromPyObject<'_> for Complex<f64>

source§

impl FromPyObject<'_> for NonZeroI8

source§

impl FromPyObject<'_> for NonZeroI16

source§

impl FromPyObject<'_> for NonZeroI32

source§

impl FromPyObject<'_> for NonZeroI64

source§

impl FromPyObject<'_> for NonZeroI128

source§

impl FromPyObject<'_> for NonZeroIsize

source§

impl FromPyObject<'_> for NonZeroU8

source§

impl FromPyObject<'_> for NonZeroU16

source§

impl FromPyObject<'_> for NonZeroU32

source§

impl FromPyObject<'_> for NonZeroU64

source§

impl FromPyObject<'_> for NonZeroU128

source§

impl FromPyObject<'_> for NonZeroUsize

source§

impl FromPyObject<'_> for Duration

source§

impl FromPyObject<'_> for Decimal

source§

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

source§

impl<'py> FromPyObject<'py> for f32

source§

impl<'py> FromPyObject<'py> for f64

source§

impl<'py> FromPyObject<'py> for i8

source§

impl<'py> FromPyObject<'py> for i16

source§

impl<'py> FromPyObject<'py> for i32

source§

impl<'py> FromPyObject<'py> for i64

source§

impl<'py> FromPyObject<'py> for isize

source§

impl<'py> FromPyObject<'py> for u16

source§

impl<'py> FromPyObject<'py> for u32

source§

impl<'py> FromPyObject<'py> for BigInt

source§

impl<'py> FromPyObject<'py> for BigUint

source§

impl<'py> FromPyObject<'py> for Ratio<i8>

source§

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

source§

impl<'py> FromPyObject<'py> for Ratio<i16>

source§

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

source§

impl<'py> FromPyObject<'py> for Ratio<i32>

source§

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

source§

impl<'py> FromPyObject<'py> for Ratio<i64>

source§

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

source§

impl<'py> FromPyObject<'py> for Ratio<isize>

source§

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

source§

impl<'py> FromPyObject<'py> for Ratio<BigInt>

source§

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

source§

impl<'py, A> FromPyObject<'py> for SmallVec<A>
where A: Array, A::Item: FromPyObject<'py>,

source§

impl<'py, K> FromPyObject<'py> for BTreeSet<K>
where K: FromPyObject<'py> + Ord,

source§

impl<'py, K, S> FromPyObject<'py> for HashSet<K, S>
where K: FromPyObject<'py> + Eq + Hash, S: BuildHasher + Default,

source§

impl<'py, K, S> FromPyObject<'py> for HashSet<K, S>
where K: FromPyObject<'py> + Eq + Hash, S: BuildHasher + Default,

source§

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

source§

impl<'py, K, V> FromPyObject<'py> for BTreeMap<K, V>
where K: FromPyObject<'py> + Ord, V: FromPyObject<'py>,

source§

impl<'py, K, V, S> FromPyObject<'py> for HashMap<K, V, S>
where K: FromPyObject<'py> + Eq + Hash, V: FromPyObject<'py>, S: BuildHasher + Default,

source§

impl<'py, K, V, S> FromPyObject<'py> for HashMap<K, V, S>
where K: FromPyObject<'py> + Eq + Hash, V: FromPyObject<'py>, S: BuildHasher + Default,

source§

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

source§

impl<'py, K, V, S> FromPyObject<'py> for IndexMap<K, V, S>
where K: FromPyObject<'py> + Eq + Hash, V: FromPyObject<'py>, S: BuildHasher + Default,

source§

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

source§

impl<'py, L, R> FromPyObject<'py> for Either<L, R>
where L: FromPyObject<'py>, R: FromPyObject<'py>,

source§

impl<'py, T0: FromPyObject<'py>> FromPyObject<'py> for (T0,)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>> FromPyObject<'py> for (T0, T1)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4, T5)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4, T5, T6)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>, T7: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4, T5, T6, T7)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>, T7: FromPyObject<'py>, T8: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4, T5, T6, T7, T8)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>, T7: FromPyObject<'py>, T8: FromPyObject<'py>, T9: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>, T7: FromPyObject<'py>, T8: FromPyObject<'py>, T9: FromPyObject<'py>, T10: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

source§

impl<'py, T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>, T7: FromPyObject<'py>, T8: FromPyObject<'py>, T9: FromPyObject<'py>, T10: FromPyObject<'py>, T11: FromPyObject<'py>> FromPyObject<'py> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

source§

impl<'py, T> FromPyObject<'py> for Option<T>
where T: FromPyObject<'py>,

source§

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

source§

impl<'py, T> FromPyObject<'py> for Vec<T>
where T: FromPyObject<'py>,

source§

impl<'py, T, const N: usize> FromPyObject<'py> for [T; N]
where T: FromPyObject<'py>,

source§

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

source§

impl<'py, T: FromPyObject<'py>> FromPyObject<'py> for Cell<T>

source§

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

source§

impl<Tz: TimeZone + for<'py> FromPyObject<'py>> FromPyObject<'_> for DateTime<Tz>

Implementors§

source§

impl FromPyObject<'_> for PyBackedBytes

source§

impl FromPyObject<'_> for PyBackedStr

source§

impl<'py, T> FromPyObject<'py> for Bound<'py, T>
where T: PyTypeCheck,

source§

impl<'py, T> FromPyObject<'py> for PyRef<'py, T>
where T: PyClass,

source§

impl<'py, T> FromPyObject<'py> for PyRefMut<'py, T>
where T: PyClass<Frozen = False>,

source§

impl<T> FromPyObject<'_> for Py<T>
where T: PyTypeCheck,

source§

impl<T> FromPyObject<'_> for T
where T: PyClass + Clone,

source§

impl<T: Element> FromPyObject<'_> for PyBuffer<T>