Struct pyo3::PyAny

source · [−]

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

Expand description

Represents any Python object.

It currently only appears as a reference, &PyAny, with a lifetime that represents the scope during which the GIL is held.

PyAny has some interesting properties, which it shares with the other native Python types:

It can only be obtained and used while the GIL is held, therefore its API does not require a Python<'py> token.
It can’t be used in situations where the GIL is temporarily released, such as Python::allow_threads’s closure.
The underlying Python object, if mutable, can be mutated through any reference.
It can be converted to the GIL-independent Py<PyAny>, allowing it to outlive the GIL scope. However, using Py<PyAny>’s API does require a Python<'py> token.

It can be cast to a concrete type with PyAny::downcast (for native Python types only) and FromPyObject::extract. See their documentation for more information.

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

Implementations

source

impl PyAny

source

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

Converts this PyAny to a concrete Python type.

pub fn is<T: AsPyPointer>(&self, other: &T) -> bool

Returns whether self and other point to the same object. To compare the equality of two objects (the == operator), use eq.

This is equivalent to the Python expression self is other.

source

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

Determines whether this object has the given attribute.

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

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern attr_name.

source

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

Retrieves an attribute value.

This is equivalent to the Python expression self.attr_name.

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern attr_name.

Example: `intern!`ing the attribute name

#[pyfunction]
fn version(sys: &PyModule) -> PyResult<&PyAny> {
    sys.getattr(intern!(sys.py(), "version"))
}

source

pub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()> where
N: IntoPy<Py<PyString>>,
V: ToPyObject,

Sets an attribute value.

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

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Example: `intern!`ing the attribute name

#[pyfunction]
fn set_answer(ob: &PyAny) -> PyResult<()> {
    ob.setattr(intern!(ob.py(), "answer"), 42)
}

source

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

Deletes an attribute.

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

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern attr_name.

source

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

Returns an Ordering between self and other.

This is equivalent to the following Python code:

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,

Tests whether two Python objects obey a given CompareOp.

lt, le, eq, ne, gt and ge are the specialized versions of this function.

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

`compare_op`	Python expression
`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 lt<O>(&self, other: O) -> PyResult<bool> where
O: ToPyObject,

Tests whether this object is less than another.

This is equivalent to the Python expression self < other.

source

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

Tests whether this object is less than or equal to another.

This is equivalent to the Python expression self <= other.

source

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

Tests whether this object is equal to another.

This is equivalent to the Python expression self == other.

source

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

Tests whether this object is not equal to another.

This is equivalent to the Python expression self != other.

source

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

Tests whether this object is greater than another.

This is equivalent to the Python expression self > other.

source

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

Tests whether this object is greater than or equal to another.

This is equivalent to the Python expression self >= other.

source

pub fn is_callable(&self) -> bool

Determines whether this object appears callable.

This is equivalent to Python’s callable() function.

Examples

use pyo3::prelude::*;

Python::with_gil(|py| -> PyResult<()> {
    let builtins = PyModule::import(py, "builtins")?;
    let print = builtins.getattr("print")?;
    assert!(print.is_callable());
    Ok(())
})?;

This is equivalent to the Python statement assert callable(print).

Note that unless an API needs to distinguish between callable and non-callable objects, there is no point in checking for callability. Instead, it is better to just do the call and handle potential exceptions.

source

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).

Examples

use pyo3::prelude::*;
use pyo3::types::PyDict;

const CODE: &str = r#"
def function(*args, **kwargs):
    assert args == ("hello",)
    assert kwargs == {"cruel": "world"}
    return "called with args and kwargs"
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code(py, CODE, "", "")?;
    let fun = module.getattr("function")?;
    let args = ("hello",);
    let kwargs = PyDict::new(py);
    kwargs.set_item("cruel", "world")?;
    let result = fun.call(args, Some(kwargs))?;
    assert_eq!(result.extract::<&str>()?, "called with args and kwargs");
    Ok(())
})

source

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

Calls the object without arguments.

This is equivalent to the Python expression self().

Examples

use pyo3::prelude::*;

Python::with_gil(|py| -> PyResult<()> {
    let module = PyModule::import(py, "builtins")?;
    let help = module.getattr("help")?;
    help.call0()?;
    Ok(())
})?;

This is equivalent to the Python expression help().

source

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).

Examples

use pyo3::prelude::*;

const CODE: &str = r#"
def function(*args, **kwargs):
    assert args == ("hello",)
    assert kwargs == {}
    return "called with args"
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code(py, CODE, "", "")?;
    let fun = module.getattr("function")?;
    let args = ("hello",);
    let result = fun.call1(args)?;
    assert_eq!(result.extract::<&str>()?, "called with args");
    Ok(())
})

source

pub fn call_method<N, A>(
 &self,
 name: N,
 args: A,
 kwargs: Option<&PyDict>
) -> PyResult<&PyAny> where
 N: IntoPy<Py<PyString>>,
 A: IntoPy<Py<PyTuple>>,

Calls a method on the object.

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

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Examples

use pyo3::prelude::*;
use pyo3::types::PyDict;

const CODE: &str = r#"
class A:
    def method(self, *args, **kwargs):
        assert args == ("hello",)
        assert kwargs == {"cruel": "world"}
        return "called with args and kwargs"
a = A()
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code(py, CODE, "", "")?;
    let instance = module.getattr("a")?;
    let args = ("hello",);
    let kwargs = PyDict::new(py);
    kwargs.set_item("cruel", "world")?;
    let result = instance.call_method("method", args, Some(kwargs))?;
    assert_eq!(result.extract::<&str>()?, "called with args and kwargs");
    Ok(())
})

source

pub fn call_method0<N>(&self, name: N) -> PyResult<&PyAny> where
N: IntoPy<Py<PyString>>,

Calls a method on the object without arguments.

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

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Examples

use pyo3::prelude::*;

const CODE: &str = r#"
class A:
    def method(self, *args, **kwargs):
        assert args == ()
        assert kwargs == {}
        return "called with no arguments"
a = A()
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code(py, CODE, "", "")?;
    let instance = module.getattr("a")?;
    let result = instance.call_method0("method")?;
    assert_eq!(result.extract::<&str>()?, "called with no arguments");
    Ok(())
})

source

pub fn call_method1<N, A>(&self, name: N, args: A) -> PyResult<&PyAny> where
N: IntoPy<Py<PyString>>,
A: IntoPy<Py<PyTuple>>,

Calls a method on the object with only positional arguments.

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

To avoid repeated temporary allocations of Python strings, the intern! macro can be used to intern name.

Examples

use pyo3::prelude::*;

const CODE: &str = r#"
class A:
    def method(self, *args, **kwargs):
        assert args == ("hello",)
        assert kwargs == {}
        return "called with args"
a = A()
"#;

Python::with_gil(|py| {
    let module = PyModule::from_code(py, CODE, "", "")?;
    let instance = module.getattr("a")?;
    let args = ("hello",);
    let result = instance.call_method1("method", args)?;
    assert_eq!(result.extract::<&str>()?, "called with args");
    Ok(())
})

source

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).

source

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.

source

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.

source

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

Gets an item from the collection.

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

source

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

Sets a collection item value.

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

source

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

Deletes an item from the collection.

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

source

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.

source

pub fn get_type(&self) -> &PyType

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

source

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

Returns the Python type pointer for this object.

source

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

Casts self to a concrete Python object type.

This can cast only to native Python types, not types implemented in Rust.

source

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().

source

pub fn get_refcnt(&self) -> isize

Returns the reference count for the Python object.

source

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

Computes the “repr” representation of self.

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

source

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

Computes the “str” representation of self.

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

source

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

Retrieves the hash code of self.

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

source

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

Returns the length of the sequence or mapping.

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

source

pub fn dir(&self) -> &PyList

Returns the list of attributes of this object.

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

source

pub fn is_instance(&self, ty: &PyType) -> PyResult<bool>

Checks whether this object is an instance of type ty.

This is equivalent to the Python expression isinstance(self, ty).

source

pub fn is_instance_of<T: PyTypeInfo>(&self) -> PyResult<bool>

Checks whether this object is an instance of type T.

This is equivalent to the Python expression isinstance(self, T), if the type T is known at compile time.

source

pub fn contains<V>(&self, value: V) -> PyResult<bool> where
V: ToPyObject,

Determines if self contains value.

This is equivalent to the Python expression value in self.

source

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

Returns a GIL marker constrained to the lifetime of this type.

source

pub fn py_super(&self) -> PyResult<&PySuper>

Available on non-PyPy only.

Return a proxy object that delegates method calls to a parent or sibling class of type.

This is equivalent to the Python expression super()

Trait Implementations

source

impl AsPyPointer for PyAny

source

fn as_ptr(&self) -> *mut PyObject

Returns the underlying FFI pointer as a borrowed pointer.

source