Struct PyTuple

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

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

Tuple Fields

0: PyAny

Implementations

impl PyTuple

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyTuple

pub fn new<'py, T, U>( py: Python<'py>, elements: impl IntoIterator<Item = T, IntoIter = U>, ) -> PyResult<Bound<'py, PyTuple>>

where T: IntoPyObject<'py>, 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(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.

pub fn new_bound<T, U>( py: Python<'_>, elements: impl IntoIterator<Item = T, IntoIter = U>, ) -> Bound<'_, PyTuple>

where T: ToPyObject, U: ExactSizeIterator<Item = T>,

👎Deprecated since 0.23.0: renamed to PyTuple::new

Deprecated name for PyTuple::new.

pub fn empty(py: Python<'_>) -> Bound<'_, PyTuple>

Constructs an empty tuple (on the Python side, a singleton object).

pub fn empty_bound(py: Python<'_>) -> Bound<'_, PyTuple>

👎Deprecated since 0.23.0: renamed to PyTuple::empty

Deprecated name for PyTuple::empty.

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsRef<PyAny> for PyTuple

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyTuple

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyTuple

const NAME: &'static str = "PyTuple"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

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

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyTuple