pyo3/examples/getitem

getitem

A project showcasing how to create a __getitem__ override that also showcases how to deal with multiple incoming types

Relevant Documentation

Some of the relevant documentation links for this example:

• Converting Slices to Indices: https://docs.rs/pyo3/latest/pyo3/types/struct.PySlice.html#method.indices
• GetItem Docs: https://pyo3.rs/latest/class/protocols.html?highlight=getitem#mapping--sequence-types
• Extract: https://pyo3.rs/latest/conversions/traits.html?highlight=extract#extract-and-the-frompyobject-trait
• Downcast and getattr: https://pyo3.rs/v0.19.0/types.html?highlight=getattr#pyany

Building and Testing

To build this package, first install maturin:

pip install maturin

To build and test use maturin develop:

pip install -r requirements-dev.txt
maturin develop
pytest

Alternatively, install nox and run the tests inside an isolated environment:

nox

Copying this example

Use cargo-generate:

$ cargo install cargo-generate
$ cargo generate --git https://github.com/PyO3/pyo3 examples/decorator

(cargo generate will take a little while to clone the PyO3 repo first; be patient when waiting for the command to run.)