[−][src]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[src]

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

Convert this PyAny to a concrete Python type.

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

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, [src]

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, [src]

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, [src]

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, [src]

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, [src]

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[src]

Determines whether this object is callable.

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

Calls the object.

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

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

Calls the object without arguments.

This is equivalent to the Python expression self().

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

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>[src]

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>[src]

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>[src]

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>[src]

Returns whether the object is considered to be true.

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

pub fn is_none(&self) -> bool[src]

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>[src]

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, [src]

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, [src]

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, [src]

Deletes an item from the collection.

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

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

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[src]

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

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

Returns the Python type pointer for this object.

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

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>, [src]

Extracts some type from the Python object.

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

pub fn get_refcnt(&self) -> isize[src]

Returns the reference count for the Python object.

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

Computes the "repr" representation of self.

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

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

Computes the "str" representation of self.

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

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

Retrieves the hash code of self.

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

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

Returns the length of the sequence or mapping.

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

pub fn dir(&self) -> &PyList[src]

Returns the list of attributes of this object.

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

Trait Implementations

impl AsPyPointer for PyAny[src]

impl AsRef<PyAny> for PyBaseException[src]

impl AsRef<PyAny> for PyException[src]

impl AsRef<PyAny> for PyEOFError[src]

impl AsRef<PyAny> for PyFloatingPointError[src]

impl AsRef<PyAny> for PyOSError[src]

impl AsRef<PyAny> for PyImportError[src]

impl AsRef<PyAny> for PyModuleNotFoundError[src]

impl AsRef<PyAny> for PyIndexError[src]

impl AsRef<PyAny> for PyKeyError[src]

impl AsRef<PyAny> for PyKeyboardInterrupt[src]

impl AsRef<PyAny> for PyMemoryError[src]

impl AsRef<PyAny> for PyNameError[src]

impl AsRef<PyAny> for PyStopAsyncIteration[src]

impl AsRef<PyAny> for PyOverflowError[src]

impl AsRef<PyAny> for PyRuntimeError[src]

impl AsRef<PyAny> for PyRecursionError[src]

impl AsRef<PyAny> for PyNotImplementedError[src]

impl AsRef<PyAny> for PySyntaxError[src]

impl AsRef<PyAny> for PyReferenceError[src]

impl AsRef<PyAny> for PySystemError[src]

impl AsRef<PyAny> for PySystemExit[src]

impl AsRef<PyAny> for PyTypeError[src]

impl AsRef<PyAny> for PyUnboundLocalError[src]

impl AsRef<PyAny> for PyStopIteration[src]

impl AsRef<PyAny> for PyUnicodeError[src]

impl AsRef<PyAny> for PyUnicodeDecodeError[src]

impl AsRef<PyAny> for PyUnicodeEncodeError[src]

impl AsRef<PyAny> for PyUnicodeTranslateError[src]

impl AsRef<PyAny> for PyValueError[src]

impl AsRef<PyAny> for PyZeroDivisionError[src]

impl AsRef<PyAny> for PyBlockingIOError[src]

impl AsRef<PyAny> for PyBrokenPipeError[src]

impl AsRef<PyAny> for PyChildProcessError[src]

impl AsRef<PyAny> for PyConnectionError[src]

impl AsRef<PyAny> for PyGeneratorExit[src]

impl AsRef<PyAny> for PyConnectionAbortedError[src]

impl AsRef<PyAny> for PyConnectionRefusedError[src]

impl AsRef<PyAny> for PyConnectionResetError[src]

impl AsRef<PyAny> for PyFileExistsError[src]

impl AsRef<PyAny> for PyFileNotFoundError[src]

impl AsRef<PyAny> for PyInterruptedError[src]

impl AsRef<PyAny> for PyIsADirectoryError[src]

impl AsRef<PyAny> for PyNotADirectoryError[src]

impl AsRef<PyAny> for PyPermissionError[src]

impl AsRef<PyAny> for PyProcessLookupError[src]

impl AsRef<PyAny> for PyArithmeticError[src]

impl AsRef<PyAny> for PyTimeoutError[src]

impl AsRef<PyAny> for PyEnvironmentError[src]

impl AsRef<PyAny> for PyIOError[src]

impl AsRef<PyAny> for CancelledError[src]

impl AsRef<PyAny> for InvalidStateError[src]

impl AsRef<PyAny> for TimeoutError[src]

impl AsRef<PyAny> for IncompleteReadError[src]

impl AsRef<PyAny> for LimitOverrunError[src]

impl AsRef<PyAny> for QueueEmpty[src]

impl AsRef<PyAny> for QueueFull[src]

impl AsRef<PyAny> for PyLookupError[src]

impl AsRef<PyAny> for herror[src]

impl AsRef<PyAny> for gaierror[src]

impl AsRef<PyAny> for timeout[src]

impl AsRef<PyAny> for PanicException[src]

impl<T: PyClass> AsRef<PyAny> for PyCell<T>[src]

impl AsRef<PyAny> for PyBool[src]

impl AsRef<PyAny> for PyByteArray[src]

impl AsRef<PyAny> for PyBytes[src]

impl AsRef<PyAny> for PyComplex[src]

impl AsRef<PyAny> for PyDate[src]

impl AsRef<PyAny> for PyAssertionError[src]

impl AsRef<PyAny> for PyDateTime[src]

impl AsRef<PyAny> for PyTime[src]

impl AsRef<PyAny> for PyTzInfo[src]

impl AsRef<PyAny> for PyDelta[src]

impl AsRef<PyAny> for PyDict[src]

impl AsRef<PyAny> for PyFloat[src]

impl AsRef<PyAny> for PyCFunction[src]

impl AsRef<PyAny> for PyFunction[src]

impl AsRef<PyAny> for PyList[src]

impl AsRef<PyAny> for PyModule[src]

impl AsRef<PyAny> for PyAttributeError[src]

impl AsRef<PyAny> for PyLong[src]

impl AsRef<PyAny> for PySequence[src]

impl AsRef<PyAny> for PySet[src]

impl AsRef<PyAny> for PyFrozenSet[src]

impl AsRef<PyAny> for PySlice[src]

impl AsRef<PyAny> for PyString[src]

impl AsRef<PyAny> for PyTuple[src]

impl AsRef<PyAny> for PyType[src]

impl AsRef<PyAny> for PyBufferError[src]

impl Debug for PyAny[src]

impl Display for PyAny[src]

impl<'a> From<&'a CancelledError> for &'a PyAny[src]

impl<'a> From<&'a IncompleteReadError> for &'a PyAny[src]

impl<'a> From<&'a InvalidStateError> for &'a PyAny[src]

impl<'a> From<&'a LimitOverrunError> for &'a PyAny[src]

impl<'a> From<&'a PanicException> for &'a PyAny[src]

impl<'a> From<&'a PyArithmeticError> for &'a PyAny[src]

impl<'a> From<&'a PyAssertionError> for &'a PyAny[src]

impl<'a> From<&'a PyAttributeError> for &'a PyAny[src]

impl<'a> From<&'a PyBaseException> for &'a PyAny[src]

impl<'a> From<&'a PyBlockingIOError> for &'a PyAny[src]

impl<'a> From<&'a PyBool> for &'a PyAny[src]

impl<'a> From<&'a PyBrokenPipeError> for &'a PyAny[src]

impl<'a> From<&'a PyBufferError> for &'a PyAny[src]

impl<'a> From<&'a PyByteArray> for &'a PyAny[src]

impl<'a> From<&'a PyBytes> for &'a PyAny[src]

impl<'a> From<&'a PyCFunction> for &'a PyAny[src]

impl<'a> From<&'a PyChildProcessError> for &'a PyAny[src]

impl<'a> From<&'a PyComplex> for &'a PyAny[src]

impl<'a> From<&'a PyConnectionAbortedError> for &'a PyAny[src]

impl<'a> From<&'a PyConnectionError> for &'a PyAny[src]

impl<'a> From<&'a PyConnectionRefusedError> for &'a PyAny[src]

impl<'a> From<&'a PyConnectionResetError> for &'a PyAny[src]

impl<'a> From<&'a PyDate> for &'a PyAny[src]

impl<'a> From<&'a PyDateTime> for &'a PyAny[src]

impl<'a> From<&'a PyDelta> for &'a PyAny[src]

impl<'a> From<&'a PyDict> for &'a PyAny[src]

impl<'a> From<&'a PyEOFError> for &'a PyAny[src]

impl<'a> From<&'a PyEnvironmentError> for &'a PyAny[src]

impl<'a> From<&'a PyException> for &'a PyAny[src]

impl<'a> From<&'a PyFileExistsError> for &'a PyAny[src]

impl<'a> From<&'a PyFileNotFoundError> for &'a PyAny[src]

impl<'a> From<&'a PyFloat> for &'a PyAny[src]

impl<'a> From<&'a PyFloatingPointError> for &'a PyAny[src]

impl<'a> From<&'a PyFrozenSet> for &'a PyAny[src]

impl<'a> From<&'a PyFunction> for &'a PyAny[src]

impl<'a> From<&'a PyGeneratorExit> for &'a PyAny[src]

impl<'a> From<&'a PyIOError> for &'a PyAny[src]

impl<'a> From<&'a PyImportError> for &'a PyAny[src]

impl<'a> From<&'a PyIndexError> for &'a PyAny[src]

impl<'a> From<&'a PyInterruptedError> for &'a PyAny[src]

impl<'a> From<&'a PyIsADirectoryError> for &'a PyAny[src]

impl<'a> From<&'a PyKeyError> for &'a PyAny[src]

impl<'a> From<&'a PyKeyboardInterrupt> for &'a PyAny[src]

impl<'a> From<&'a PyList> for &'a PyAny[src]

impl<'a> From<&'a PyLong> for &'a PyAny[src]

impl<'a> From<&'a PyLookupError> for &'a PyAny[src]

impl<'a> From<&'a PyMemoryError> for &'a PyAny[src]

impl<'a> From<&'a PyModule> for &'a PyAny[src]

impl<'a> From<&'a PyModuleNotFoundError> for &'a PyAny[src]

impl<'a> From<&'a PyNameError> for &'a PyAny[src]

impl<'a> From<&'a PyNotADirectoryError> for &'a PyAny[src]

impl<'a> From<&'a PyNotImplementedError> for &'a PyAny[src]

impl<'a> From<&'a PyOSError> for &'a PyAny[src]

impl<'a> From<&'a PyOverflowError> for &'a PyAny[src]

impl<'a> From<&'a PyPermissionError> for &'a PyAny[src]

impl<'a> From<&'a PyProcessLookupError> for &'a PyAny[src]

impl<'a> From<&'a PyRecursionError> for &'a PyAny[src]

impl<'a> From<&'a PyReferenceError> for &'a PyAny[src]

impl<'a> From<&'a PyRuntimeError> for &'a PyAny[src]

impl<'a> From<&'a PySet> for &'a PyAny[src]

impl<'a> From<&'a PySlice> for &'a PyAny[src]

impl<'a> From<&'a PyStopAsyncIteration> for &'a PyAny[src]

impl<'a> From<&'a PyStopIteration> for &'a PyAny[src]

impl<'a> From<&'a PyString> for &'a PyAny[src]

impl<'a> From<&'a PySyntaxError> for &'a PyAny[src]

impl<'a> From<&'a PySystemError> for &'a PyAny[src]

impl<'a> From<&'a PySystemExit> for &'a PyAny[src]

impl<'a> From<&'a PyTime> for &'a PyAny[src]

impl<'a> From<&'a PyTimeoutError> for &'a PyAny[src]

impl<'a> From<&'a PyTuple> for &'a PyAny[src]

impl<'a> From<&'a PyType> for &'a PyAny[src]

impl<'a> From<&'a PyTypeError> for &'a PyAny[src]

impl<'a> From<&'a PyTzInfo> for &'a PyAny[src]

impl<'a> From<&'a PyUnboundLocalError> for &'a PyAny[src]

impl<'a> From<&'a PyUnicodeDecodeError> for &'a PyAny[src]

impl<'a> From<&'a PyUnicodeEncodeError> for &'a PyAny[src]

impl<'a> From<&'a PyUnicodeError> for &'a PyAny[src]

impl<'a> From<&'a PyUnicodeTranslateError> for &'a PyAny[src]

impl<'a> From<&'a PyValueError> for &'a PyAny[src]

impl<'a> From<&'a PyZeroDivisionError> for &'a PyAny[src]

impl<'a> From<&'a QueueEmpty> for &'a PyAny[src]

impl<'a> From<&'a QueueFull> for &'a PyAny[src]

impl<'a> From<&'a TimeoutError> for &'a PyAny[src]

impl<'a> From<&'a gaierror> for &'a PyAny[src]

impl<'a> From<&'a herror> for &'a PyAny[src]

impl<'a> From<&'a timeout> for &'a PyAny[src]

impl<'py> FromPyObject<'py> for &'py PyAny[src]

impl PartialEq<PyAny> for PyAny[src]

impl PyLayout<PyAny> for PyObject[src]

impl PyNativeType for PyAny[src]

impl PySizedLayout<PyAny> for PyObject[src]

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

impl PyTypeInfo for PyAny[src]

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 Py::as_ref work

impl ToPyObject for PyAny[src]

Auto Trait Implementations

impl !RefUnwindSafe for PyAny

impl !Send for PyAny

impl !Sync for PyAny

impl Unpin for PyAny

impl UnwindSafe for PyAny

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<'p, T> FromPyPointer<'p> for T where
    T: 'p + PyNativeType, [src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<'v, T> PyTryFrom<'v> for T where
    T: PyTypeInfo + PyNativeType, [src]

impl<T> PyTypeObject for T where
    T: PyTypeInfo, [src]

impl<T> ToBorrowedObject for T where
    T: ToPyObject, [src]

impl<T> ToString for T where
    T: Display + ?Sized, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.