Struct pyo3::PyAny

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

A Python object with GIL lifetime

Represents any Python object. All Python objects can be cast to PyAny. In addition, if the inner object is an instance of type T, we can downcast PyAny into T.

PyAny is used as a reference with a lifetime that represents that the GIL is held, therefore its API does not require a Python<'py> token.

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

Example

use pyo3::prelude::*;
use pyo3::types::{PyAny, PyDict, PyList};
let gil = Python::acquire_gil();
let dict = PyDict::new(gil.python());
assert!(gil.python().is_instance::<PyAny, _>(dict).unwrap());
let any = dict.as_ref();
assert!(any.downcast::<PyDict>().is_ok());
assert!(any.downcast::<PyList>().is_err());

Implementations

impl PyAny

pub fn downcast<T>(&self) -> Result<&T, PyDowncastError> where
    T: PyTryFrom<'py>, 

Convert this PyAny to a concrete Python type.

pub fn hasattr<N>(&self, attr_name: N) -> PyResult<bool> where
    N: ToPyObject, 

Determines whether this object has the given attribute.

This is equivalent to the Python expression hasattr(self, attr_name).

pub fn getattr<N>(&self, attr_name: N) -> PyResult<&PyAny> where
    N: ToPyObject, 

Retrieves an attribute value.

This is equivalent to the Python expression self.attr_name.

pub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()> where
    N: ToBorrowedObject,
    V: ToBorrowedObject, 

Sets an attribute value.

This is equivalent to the Python expression self.attr_name = value.

pub fn delattr<N>(&self, attr_name: N) -> PyResult<()> where
    N: ToPyObject, 

Deletes an attribute.

This is equivalent to the Python expression del self.attr_name.

pub fn compare<O>(&self, other: O) -> PyResult<Ordering> where
    O: ToPyObject, 

Compares two Python objects.

This is equivalent to:

if self == other:
    return Equal
elif a < b:
    return Less
elif a > b:
    return Greater
else:
    raise TypeError("PyAny::compare(): All comparisons returned false")

pub fn rich_compare<O>(
    &self,
    other: O,
    compare_op: CompareOp
) -> PyResult<&PyAny> where
    O: ToPyObject, 

Compares two Python objects.

Depending on the value of compare_op, this is equivalent to one of the following Python expressions:

• CompareOp::Eq: self == other
• CompareOp::Ne: self != other
• CompareOp::Lt: self < other
• CompareOp::Le: self <= other
• CompareOp::Gt: self > other
• CompareOp::Ge: self >= other

pub fn is_callable(&self) -> bool

Determines whether this object is callable.

pub fn call(
    &self,
    args: impl IntoPy<Py<PyTuple>>,
    kwargs: Option<&PyDict>
) -> PyResult<&PyAny>

Calls the object.

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

pub fn call0(&self) -> PyResult<&PyAny>

Calls the object without arguments.

This is equivalent to the Python expression self().

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

Calls the object with only positional arguments.

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

pub fn call_method(
    &self,
    name: &str,
    args: impl IntoPy<Py<PyTuple>>,
    kwargs: Option<&PyDict>
) -> PyResult<&PyAny>

Calls a method on the object.

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

Example

use pyo3::types::IntoPyDict;

let gil = Python::acquire_gil();
let py = gil.python();
let list = vec![3, 6, 5, 4, 7].to_object(py);
let dict = vec![("reverse", true)].into_py_dict(py);
list.call_method(py, "sort", (), Some(dict)).unwrap();
assert_eq!(list.extract::<Vec<i32>>(py).unwrap(), vec![7, 6, 5, 4, 3]);

let new_element = 1.to_object(py);
list.call_method(py, "append", (new_element,), None).unwrap();
assert_eq!(list.extract::<Vec<i32>>(py).unwrap(), vec![7, 6, 5, 4, 3, 1]);

pub fn call_method0(&self, name: &str) -> PyResult<&PyAny>

Calls a method on the object without arguments.

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

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

Calls a method on the object with only positional arguments.

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

pub fn is_true(&self) -> PyResult<bool>

Returns whether the object is considered to be true.

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

pub fn is_none(&self) -> bool

Returns whether the object is considered to be None.

This is equivalent to the Python expression self is None.

pub fn is_empty(&self) -> PyResult<bool>

Returns true if the sequence or mapping has a length of 0.

This is equivalent to the Python expression len(self) == 0.

pub fn get_item<K>(&self, key: K) -> PyResult<&PyAny> where
    K: ToBorrowedObject, 

Gets an item from the collection.

This is equivalent to the Python expression self[key].

pub fn set_item<K, V>(&self, key: K, value: V) -> PyResult<()> where
    K: ToBorrowedObject,
    V: ToBorrowedObject, 

Sets a collection item value.

This is equivalent to the Python expression self[key] = value.

pub fn del_item<K>(&self, key: K) -> PyResult<()> where
    K: ToBorrowedObject, 

Deletes an item from the collection.

This is equivalent to the Python expression del self[key].

pub fn iter(&self) -> PyResult<PyIterator<'_>>

Takes an object and returns an iterator for it.

This is typically a new iterator but if the argument is an iterator, this returns itself.

pub fn get_type(&self) -> &PyType

Returns the Python type object for this object's type.

pub fn get_type_ptr(&self) -> *mut PyTypeObject

Returns the Python type pointer for this object.

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

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<'a, D>(&'a self) -> PyResult<D> where
    D: FromPyObject<'a>, 

Extracts some type from the Python object.

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

pub fn get_refcnt(&self) -> isize

Returns the reference count for the Python object.

pub fn repr(&self) -> PyResult<&PyString>

Computes the "repr" representation of self.

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

pub fn str(&self) -> PyResult<&PyString>

Computes the "str" representation of self.

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

pub fn hash(&self) -> PyResult<isize>

Retrieves the hash code of self.

This is equivalent to the Python expression hash(obi).

pub fn len(&self) -> PyResult<usize>

Returns the length of the sequence or mapping.

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

pub fn dir(&self) -> &PyList

Returns the list of attributes of this object.

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

Trait Implementations

impl AsPyPointer for PyAny

fn as_ptr(&self) -> *mut PyObject

Retrieves the underlying FFI pointer (as a borrowed pointer).

impl<T: PyClass> AsRef<PyAny> for PyCell<T>

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyBool

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDict

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyFloat

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyList

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyModule

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyLong

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PySequence

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PySet

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyFrozenSet

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PySlice

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyString

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyByteArray

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyTuple

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyType

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyBytes

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyComplex

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDate

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDateTime

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyTime

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyTzInfo

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDelta

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyAny

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

Formats the value using the given formatter.

impl Display for PyAny

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

Formats the value using the given formatter.

impl<'a> From<&'a PyBool> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyByteArray> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyBytes> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyComplex> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyDate> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyDateTime> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyDelta> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyDict> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyFloat> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyFrozenSet> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyList> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyLong> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyModule> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PySet> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PySlice> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyString> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyTime> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyTuple> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyType> for &'a PyAny

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

Performs the conversion.

impl<'a> From<&'a PyTzInfo> for &'a PyAny

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

Performs the conversion.

impl<'py> FromPyObject<'py> for &'py PyAny

fn extract(obj: &'py PyAny) -> PyResult<Self>

Extracts Self from the source PyObject.

impl PartialEq<PyAny> for PyAny

fn eq(&self, o: &PyAny) -> 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 PyLayout<PyAny> for PyObject

const IS_NATIVE_TYPE: bool

fn get_super(&mut self) -> Option<&mut T::BaseLayout>

unsafe fn py_init(&mut self, _value: T)

unsafe fn py_drop(&mut self, _py: Python<'_>)

impl PyNativeType for PyAny

fn py(&self) -> Python<'_>

unsafe fn unchecked_downcast(obj: &PyAny) -> &Self

Cast &PyAny to &Self without no type checking.

impl PySizedLayout<PyAny> for PyObject

impl<U> PyTryInto<U> for PyAny where
    U: for<'v> PyTryFrom<'v>, 

fn try_into(&self) -> Result<&U, PyDowncastError>

Cast from PyObject to a concrete Python object type.

fn try_into_exact(&self) -> Result<&U, PyDowncastError>

Cast from PyObject to a concrete Python object type. With exact type check.

impl PyTypeInfo for PyAny

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyObject

Layout

type BaseLayout = PyObject

Layout of Basetype.

type Initializer = PyNativeTypeInitializer<Self>

Initializer for layout

type AsRefTarget = Self

Utility type to make AsPyRef work

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

fn type_object_raw(_py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl ToPyObject for PyAny

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

Converts self into a Python object.