Struct pyo3::prelude::PyObject

#[repr(transparent)]pub struct PyObject(_);

A Python object of any type.

The Python object's lifetime is managed by Python's garbage collector, so to access the object API, a Python<'py> GIL token is required.

See the guide for an explanation of the different Python object types.

Technically, it is a safe wrapper around NonNull<ffi::PyObject>.

Implementations

impl PyObject

pub unsafe fn from_owned_ptr(_py: Python<'_>, ptr: *mut PyObject) -> PyObject

Creates a PyObject instance for the given FFI pointer. This moves ownership over the pointer into the PyObject. Undefined behavior if the pointer is NULL or invalid.

pub unsafe fn from_owned_ptr_or_panic(
    py: Python<'_>,
    ptr: *mut PyObject
) -> PyObject

Creates a PyObject instance for the given FFI pointer. Panics if the pointer is NULL. Undefined behavior if the pointer is invalid.

pub unsafe fn from_owned_ptr_or_err(
    py: Python<'_>,
    ptr: *mut PyObject
) -> PyResult<PyObject>

Constructs a PyObject from the result of a Python FFI call that returns a new reference (owned pointer). Returns Err(PyErr) if the pointer is NULL.

pub unsafe fn from_owned_ptr_or_opt(
    _py: Python<'_>,
    ptr: *mut PyObject
) -> Option<PyObject>

Constructs a PyObject from the result of a Python FFI call that returns a new reference (owned pointer). Returns None if the pointer is NULL.

pub unsafe fn from_borrowed_ptr(_py: Python<'_>, ptr: *mut PyObject) -> PyObject

Creates a PyObject instance for the given Python FFI pointer. Calls Py_INCREF() on the ptr. Undefined behavior if the pointer is NULL or invalid.

pub unsafe fn from_borrowed_ptr_or_err(
    py: Python<'_>,
    ptr: *mut PyObject
) -> PyResult<PyObject>

Creates a PyObject instance for the given Python FFI pointer. Calls Py_INCREF() on the ptr. Returns Err(PyErr) if the pointer is NULL.

pub unsafe fn from_borrowed_ptr_or_opt(
    py: Python<'_>,
    ptr: *mut PyObject
) -> Option<PyObject>

Creates a PyObject instance for the given Python FFI pointer. Calls Py_INCREF() on the ptr. Returns None if the pointer is NULL.

pub fn get_refcnt(&self, _py: Python<'_>) -> isize

Gets the reference count of the ffi::PyObject pointer.

pub fn clone_ref(&self, py: Python<'_>) -> Self

Clones self by calling Py_INCREF() on the ptr.

pub fn is_none(&self, _py: Python<'_>) -> bool

Returns whether the object is considered to be None.

This is equivalent to the Python expression self is None.

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

Returns whether the object is considered to be true.

This is equivalent to the Python expression bool(self).

pub fn cast_as<'p, D>(
    &'p self,
    py: Python<'p>
) -> Result<&'p D, PyDowncastError> where
    D: PyTryFrom<'p>, 

Casts the PyObject to a concrete Python object type.

This can cast only to native Python types, not types implemented in Rust.

pub fn extract<'p, D>(&'p self, py: Python<'p>) -> PyResult<D> where
    D: FromPyObject<'p>, 

Extracts some type from the Python object.

This is a wrapper function around FromPyObject::extract().

pub fn getattr<N>(&self, py: Python<'_>, attr_name: N) -> PyResult<PyObject> where
    N: ToPyObject, 

Retrieves an attribute value.

This is equivalent to the Python expression self.attr_name.

pub fn call(
    &self,
    py: Python<'_>,
    args: impl IntoPy<Py<PyTuple>>,
    kwargs: Option<&PyDict>
) -> PyResult<PyObject>

Calls the object.

This is equivalent to the Python expression self(*args, **kwargs).

pub fn call1(
    &self,
    py: Python<'_>,
    args: impl IntoPy<Py<PyTuple>>
) -> PyResult<PyObject>

Calls the object with only positional arguments.

This is equivalent to the Python expression self(*args).

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

Calls the object without arguments.

This is equivalent to the Python expression self().

pub fn call_method(
    &self,
    py: Python<'_>,
    name: &str,
    args: impl IntoPy<Py<PyTuple>>,
    kwargs: Option<&PyDict>
) -> PyResult<PyObject>

Calls a method on the object.

This is equivalent to the Python expression self.name(*args, **kwargs).

pub fn call_method1(
    &self,
    py: Python<'_>,
    name: &str,
    args: impl IntoPy<Py<PyTuple>>
) -> PyResult<PyObject>

Calls a method on the object with only positional arguments.

This is equivalent to the Python expression self.name(*args).

pub fn call_method0(&self, py: Python<'_>, name: &str) -> PyResult<PyObject>

Calls a method on the object with no arguments.

This is equivalent to the Python expression self.name().

Trait Implementations

impl AsPyPointer for PyObject

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsPyRef for PyObject

type Target = PyAny

fn as_ref<'p>(&'p self, _py: Python<'p>) -> &'p PyAny

Return reference to object.

impl Clone for PyObject

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PyObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for PyObject

Dropping a PyObject instance decrements the reference count on the object by 1.

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> From<&'a T> for PyObject where
    T: AsPyPointer + PyNativeType, 

fn from(ob: &'a T) -> Self

Performs the conversion.

impl<'a, T> From<&'a mut T> for PyObject where
    T: AsPyPointer + PyNativeType, 

fn from(ob: &'a mut T) -> Self

Performs the conversion.

impl<T> From<Py<T>> for PyObject

fn from(ob: Py<T>) -> Self

Performs the conversion.

impl<'a> FromPy<&'a [u8]> for PyObject

fn from_py(other: &'a [u8], py: Python<'_>) -> Self

Performs the conversion.

impl<'a, T> FromPy<&'a T> for PyObject where
    T: AsPyPointer, 

fn from_py(other: &'a T, py: Python<'_>) -> PyObject

Performs the conversion.

impl FromPy<()> for PyObject

fn from_py(_: (), py: Python<'_>) -> Self

Performs the conversion.

impl<K> FromPy<BTreeSet<K>> for PyObject where
    K: IntoPy<PyObject> + Ord + ToPyObject, 

fn from_py(src: BTreeSet<K>, py: Python<'_>) -> Self

Performs the conversion.

impl<K, S> FromPy<HashSet<K, S>> for PyObject where
    K: IntoPy<PyObject> + Eq + Hash,
    S: BuildHasher + Default, 

fn from_py(src: HashSet<K, S>, py: Python<'_>) -> Self

Performs the conversion.

impl FromPy<PyErr> for PyObject

fn from_py(other: PyErr, py: Python<'_>) -> Self

Performs the conversion.

impl<'p, T: PyClass> FromPy<PyRef<'p, T>> for PyObject

fn from_py(pyref: PyRef<'p, T>, py: Python<'_>) -> PyObject

Performs the conversion.

impl<'p, T: PyClass> FromPy<PyRefMut<'p, T>> for PyObject

fn from_py(pyref: PyRefMut<'p, T>, py: Python<'_>) -> PyObject

Performs the conversion.

impl FromPy<String> for PyObject

fn from_py(other: String, py: Python<'_>) -> Self

Performs the conversion.

impl FromPy<bool> for PyObject

fn from_py(other: bool, py: Python<'_>) -> Self

Performs the conversion.

impl FromPy<f32> for PyObject

fn from_py(other: f32, py: Python<'_>) -> Self

Performs the conversion.

impl FromPy<f64> for PyObject

fn from_py(other: f64, py: Python<'_>) -> Self

Performs the conversion.

impl<'a> FromPyObject<'a> for PyObject

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

Extracts Self from the source PyObject.

impl<T> IntoPy<PyObject> for Option<T> where
    T: IntoPy<PyObject>, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<'a> IntoPy<PyObject> for &'a PyErr

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 5] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 6] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 7] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 8] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 9] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 10] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 11] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 12] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 13] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 14] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for Py<T>

fn into_py(self, _py: Python<'_>) -> PyObject

Converts a Py instance to PyObject. Consumes self without calling Py_DECREF().

impl<T> IntoPy<PyObject> for [T; 15] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 16] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 17] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 18] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 19] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 20] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 21] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 22] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 23] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 24] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<K, V, H> IntoPy<PyObject> for HashMap<K, V, H> where
    K: Hash + Eq + IntoPy<PyObject>,
    V: IntoPy<PyObject>,
    H: BuildHasher, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 25] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 26] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 27] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 28] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 29] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 30] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 31] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 32] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for Vec<T> where
    T: IntoPy<PyObject>, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for i8

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<K, V> IntoPy<PyObject> for BTreeMap<K, V> where
    K: Eq + IntoPy<PyObject>,
    V: IntoPy<PyObject>, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for u8

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for i16

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for u16

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for i32

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for u32

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for i64

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for isize

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for usize

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for u64

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for i128

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 0] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPy<PyObject> for u128

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<'a> IntoPy<PyObject> for &'a str

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<'a> IntoPy<PyObject> for &'a String

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>> IntoPy<PyObject> for (A,)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>> IntoPy<PyObject> for (A, B)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>, C: IntoPy<PyObject>> IntoPy<PyObject> for (A, B, C)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>, C: IntoPy<PyObject>, D: IntoPy<PyObject>> IntoPy<PyObject> for (A, B, C, D)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>, C: IntoPy<PyObject>, D: IntoPy<PyObject>, E: IntoPy<PyObject>> IntoPy<PyObject> for (A, B, C, D, E)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>, C: IntoPy<PyObject>, D: IntoPy<PyObject>, E: IntoPy<PyObject>, F: IntoPy<PyObject>> IntoPy<PyObject> for (A, B, C, D, E, F)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>, C: IntoPy<PyObject>, D: IntoPy<PyObject>, E: IntoPy<PyObject>, F: IntoPy<PyObject>, G: IntoPy<PyObject>> IntoPy<PyObject> for (A, B, C, D, E, F, G)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 1] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>, C: IntoPy<PyObject>, D: IntoPy<PyObject>, E: IntoPy<PyObject>, F: IntoPy<PyObject>, G: IntoPy<PyObject>, H: IntoPy<PyObject>> IntoPy<PyObject> for (A, B, C, D, E, F, G, H)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<A: IntoPy<PyObject>, B: IntoPy<PyObject>, C: IntoPy<PyObject>, D: IntoPy<PyObject>, E: IntoPy<PyObject>, F: IntoPy<PyObject>, G: IntoPy<PyObject>, H: IntoPy<PyObject>, I: IntoPy<PyObject>> IntoPy<PyObject> for (A, B, C, D, E, F, G, H, I)

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 2] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 3] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl<T> IntoPy<PyObject> for [T; 4] where
    T: ToPyObject, 

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl IntoPyPointer for PyObject

#[must_use]fn into_ptr(self) -> *mut PyObject

Gets the underlying FFI pointer, returns a owned pointer.

impl PartialEq<PyObject> for PyObject

fn eq(&self, o: &PyObject) -> bool

Checks for pointer identity, not equivalent to Python's __eq__.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Send for PyObject

impl Sync for PyObject

impl ToPyObject for PyObject

fn to_object(&self, py: Python<'_>) -> PyObject

Converts self into a Python object.