Struct PyList 

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

Represents a Python list.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyList> or Bound<'py, PyList>.

For APIs available on list objects, see the PyListMethods trait which is implemented for Bound<'py, PyList>.

Tuple Fields

0: PyAny

Implementations

impl PyList

#[doc(hidden)]

pub const _PYO3_DEF: AddTypeToModule<Self>

#[doc(hidden)]

pub const _PYO3_INTROSPECTION_ID: &'static str = ":: core :: option :: Option :: Some(\"builtins\")PyList"

impl PyList

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

where T: IntoPyObject<'py>,

Constructs a new list with the given elements.

Examples

use pyo3::prelude::*;
use pyo3::types::PyList;

Python::attach(|py| {
    let elements: Vec<i32> = vec![0, 1, 2, 3, 4, 5];
    let list = PyList::new(py, elements)?;
    assert_eq!(format!("{:?}", list), "[0, 1, 2, 3, 4, 5]");
})

Panics

This function will panic if element’s Iterator::size_hint implementation is incorrect. All standard library structures implement this trait correctly, if they do, so calling this function with (for example) Vec<T> or &[T] will always succeed.

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

Constructs a new empty list.

Trait Implementations

impl DerefToPyAny for PyList

impl PyClassBaseType for PyList

Available on Py_3_12 only.

type LayoutAsBase = PyVariableClassObjectBase

type BaseNativeType = PyList

type Initializer = PyNativeTypeInitializer<PyList>

type PyClassMutability = ImmutableClass

type Layout<T: PyClassImpl> = PyVariableClassObject<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyTypeInfo for PyList

const NAME: &'static str = "PyList"

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&'static str>

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

const TYPE_HINT: PyStaticExpr

Available on crate feature experimental-inspect only.

Provides the full python type as a type hint.

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

Returns the PyTypeObject instance for this type.

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

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

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

Returns the safe abstraction over the type object.

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

Checks if object is an instance of this type.