Struct pyo3::PyObject

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

A python object

The python object's lifetime is managed by python's garbage collector.

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

Methods

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>

Construct 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>

Construct 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) -> isize

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

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

Clone self, Calls Py_INCREF() on the ptr.

pub fn is_none(&self) -> bool

Returns whether the object is considered to be None. This is equivalent to the Python expression: '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: 'not not self'

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

Casts the PyObject to a concrete Python object type.

pub fn extract<'p, D>(&'p self, py: Python) -> 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 call0(&self, py: Python) -> PyResult<PyObject>

Calls the object without arguments. This is equivalent to the Python expression: 'self()'

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

Calls the object. This is equivalent to the Python expression: 'self(*args)'

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_method0(&self, py: Python, name: &str) -> PyResult<PyObject>

Calls a method on the object. This is equivalent to the Python expression: 'self.name()'

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

Calls a method on the object. This is equivalent to the Python expression: 'self.name(*args)'

Trait Implementations

impl AsPyPointer for PyObject

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl IntoPyPointer for PyObject

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

Gets the underlying FFI pointer, returns a owned pointer.

impl ToPyObject for PyObject

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

Converts self into a Python object.

impl FromPy<()> for PyObject

fn from_py(_: (), 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<PyErr> for PyObject

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

Performs the conversion.

impl FromPy<bool> for PyObject

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

Performs the conversion.

impl FromPy<f64> for PyObject

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

Performs the conversion.

impl FromPy<f32> for PyObject

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

Performs the conversion.

impl FromPy<String> for PyObject

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

Performs the conversion.

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<'a, T: PyTypeInfo> IntoPy<PyObject> for PyRef<'a, T>

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

Performs the conversion.

impl<'a, T: PyTypeInfo> IntoPy<PyObject> for PyRefMut<'a, T>

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 Py instance -> PyObject. Consumes self without calling Py_DECREF()

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<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<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 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 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<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<'a> FromPyObject<'a> for PyObject

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

Extracts Self from the source PyObject.

impl AsPyRef<PyAny> for PyObject

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

Return reference to object.

fn as_mut(&mut self, _py: Python) -> PyRefMut<PyAny>

Return mutable reference to object.

fn with<F, R>(&self, f: F) -> R where
    F: FnOnce(Python, PyRef<T>) -> R, 

Acquire python gil and call closure with object reference.

fn with_mut<F, R>(&mut self, f: F) -> R where
    F: FnOnce(Python, PyRefMut<T>) -> R, 

Acquire python gil and call closure with mutable object reference.

fn into_py<F, R>(self, f: F) -> R where
    Self: IntoPyPointer,
    F: FnOnce(Python, PyRef<T>) -> R, 

fn into_mut_py<F, R>(self, f: F) -> R where
    Self: IntoPyPointer,
    F: FnOnce(Python, PyRefMut<T>) -> R, 

impl Sync for PyObject

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 PartialEq<PyObject> for PyObject

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

Checks for identity, not python's __eq__

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

This method tests for !=.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl Send for PyObject

impl Debug for PyObject

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

Formats the value using the given formatter.