Trait FromPyObject

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

Available on crate features dep_pyo3 and std only.

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

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

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.

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.

Implementations on Foreign Types

impl FromPyObject<'_> for bool

Converts a Python bool to a Rust bool.

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<bool, PyErr>

impl FromPyObject<'_> for char

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<char, PyErr>

impl FromPyObject<'_> for i128

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

impl FromPyObject<'_> for u8

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<u8, PyErr>

impl FromPyObject<'_> for u64

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

impl FromPyObject<'_> for u128

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

impl FromPyObject<'_> for usize

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<usize, PyErr>

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

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

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

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

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<i8, PyErr>

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<i16, PyErr>

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<i32, PyErr>

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<i64, PyErr>

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<isize, PyErr>

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<u16, PyErr>

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

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<u32, PyErr>

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

where T0: FromPyObject<'py>,

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

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

where T0: FromPyObject<'py>, T1: FromPyObject<'py>,

fn extract_bound(obj: &Bound<'py, PyAny>) -> Result<(T0, T1), PyErr>

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

where T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>,

fn extract_bound(obj: &Bound<'py, PyAny>) -> Result<(T0, T1, T2), PyErr>

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

where T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>,

fn extract_bound(obj: &Bound<'py, PyAny>) -> Result<(T0, T1, T2, T3), PyErr>

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

where T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>,

fn extract_bound(obj: &Bound<'py, PyAny>) -> Result<(T0, T1, T2, T3, T4), PyErr>

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

where T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>,

fn extract_bound( obj: &Bound<'py, PyAny>, ) -> Result<(T0, T1, T2, T3, T4, T5), PyErr>

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

where T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>,

fn extract_bound( obj: &Bound<'py, PyAny>, ) -> Result<(T0, T1, T2, T3, T4, T5, T6), PyErr>

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

where T0: FromPyObject<'py>, T1: FromPyObject<'py>, T2: FromPyObject<'py>, T3: FromPyObject<'py>, T4: FromPyObject<'py>, T5: FromPyObject<'py>, T6: FromPyObject<'py>, T7: FromPyObject<'py>,

fn extract_bound( obj: &Bound<'py, PyAny>, ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7), PyErr>

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

where 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>,

fn extract_bound( obj: &Bound<'py, PyAny>, ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8), PyErr>

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

where 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>,

fn extract_bound( obj: &Bound<'py, PyAny>, ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9), PyErr>

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

where 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>,

fn extract_bound( obj: &Bound<'py, PyAny>, ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10), PyErr>

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

where 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>,

fn extract_bound( obj: &Bound<'py, PyAny>, ) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11), PyErr>

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

where T: FromPyObject<'py>,

fn extract_bound(obj: &Bound<'py, PyAny>) -> Result<[T; N], PyErr>

Implementors

impl FromPyObject<'_> for IpAddr

impl FromPyObject<'_> for NonZero<i8>

impl FromPyObject<'_> for NonZero<i16>

impl FromPyObject<'_> for NonZero<i32>

impl FromPyObject<'_> for NonZero<i64>

impl FromPyObject<'_> for NonZero<i128>

impl FromPyObject<'_> for NonZero<isize>

impl FromPyObject<'_> for NonZero<u8>

impl FromPyObject<'_> for NonZero<u16>

impl FromPyObject<'_> for NonZero<u32>

impl FromPyObject<'_> for NonZero<u64>

impl FromPyObject<'_> for NonZero<u128>

impl FromPyObject<'_> for NonZero<usize>

impl FromPyObject<'_> for PathBuf

impl FromPyObject<'_> for String

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

impl FromPyObject<'_> for OsString

impl FromPyObject<'_> for Duration

impl FromPyObject<'_> for SystemTime

impl FromPyObject<'_> for PyBackedBytes

impl FromPyObject<'_> for PyBackedStr

impl<'py, K> FromPyObject<'py> for BTreeSet<K>

where K: FromPyObject<'py> + Ord,

impl<'py, K, S> FromPyObject<'py> for devela::all::HashSet<K, S>

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

impl<'py, K, S> FromPyObject<'py> for devela::_dep::_std::collections::HashSet<K, S>

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

impl<'py, K, V> FromPyObject<'py> for BTreeMap<K, V>

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

impl<'py, K, V, S> FromPyObject<'py> for devela::all::HashMap<K, V, S>

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

impl<'py, K, V, S> FromPyObject<'py> for devela::_dep::_std::collections::HashMap<K, V, S>

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

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

where T: FromPyObject<'py>,

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

where T: FromPyObject<'py>,

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

where T: FromPyObject<'py>,

impl<'py, T> FromPyObject<'py> for Bound<'py, T>

where T: PyTypeCheck,

impl<'py, T> FromPyObject<'py> for PyRef<'py, T>

where T: PyClass,

impl<'py, T> FromPyObject<'py> for PyRefMut<'py, T>

where T: PyClass<Frozen = False>,

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

where T: Element,

impl<T> FromPyObject<'_> for Py<T>

where T: PyTypeCheck,

impl<T> FromPyObject<'_> for T

where T: PyClass + Clone,