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 the unsafe *mut ffi::PyObject pointer.

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: PyTryFrom, 

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<A>(
    &self,
    py: Python,
    args: A,
    kwargs: Option<PyDict>
) -> PyResult<PyObject> where
    A: IntoPyTuple, 

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<A>(&self, py: Python, args: A) -> PyResult<PyObject> where
    A: IntoPyTuple, 

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

pub fn call_method(
    &self,
    py: Python,
    name: &str,
    args: impl IntoPyTuple,
    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 IntoPyTuple
) -> PyResult<PyObject>

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

Trait Implementations

impl ToPyObject for PyObject

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

Converts self into a Python object.

impl IntoPyObject for PyObject

fn into_object(self, _py: Python) -> PyObject

Converts self into a Python object. (Consumes self)

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

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

Extracts Self from the source PyObject.

impl AsPyRef<PyObjectRef> for PyObject

fn as_ref(&self, _py: Python) -> &PyObjectRef

Return reference to object.

fn as_mut(&mut self, _py: Python) -> &mut PyObjectRef

Return mutable reference to object.

fn with<F, R>(&self, f: F) -> R where
    F: FnOnce(Python, &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, &mut 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, &T) -> R, 

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

impl ToPyPointer for PyObject

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl<'a> ToPyPointer for &'a 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<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: ToPyPointer, 

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

Performs the conversion.

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

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

Performs the conversion.

impl Send 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 Sync for PyObject

impl Debug for PyObject

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

Formats the value using the given formatter.