Struct pyo3::prelude::Py

#[repr(transparent)]
pub struct Py<T>(_, _);

Safe wrapper around unsafe *mut ffi::PyObject pointer with specified type information.

Py<T> is thread-safe, because any python related operations require a Python<'p> token.

Methods

impl<T> Py<T>

pub fn new(py: Python, value: T) -> PyResult<Py<T>> where
    T: PyTypeCreate, 

Create new instance of T and move it under python management

pub unsafe fn from_owned_ptr(ptr: *mut PyObject) -> Py<T>

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

pub unsafe fn from_owned_ptr_or_panic(ptr: *mut PyObject) -> Py<T>

Creates a Py<T> 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<Py<T>>

Construct Py<T> from the result of a Python FFI call that returns a new reference (owned pointer). Returns Err(PyErr) if the pointer is null. Unsafe because the pointer might be invalid.

pub unsafe fn from_borrowed_ptr(ptr: *mut PyObject) -> Py<T>

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

pub fn get_refcnt(&self) -> isize

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

pub fn clone_ref(&self, _py: Python) -> Py<T>

Clone self, Calls Py_INCREF() on the ptr.

Trait Implementations

impl<T> AsPyPointer for Py<T>

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl<T> IntoPyPointer for Py<T>

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

Gets the underlying FFI pointer, returns a owned pointer.

impl<T> ToPyObject for Py<T>

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

Converts Py instance -> PyObject.

impl FromPy<()> for Py<PyTuple>

Converts () to an empty Python tuple.

fn from_py(_: (), py: Python) -> Py<PyTuple>

Performs the conversion.

impl<'a> FromPy<&'a PyTuple> for Py<PyTuple>

fn from_py(tuple: &'a PyTuple, _py: Python) -> Py<PyTuple>

Performs the conversion.

impl<A: IntoPyObject> IntoPy<Py<PyTuple>> for (A,)

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

impl<A: IntoPyObject, B: IntoPyObject> IntoPy<Py<PyTuple>> for (A, B)

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

impl<A: IntoPyObject, B: IntoPyObject, C: IntoPyObject> IntoPy<Py<PyTuple>> for (A, B, C)

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

impl<A: IntoPyObject, B: IntoPyObject, C: IntoPyObject, D: IntoPyObject> IntoPy<Py<PyTuple>> for (A, B, C, D)

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

impl<A: IntoPyObject, B: IntoPyObject, C: IntoPyObject, D: IntoPyObject, E: IntoPyObject> IntoPy<Py<PyTuple>> for (A, B, C, D, E)

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

impl<A: IntoPyObject, B: IntoPyObject, C: IntoPyObject, D: IntoPyObject, E: IntoPyObject, F: IntoPyObject> IntoPy<Py<PyTuple>> for (A, B, C, D, E, F)

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

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

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

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

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

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

fn into_py(self, py: Python) -> Py<PyTuple>

Performs the conversion.

impl<T> IntoPyObject for Py<T>

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

Converts Py instance -> PyObject. Consumes self without calling Py_DECREF()

impl<'a, T> FromPyObject<'a> for Py<T> where
    T: AsPyPointer,
    &'a T: 'a + FromPyObject<'a>, 

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

Extracts Self from the source PyObject.

impl<T> AsPyRef<T> for Py<T> where
    T: PyTypeInfo, 

fn as_ref(&self, py: Python) -> PyRef<T>

Return reference to object.

fn as_mut(&mut self, py: Python) -> PyRefMut<T>

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<T> From<Py<T>> for PyObject

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

Performs the conversion.

impl<'a, T> From<PyRef<'a, T>> for Py<T> where
    T: PyTypeInfo, 

fn from(ob: PyRef<'a, T>) -> Self

Performs the conversion.

impl<'a, T> From<PyRefMut<'a, T>> for Py<T> where
    T: PyTypeInfo, 

fn from(ob: PyRefMut<'a, T>) -> Self

Performs the conversion.

impl<T> PartialEq<Py<T>> for Py<T>

fn eq(&self, o: &Py<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> Sync for Py<T>

impl<T> Send for Py<T>

impl<T> Drop for Py<T>

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

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Debug> Debug for Py<T>

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

Formats the value using the given formatter.