pub struct PyTuple(/* private fields */);
Expand description
Represents a Python tuple
object.
Values of this type are accessed via PyO3’s smart pointers, e.g. as
Py<PyTuple>
or Bound<'py, PyTuple>
.
For APIs available on tuple
objects, see the PyTupleMethods
trait which is implemented for
Bound<'py, PyTuple>
.
Implementations§
Source§impl PyTuple
impl PyTuple
Sourcepub fn new_bound<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> Bound<'_, PyTuple>where
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
pub fn new_bound<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> Bound<'_, PyTuple>where
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
Constructs a new tuple with the given elements.
If you want to create a PyTuple
with elements of different or unknown types, or from an
iterable that doesn’t implement ExactSizeIterator
, create a Rust tuple with the given
elements and convert it at once using into_py
.
§Examples
use pyo3::prelude::*;
use pyo3::types::PyTuple;
Python::with_gil(|py| {
let elements: Vec<i32> = vec![0, 1, 2, 3, 4, 5];
let tuple = PyTuple::new_bound(py, elements);
assert_eq!(format!("{:?}", tuple), "(0, 1, 2, 3, 4, 5)");
});
§Panics
This function will panic if element
’s ExactSizeIterator
implementation is incorrect.
All standard library structures implement this trait correctly, if they do, so calling this
function using Vec
<T>
or &[T]
will always succeed.
Sourcepub fn empty_bound(py: Python<'_>) -> Bound<'_, PyTuple>
pub fn empty_bound(py: Python<'_>) -> Bound<'_, PyTuple>
Constructs an empty tuple (on the Python side, a singleton object).
Source§impl PyTuple
impl PyTuple
Sourcepub fn new<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> &PyTuplewhere
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
👎Deprecated since 0.21.0: PyTuple::new
will be replaced by PyTuple::new_bound
in a future PyO3 versionAvailable on crate feature gil-refs
only.
pub fn new<T, U>(
py: Python<'_>,
elements: impl IntoIterator<Item = T, IntoIter = U>,
) -> &PyTuplewhere
T: ToPyObject,
U: ExactSizeIterator<Item = T>,
PyTuple::new
will be replaced by PyTuple::new_bound
in a future PyO3 versiongil-refs
only.Deprecated form of PyTuple::new_bound
.
Sourcepub fn empty(py: Python<'_>) -> &PyTuple
👎Deprecated since 0.21.0: PyTuple::empty
will be replaced by PyTuple::empty_bound
in a future PyO3 versionAvailable on crate feature gil-refs
only.
pub fn empty(py: Python<'_>) -> &PyTuple
PyTuple::empty
will be replaced by PyTuple::empty_bound
in a future PyO3 versiongil-refs
only.Deprecated form of PyTuple::empty_bound
.
Sourcepub fn len(&self) -> usize
Available on crate feature gil-refs
only.
pub fn len(&self) -> usize
gil-refs
only.Gets the length of the tuple.
Sourcepub fn is_empty(&self) -> bool
Available on crate feature gil-refs
only.
pub fn is_empty(&self) -> bool
gil-refs
only.Checks if the tuple is empty.
Sourcepub fn as_sequence(&self) -> &PySequence
Available on crate feature gil-refs
only.
pub fn as_sequence(&self) -> &PySequence
gil-refs
only.Returns self
cast as a PySequence
.
Sourcepub fn get_slice(&self, low: usize, high: usize) -> &PyTuple
Available on crate feature gil-refs
only.
pub fn get_slice(&self, low: usize, high: usize) -> &PyTuple
gil-refs
only.Takes the slice self[low:high]
and returns it as a new tuple.
Indices must be nonnegative, and out-of-range indices are clipped to
self.len()
.
Sourcepub fn get_item(&self, index: usize) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn get_item(&self, index: usize) -> PyResult<&PyAny>
gil-refs
only.Gets the tuple item at the specified index.
§Example
use pyo3::{prelude::*, types::PyTuple};
Python::with_gil(|py| -> PyResult<()> {
let ob = (1, 2, 3).to_object(py);
let tuple = ob.downcast_bound::<PyTuple>(py).unwrap();
let obj = tuple.get_item(0);
assert_eq!(obj.unwrap().extract::<i32>().unwrap(), 1);
Ok(())
})
Sourcepub unsafe fn get_item_unchecked(&self, index: usize) -> &PyAny
Available on crate feature gil-refs
and neither Py_LIMITED_API
nor PyPy
nor GraalPy
only.
pub unsafe fn get_item_unchecked(&self, index: usize) -> &PyAny
gil-refs
and neither Py_LIMITED_API
nor PyPy
nor GraalPy
only.Gets the tuple item at the specified index. Undefined behavior on bad index. Use with caution.
§Safety
Caller must verify that the index is within the bounds of the tuple.
Sourcepub fn as_slice(&self) -> &[&PyAny]
Available on crate feature gil-refs
and neither Py_LIMITED_API
nor GraalPy
only.
pub fn as_slice(&self) -> &[&PyAny]
gil-refs
and neither Py_LIMITED_API
nor GraalPy
only.Returns self
as a slice of objects.
Sourcepub fn contains<V>(&self, value: V) -> PyResult<bool>where
V: ToPyObject,
Available on crate feature gil-refs
only.
pub fn contains<V>(&self, value: V) -> PyResult<bool>where
V: ToPyObject,
gil-refs
only.Determines if self contains value
.
This is equivalent to the Python expression value in self
.
Sourcepub fn index<V>(&self, value: V) -> PyResult<usize>where
V: ToPyObject,
Available on crate feature gil-refs
only.
pub fn index<V>(&self, value: V) -> PyResult<usize>where
V: ToPyObject,
gil-refs
only.Returns the first index i
for which self[i] == value
.
This is equivalent to the Python expression self.index(value)
.
Sourcepub fn iter(&self) -> PyTupleIterator<'_> ⓘ
Available on crate feature gil-refs
only.
pub fn iter(&self) -> PyTupleIterator<'_> ⓘ
gil-refs
only.Returns an iterator over the tuple items.
Methods from Deref<Target = PyAny>§
Sourcepub fn is<T: AsPyPointer>(&self, other: &T) -> bool
Available on crate feature gil-refs
only.
pub fn is<T: AsPyPointer>(&self, other: &T) -> bool
gil-refs
only.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
.
Sourcepub fn hasattr<N>(&self, attr_name: N) -> PyResult<bool>
Available on crate feature gil-refs
only.
pub fn hasattr<N>(&self, attr_name: N) -> PyResult<bool>
gil-refs
only.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
.
§Example: intern!
ing the attribute name
#[pyfunction]
fn has_version(sys: &Bound<'_, PyModule>) -> PyResult<bool> {
sys.hasattr(intern!(sys.py(), "version"))
}
Sourcepub fn getattr<N>(&self, attr_name: N) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn getattr<N>(&self, attr_name: N) -> PyResult<&PyAny>
gil-refs
only.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<'py>(sys: &Bound<'py, PyModule>) -> PyResult<Bound<'py, PyAny>> {
sys.getattr(intern!(sys.py(), "version"))
}
Sourcepub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()>
Available on crate feature gil-refs
only.
pub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()>
gil-refs
only.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: &Bound<'_, PyAny>) -> PyResult<()> {
ob.setattr(intern!(ob.py(), "answer"), 42)
}
Sourcepub fn delattr<N>(&self, attr_name: N) -> PyResult<()>
Available on crate feature gil-refs
only.
pub fn delattr<N>(&self, attr_name: N) -> PyResult<()>
gil-refs
only.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
.
Sourcepub fn compare<O>(&self, other: O) -> PyResult<Ordering>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn compare<O>(&self, other: O) -> PyResult<Ordering>where
O: ToPyObject,
gil-refs
only.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")
§Examples
use pyo3::prelude::*;
use pyo3::types::PyFloat;
use std::cmp::Ordering;
Python::with_gil(|py| -> PyResult<()> {
let a = PyFloat::new_bound(py, 0_f64);
let b = PyFloat::new_bound(py, 42_f64);
assert_eq!(a.compare(b)?, Ordering::Less);
Ok(())
})?;
It will return PyErr
for values that cannot be compared:
use pyo3::prelude::*;
use pyo3::types::{PyFloat, PyString};
Python::with_gil(|py| -> PyResult<()> {
let a = PyFloat::new_bound(py, 0_f64);
let b = PyString::new_bound(py, "zero");
assert!(a.compare(b).is_err());
Ok(())
})?;
Sourcepub fn rich_compare<O>(
&self,
other: O,
compare_op: CompareOp,
) -> PyResult<&PyAny>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn rich_compare<O>(
&self,
other: O,
compare_op: CompareOp,
) -> PyResult<&PyAny>where
O: ToPyObject,
gil-refs
only.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 |
§Examples
use pyo3::class::basic::CompareOp;
use pyo3::prelude::*;
use pyo3::types::PyInt;
Python::with_gil(|py| -> PyResult<()> {
let a: Bound<'_, PyInt> = 0_u8.into_py(py).into_bound(py).downcast_into()?;
let b: Bound<'_, PyInt> = 42_u8.into_py(py).into_bound(py).downcast_into()?;
assert!(a.rich_compare(b, CompareOp::Le)?.is_truthy()?);
Ok(())
})?;
Sourcepub fn lt<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn lt<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
gil-refs
only.Tests whether this object is less than another.
This is equivalent to the Python expression self < other
.
Sourcepub fn le<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn le<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
gil-refs
only.Tests whether this object is less than or equal to another.
This is equivalent to the Python expression self <= other
.
Sourcepub fn eq<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn eq<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
gil-refs
only.Tests whether this object is equal to another.
This is equivalent to the Python expression self == other
.
Sourcepub fn ne<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn ne<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
gil-refs
only.Tests whether this object is not equal to another.
This is equivalent to the Python expression self != other
.
Sourcepub fn gt<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn gt<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
gil-refs
only.Tests whether this object is greater than another.
This is equivalent to the Python expression self > other
.
Sourcepub fn ge<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
Available on crate feature gil-refs
only.
pub fn ge<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
gil-refs
only.Tests whether this object is greater than or equal to another.
This is equivalent to the Python expression self >= other
.
Sourcepub fn is_callable(&self) -> bool
Available on crate feature gil-refs
only.
pub fn is_callable(&self) -> bool
gil-refs
only.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_bound(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.
Sourcepub fn call(
&self,
args: impl IntoPy<Py<PyTuple>>,
kwargs: Option<&PyDict>,
) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn call( &self, args: impl IntoPy<Py<PyTuple>>, kwargs: Option<&PyDict>, ) -> PyResult<&PyAny>
gil-refs
only.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_bound(py, CODE, "", "")?;
let fun = module.getattr("function")?;
let args = ("hello",);
let kwargs = PyDict::new_bound(py);
kwargs.set_item("cruel", "world")?;
let result = fun.call(args, Some(&kwargs))?;
assert_eq!(result.extract::<String>()?, "called with args and kwargs");
Ok(())
})
Sourcepub fn call0(&self) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn call0(&self) -> PyResult<&PyAny>
gil-refs
only.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_bound(py, "builtins")?;
let help = module.getattr("help")?;
help.call0()?;
Ok(())
})?;
This is equivalent to the Python expression help()
.
Sourcepub fn call1(&self, args: impl IntoPy<Py<PyTuple>>) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn call1(&self, args: impl IntoPy<Py<PyTuple>>) -> PyResult<&PyAny>
gil-refs
only.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_bound(py, CODE, "", "")?;
let fun = module.getattr("function")?;
let args = ("hello",);
let result = fun.call1(args)?;
assert_eq!(result.extract::<String>()?, "called with args");
Ok(())
})
Sourcepub fn call_method<N, A>(
&self,
name: N,
args: A,
kwargs: Option<&PyDict>,
) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn call_method<N, A>( &self, name: N, args: A, kwargs: Option<&PyDict>, ) -> PyResult<&PyAny>
gil-refs
only.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_bound(py, CODE, "", "")?;
let instance = module.getattr("a")?;
let args = ("hello",);
let kwargs = PyDict::new_bound(py);
kwargs.set_item("cruel", "world")?;
let result = instance.call_method("method", args, Some(&kwargs))?;
assert_eq!(result.extract::<String>()?, "called with args and kwargs");
Ok(())
})
Sourcepub fn call_method0<N>(&self, name: N) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn call_method0<N>(&self, name: N) -> PyResult<&PyAny>
gil-refs
only.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_bound(py, CODE, "", "")?;
let instance = module.getattr("a")?;
let result = instance.call_method0("method")?;
assert_eq!(result.extract::<String>()?, "called with no arguments");
Ok(())
})
Sourcepub fn call_method1<N, A>(&self, name: N, args: A) -> PyResult<&PyAny>
Available on crate feature gil-refs
only.
pub fn call_method1<N, A>(&self, name: N, args: A) -> PyResult<&PyAny>
gil-refs
only.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_bound(py, CODE, "", "")?;
let instance = module.getattr("a")?;
let args = ("hello",);
let result = instance.call_method1("method", args)?;
assert_eq!(result.extract::<String>()?, "called with args");
Ok(())
})
Sourcepub fn is_true(&self) -> PyResult<bool>
👎Deprecated since 0.21.0: use .is_truthy()
insteadAvailable on crate feature gil-refs
only.
pub fn is_true(&self) -> PyResult<bool>
.is_truthy()
insteadgil-refs
only.Returns whether the object is considered to be true.
This is equivalent to the Python expression bool(self)
.
Sourcepub fn is_truthy(&self) -> PyResult<bool>
Available on crate feature gil-refs
only.
pub fn is_truthy(&self) -> PyResult<bool>
gil-refs
only.Returns whether the object is considered to be true.
This applies truth value testing equivalent to the Python expression bool(self)
.
Sourcepub fn is_none(&self) -> bool
Available on crate feature gil-refs
only.
pub fn is_none(&self) -> bool
gil-refs
only.Returns whether the object is considered to be None.
This is equivalent to the Python expression self is None
.
Sourcepub fn is_ellipsis(&self) -> bool
👎Deprecated since 0.20.0: use .is(py.Ellipsis())
insteadAvailable on crate feature gil-refs
only.
pub fn is_ellipsis(&self) -> bool
.is(py.Ellipsis())
insteadgil-refs
only.Returns whether the object is Ellipsis, e.g. ...
.
This is equivalent to the Python expression self is ...
.
Sourcepub fn is_empty(&self) -> PyResult<bool>
Available on crate feature gil-refs
only.
pub fn is_empty(&self) -> PyResult<bool>
gil-refs
only.Returns true if the sequence or mapping has a length of 0.
This is equivalent to the Python expression len(self) == 0
.
Sourcepub fn get_item<K>(&self, key: K) -> PyResult<&PyAny>where
K: ToPyObject,
Available on crate feature gil-refs
only.
pub fn get_item<K>(&self, key: K) -> PyResult<&PyAny>where
K: ToPyObject,
gil-refs
only.Gets an item from the collection.
This is equivalent to the Python expression self[key]
.
Sourcepub fn set_item<K, V>(&self, key: K, value: V) -> PyResult<()>where
K: ToPyObject,
V: ToPyObject,
Available on crate feature gil-refs
only.
pub fn set_item<K, V>(&self, key: K, value: V) -> PyResult<()>where
K: ToPyObject,
V: ToPyObject,
gil-refs
only.Sets a collection item value.
This is equivalent to the Python expression self[key] = value
.
Sourcepub fn del_item<K>(&self, key: K) -> PyResult<()>where
K: ToPyObject,
Available on crate feature gil-refs
only.
pub fn del_item<K>(&self, key: K) -> PyResult<()>where
K: ToPyObject,
gil-refs
only.Deletes an item from the collection.
This is equivalent to the Python expression del self[key]
.
Sourcepub fn iter(&self) -> PyResult<&PyIterator>
Available on crate feature gil-refs
only.
pub fn iter(&self) -> PyResult<&PyIterator>
gil-refs
only.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.
Sourcepub fn get_type(&self) -> &PyType
Available on crate feature gil-refs
only.
pub fn get_type(&self) -> &PyType
gil-refs
only.Returns the Python type object for this object’s type.
Sourcepub fn get_type_ptr(&self) -> *mut PyTypeObject
Available on crate feature gil-refs
only.
pub fn get_type_ptr(&self) -> *mut PyTypeObject
gil-refs
only.Returns the Python type pointer for this object.
Sourcepub fn downcast<T>(&self) -> Result<&T, PyDowncastError<'_>>where
T: PyTypeCheck<AsRefTarget = T>,
Available on crate feature gil-refs
only.
pub fn downcast<T>(&self) -> Result<&T, PyDowncastError<'_>>where
T: PyTypeCheck<AsRefTarget = T>,
gil-refs
only.Downcast this PyAny
to a concrete Python type or pyclass.
Note that you can often avoid downcasting yourself by just specifying the desired type in function or method signatures. However, manual downcasting is sometimes necessary.
For extracting a Rust-only type, see PyAny::extract
.
§Example: Downcasting to a specific Python object
use pyo3::prelude::*;
use pyo3::types::{PyDict, PyList};
Python::with_gil(|py| {
let dict = PyDict::new_bound(py);
assert!(dict.is_instance_of::<PyAny>());
let any = dict.as_any();
assert!(any.downcast::<PyDict>().is_ok());
assert!(any.downcast::<PyList>().is_err());
});
§Example: Getting a reference to a pyclass
This is useful if you want to mutate a PyObject
that
might actually be a pyclass.
use pyo3::prelude::*;
#[pyclass]
struct Class {
i: i32,
}
Python::with_gil(|py| {
let class = Py::new(py, Class { i: 0 }).unwrap().into_bound(py).into_any();
let class_bound: &Bound<'_, Class> = class.downcast()?;
class_bound.borrow_mut().i += 1;
// Alternatively you can get a `PyRefMut` directly
let class_ref: PyRefMut<'_, Class> = class.extract()?;
assert_eq!(class_ref.i, 1);
Ok(())
})
Sourcepub fn downcast_exact<T>(&self) -> Result<&T, PyDowncastError<'_>>where
T: PyTypeInfo<AsRefTarget = T>,
Available on crate feature gil-refs
only.
pub fn downcast_exact<T>(&self) -> Result<&T, PyDowncastError<'_>>where
T: PyTypeInfo<AsRefTarget = T>,
gil-refs
only.Downcast this PyAny
to a concrete Python type or pyclass (but not a subclass of it).
It is almost always better to use PyAny::downcast
because it accounts for Python
subtyping. Use this method only when you do not want to allow subtypes.
The advantage of this method over PyAny::downcast
is that it is faster. The implementation
of downcast_exact
uses the equivalent of the Python expression type(self) is T
, whereas
downcast
uses isinstance(self, T)
.
For extracting a Rust-only type, see PyAny::extract
.
§Example: Downcasting to a specific Python object but not a subtype
use pyo3::prelude::*;
use pyo3::types::{PyBool, PyLong};
Python::with_gil(|py| {
let b = PyBool::new_bound(py, true);
assert!(b.is_instance_of::<PyBool>());
let any: &Bound<'_, PyAny> = b.as_any();
// `bool` is a subtype of `int`, so `downcast` will accept a `bool` as an `int`
// but `downcast_exact` will not.
assert!(any.downcast::<PyLong>().is_ok());
assert!(any.downcast_exact::<PyLong>().is_err());
assert!(any.downcast_exact::<PyBool>().is_ok());
});
Sourcepub unsafe fn downcast_unchecked<T>(&self) -> &Twhere
T: HasPyGilRef<AsRefTarget = T>,
Available on crate feature gil-refs
only.
pub unsafe fn downcast_unchecked<T>(&self) -> &Twhere
T: HasPyGilRef<AsRefTarget = T>,
gil-refs
only.Converts this PyAny
to a concrete Python type without checking validity.
§Safety
Callers must ensure that the type is valid or risk type confusion.
Sourcepub fn extract<'py, D>(&'py self) -> PyResult<D>where
D: FromPyObjectBound<'py, 'py>,
Available on crate feature gil-refs
only.
pub fn extract<'py, D>(&'py self) -> PyResult<D>where
D: FromPyObjectBound<'py, 'py>,
gil-refs
only.Extracts some type from the Python object.
This is a wrapper function around
FromPyObject::extract()
.
Sourcepub fn get_refcnt(&self) -> isize
Available on crate feature gil-refs
only.
pub fn get_refcnt(&self) -> isize
gil-refs
only.Returns the reference count for the Python object.
Sourcepub fn repr(&self) -> PyResult<&PyString>
Available on crate feature gil-refs
only.
pub fn repr(&self) -> PyResult<&PyString>
gil-refs
only.Computes the “repr” representation of self.
This is equivalent to the Python expression repr(self)
.
Sourcepub fn str(&self) -> PyResult<&PyString>
Available on crate feature gil-refs
only.
pub fn str(&self) -> PyResult<&PyString>
gil-refs
only.Computes the “str” representation of self.
This is equivalent to the Python expression str(self)
.
Sourcepub fn hash(&self) -> PyResult<isize>
Available on crate feature gil-refs
only.
pub fn hash(&self) -> PyResult<isize>
gil-refs
only.Retrieves the hash code of self.
This is equivalent to the Python expression hash(self)
.
Sourcepub fn len(&self) -> PyResult<usize>
Available on crate feature gil-refs
only.
pub fn len(&self) -> PyResult<usize>
gil-refs
only.Returns the length of the sequence or mapping.
This is equivalent to the Python expression len(self)
.
Sourcepub fn dir(&self) -> PyResult<&PyList>
Available on crate feature gil-refs
only.
pub fn dir(&self) -> PyResult<&PyList>
gil-refs
only.Returns the list of attributes of this object.
This is equivalent to the Python expression dir(self)
.
Sourcepub fn is_instance(&self, ty: &PyAny) -> PyResult<bool>
Available on crate feature gil-refs
only.
pub fn is_instance(&self, ty: &PyAny) -> PyResult<bool>
gil-refs
only.Checks whether this object is an instance of type ty
.
This is equivalent to the Python expression isinstance(self, ty)
.
Sourcepub fn is_exact_instance(&self, ty: &PyAny) -> bool
Available on crate feature gil-refs
only.
pub fn is_exact_instance(&self, ty: &PyAny) -> bool
gil-refs
only.Checks whether this object is an instance of exactly type ty
(not a subclass).
This is equivalent to the Python expression type(self) is ty
.
Sourcepub fn is_instance_of<T: PyTypeInfo>(&self) -> bool
Available on crate feature gil-refs
only.
pub fn is_instance_of<T: PyTypeInfo>(&self) -> bool
gil-refs
only.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.
Sourcepub fn is_exact_instance_of<T: PyTypeInfo>(&self) -> bool
Available on crate feature gil-refs
only.
pub fn is_exact_instance_of<T: PyTypeInfo>(&self) -> bool
gil-refs
only.Checks whether this object is an instance of exactly type T
.
This is equivalent to the Python expression type(self) is T
,
if the type T
is known at compile time.
Sourcepub fn contains<V>(&self, value: V) -> PyResult<bool>where
V: ToPyObject,
Available on crate feature gil-refs
only.
pub fn contains<V>(&self, value: V) -> PyResult<bool>where
V: ToPyObject,
gil-refs
only.Determines if self contains value
.
This is equivalent to the Python expression value in self
.
Sourcepub fn py(&self) -> Python<'_>
Available on crate feature gil-refs
only.
pub fn py(&self) -> Python<'_>
gil-refs
only.Returns a GIL marker constrained to the lifetime of this type.
Sourcepub fn as_ptr(&self) -> *mut PyObject
Available on crate feature gil-refs
only.
pub fn as_ptr(&self) -> *mut PyObject
gil-refs
only.Returns the raw FFI pointer represented by self.
§Safety
Callers are responsible for ensuring that the pointer does not outlive self.
The reference is borrowed; callers should not decrease the reference count when they are finished with the pointer.
Sourcepub fn into_ptr(&self) -> *mut PyObject
Available on crate feature gil-refs
only.
pub fn into_ptr(&self) -> *mut PyObject
gil-refs
only.Returns an owned raw FFI pointer represented by self.
§Safety
The reference is owned; when finished the caller should either transfer ownership
of the pointer or decrease the reference count (e.g. with pyo3::ffi::Py_DecRef
).
Trait Implementations§
Source§impl AsPyPointer for PyTuple
impl AsPyPointer for PyTuple
Source§impl<'py> FromPyObject<'py> for &'py PyTuple
impl<'py> FromPyObject<'py> for &'py PyTuple
Source§fn type_input() -> TypeInfo
fn type_input() -> TypeInfo
experimental-inspect
only.Source§impl<'a> IntoIterator for &'a PyTuple
Available on crate feature gil-refs
only.
impl<'a> IntoIterator for &'a PyTuple
gil-refs
only.Source§impl PyNativeType for PyTuple
impl PyNativeType for PyTuple
Source§type AsRefSource = PyTuple
type AsRefSource = PyTuple
gil-refs
only.Py<T>
smart pointer.Source§fn as_borrowed(&self) -> Borrowed<'_, '_, Self::AsRefSource>
fn as_borrowed(&self) -> Borrowed<'_, '_, Self::AsRefSource>
gil-refs
only.Source§fn py(&self) -> Python<'_>
fn py(&self) -> Python<'_>
gil-refs
only.Source§unsafe fn unchecked_downcast(obj: &PyAny) -> &Self
unsafe fn unchecked_downcast(obj: &PyAny) -> &Self
gil-refs
only.Source§impl PyTypeInfo for PyTuple
impl PyTypeInfo for PyTuple
Source§const MODULE: Option<&'static str> = _
const MODULE: Option<&'static str> = _
gil-refs
only.Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
gil-refs
only.Source§fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
gil-refs
only.object
is an instance of this type or a subclass of this type.Source§fn type_object(py: Python<'_>) -> &PyType
fn type_object(py: Python<'_>) -> &PyType
PyTypeInfo::type_object
will be replaced by PyTypeInfo::type_object_bound
in a future PyO3 versiongil-refs
only.Source§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
gil-refs
only.Source§fn is_type_of(object: &PyAny) -> bool
fn is_type_of(object: &PyAny) -> bool
PyTypeInfo::is_type_of
will be replaced by PyTypeInfo::is_type_of_bound
in a future PyO3 versiongil-refs
only.object
is an instance of this type or a subclass of this type.Source§fn is_exact_type_of(object: &PyAny) -> bool
fn is_exact_type_of(object: &PyAny) -> bool
PyTypeInfo::is_exact_type_of
will be replaced by PyTypeInfo::is_exact_type_of_bound
in a future PyO3 versiongil-refs
only.object
is an instance of this type.Source§impl ToPyObject for PyTuple
impl ToPyObject for PyTuple
impl DerefToPyAny for PyTuple
Auto Trait Implementations§
impl !Freeze for PyTuple
impl !RefUnwindSafe for PyTuple
impl !Send for PyTuple
impl !Sync for PyTuple
impl Unpin for PyTuple
impl UnwindSafe for PyTuple
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<'p, T> FromPyPointer<'p> for Twhere
T: 'p + PyNativeType,
impl<'p, T> FromPyPointer<'p> for Twhere
T: 'p + PyNativeType,
Source§unsafe fn from_owned_ptr_or_opt(
py: Python<'p>,
ptr: *mut PyObject,
) -> Option<&'p T>
unsafe fn from_owned_ptr_or_opt( py: Python<'p>, ptr: *mut PyObject, ) -> Option<&'p T>
Py::from_owned_ptr_or_opt(py, ptr)
or Bound::from_owned_ptr_or_opt(py, ptr)
insteadgil-refs
only.PyObject
. Read moreSource§unsafe fn from_borrowed_ptr_or_opt(
_py: Python<'p>,
ptr: *mut PyObject,
) -> Option<&'p T>
unsafe fn from_borrowed_ptr_or_opt( _py: Python<'p>, ptr: *mut PyObject, ) -> Option<&'p T>
Py::from_borrowed_ptr_or_opt(py, ptr)
or Bound::from_borrowed_ptr_or_opt(py, ptr)
insteadgil-refs
only.PyObject
. Read moreSource§unsafe fn from_owned_ptr_or_panic(
py: Python<'p>,
ptr: *mut PyObject,
) -> &'p Self
unsafe fn from_owned_ptr_or_panic( py: Python<'p>, ptr: *mut PyObject, ) -> &'p Self
Py::from_owned_ptr(py, ptr)
or Bound::from_owned_ptr(py, ptr)
insteadgil-refs
only.PyObject
or panic. Read moreSource§unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
Py::from_owned_ptr(py, ptr)
or Bound::from_owned_ptr(py, ptr)
insteadgil-refs
only.PyObject
or panic. Read moreSource§unsafe fn from_owned_ptr_or_err(
py: Python<'p>,
ptr: *mut PyObject,
) -> PyResult<&'p Self>
unsafe fn from_owned_ptr_or_err( py: Python<'p>, ptr: *mut PyObject, ) -> PyResult<&'p Self>
Py::from_owned_ptr_or_err(py, ptr)
or Bound::from_owned_ptr_or_err(py, ptr)
insteadgil-refs
only.PyObject
. Read moreSource§unsafe fn from_borrowed_ptr_or_panic(
py: Python<'p>,
ptr: *mut PyObject,
) -> &'p Self
unsafe fn from_borrowed_ptr_or_panic( py: Python<'p>, ptr: *mut PyObject, ) -> &'p Self
Py::from_borrowed_ptr(py, ptr)
or Bound::from_borrowed_ptr(py, ptr)
insteadgil-refs
only.PyObject
. Read moreSource§unsafe fn from_borrowed_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
unsafe fn from_borrowed_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
Py::from_borrowed_ptr(py, ptr)
or Bound::from_borrowed_ptr(py, ptr)
insteadgil-refs
only.PyObject
. Read moreSource§unsafe fn from_borrowed_ptr_or_err(
py: Python<'p>,
ptr: *mut PyObject,
) -> PyResult<&'p Self>
unsafe fn from_borrowed_ptr_or_err( py: Python<'p>, ptr: *mut PyObject, ) -> PyResult<&'p Self>
Py::from_borrowed_ptr_or_err(py, ptr)
or Bound::from_borrowed_ptr_or_err(py, ptr)
insteadgil-refs
only.PyObject
. Read moreSource§impl<T> HasPyGilRef for Twhere
T: PyNativeType,
impl<T> HasPyGilRef for Twhere
T: PyNativeType,
Source§type AsRefTarget = T
type AsRefTarget = T
gil-refs
only.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<'v, T> PyTryFrom<'v> for Twhere
T: PyTypeInfo<AsRefTarget = T> + PyNativeType,
impl<'v, T> PyTryFrom<'v> for Twhere
T: PyTypeInfo<AsRefTarget = T> + PyNativeType,
Source§fn try_from<V>(value: V) -> Result<&'v T, PyDowncastError<'v>>
fn try_from<V>(value: V) -> Result<&'v T, PyDowncastError<'v>>
value.downcast::<T>()
instead of T::try_from(value)
gil-refs
only.Source§fn try_from_exact<V>(value: V) -> Result<&'v T, PyDowncastError<'v>>
fn try_from_exact<V>(value: V) -> Result<&'v T, PyDowncastError<'v>>
value.downcast_exact::<T>()
instead of T::try_from_exact(value)
gil-refs
only.Source§unsafe fn try_from_unchecked<V>(value: V) -> &'v T
unsafe fn try_from_unchecked<V>(value: V) -> &'v T
value.downcast_unchecked::<T>()
instead of T::try_from_unchecked(value)
gil-refs
only.