Crate pyo3

source ·
Expand description

Rust bindings to the Python interpreter.

PyO3 can be used to write native Python modules or run Python code and modules from Rust.

See the guide for a detailed introduction.

PyO3’s object types

PyO3 has several core types that you should familiarize yourself with:

The Python<’py> object

Holding the global interpreter lock (GIL) is modeled with the Python<'py> token. All APIs that require that the GIL is held require this token as proof that you really are holding the GIL. It can be explicitly acquired and is also implicitly acquired by PyO3 as it wraps Rust functions and structs into Python functions and objects.

The GIL-dependent types

For example &PyAny. These are only ever seen as references, with a lifetime that is only valid for as long as the GIL is held, which is why using them doesn’t require a Python<'py> token. The underlying Python object, if mutable, can be mutated through any reference.

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

The GIL-independent types

When wrapped in Py<...>, like with Py<PyAny> or Py<SomePyClass>, Python objects no longer have a limited lifetime which makes them easier to store in structs and pass between functions. However, you cannot do much with them without a Python<'py> token, for which you’d need to reacquire the GIL.

PyErr

The vast majority of operations in this library will return PyResult<...>. This is an alias for the type Result<..., PyErr>.

A PyErr represents a Python exception. A PyErr returned to Python code will be raised as a Python exception. Errors from PyO3 itself are also exposed as Python exceptions.

Feature flags

PyO3 uses feature flags to enable you to opt-in to additional functionality. For a detailed description, see the Features chapter of the guide.

Default feature flags

The following features are turned on by default:

  • macros: Enables various macros, including all the attribute macros.

Optional feature flags

The following features customize PyO3’s behavior:

  • abi3: Restricts PyO3’s API to a subset of the full Python API which is guaranteed by PEP 384 to be forward-compatible with future Python versions.
  • auto-initialize: Changes Python::with_gil to automatically initialize the Python interpreter if needed.
  • extension-module: This will tell the linker to keep the Python symbols unresolved, so that your module can also be used with statically linked Python interpreters. Use this feature when building an extension module.
  • multiple-pymethods: Enables the use of multiple #[pymethods] blocks per #[pyclass]. This adds a dependency on the inventory crate, which is not supported on all platforms.

The following features enable interactions with other crates in the Rust ecosystem:

Unstable features

  • nightly: Uses #![feature(auto_traits, negative_impls)] to define Ungil as an auto trait.

rustc environment flags

PyO3 uses rustc’s --cfg flags to enable or disable code used for different Python versions. If you want to do this for your own crate, you can do so with the pyo3-build-config crate.

  • Py_3_7, Py_3_8, Py_3_9, Py_3_10: Marks code that is only enabled when compiling for a given minimum Python version.
  • Py_LIMITED_API: Marks code enabled when the abi3 feature flag is enabled.
  • PyPy - Marks code enabled when compiling for PyPy.

Minimum supported Rust and Python versions

PyO3 supports the following software versions:

  • Python 3.7 and up (CPython and PyPy)
  • Rust 1.56 and up

Example: Building a native Python module

PyO3 can be used to generate a native Python module. The easiest way to try this out for the first time is to use maturin. maturin is a tool for building and publishing Rust-based Python packages with minimal configuration. The following steps set up some files for an example Python module, install maturin, and then show how to build and import the Python module.

First, create a new folder (let’s call it string_sum) containing the following two files:

Cargo.toml

[package]
name = "string-sum"
version = "0.1.0"
edition = "2021"

[lib]
name = "string_sum"
# "cdylib" is necessary to produce a shared library for Python to import from.
#
# Downstream Rust code (including code in `bin/`, `examples/`, and `tests/`) will not be able
# to `use string_sum;` unless the "rlib" or "lib" crate type is also included, e.g.:
# crate-type = ["cdylib", "rlib"]
crate-type = ["cdylib"]

[dependencies.pyo3]
version = "0.20.0"
features = ["extension-module"]

src/lib.rs

use pyo3::prelude::*;

/// Formats the sum of two numbers as string.
#[pyfunction]
fn sum_as_string(a: usize, b: usize) -> PyResult<String> {
    Ok((a + b).to_string())
}

/// A Python module implemented in Rust.
#[pymodule]
fn string_sum(py: Python<'_>, m: &PyModule) -> PyResult<()> {
    m.add_function(wrap_pyfunction!(sum_as_string, m)?)?;

    Ok(())
}

With those two files in place, now maturin needs to be installed. This can be done using Python’s package manager pip. First, load up a new Python virtualenv, and install maturin into it:

$ cd string_sum
$ python -m venv .env
$ source .env/bin/activate
$ pip install maturin

Now build and execute the module:

$ maturin develop
# lots of progress output as maturin runs the compilation...
$ python
>>> import string_sum
>>> string_sum.sum_as_string(5, 20)
'25'

As well as with maturin, it is possible to build using setuptools-rust or manually. Both offer more flexibility than maturin but require further configuration.

Example: Using Python from Rust

To embed Python into a Rust binary, you need to ensure that your Python installation contains a shared library. The following steps demonstrate how to ensure this (for Ubuntu), and then give some example code which runs an embedded Python interpreter.

To install the Python shared library on Ubuntu:

sudo apt install python3-dev

Start a new project with cargo new and add pyo3 to the Cargo.toml like this:

[dependencies.pyo3]
version = "0.20.0"
# this is necessary to automatically initialize the Python interpreter
features = ["auto-initialize"]

Example program displaying the value of sys.version and the current user name:

use pyo3::prelude::*;
use pyo3::types::IntoPyDict;

fn main() -> PyResult<()> {
    Python::with_gil(|py| {
        let sys = py.import("sys")?;
        let version: String = sys.getattr("version")?.extract()?;

        let locals = [("os", py.import("os")?)].into_py_dict(py);
        let code = "os.getenv('USER') or os.getenv('USERNAME') or 'Unknown'";
        let user: String = py.eval(code, None, Some(&locals))?.extract()?;

        println!("Hello {}, I'm Python {}", user, version);
        Ok(())
    })
}

The guide has a section with lots of examples about this topic.

Other Examples

The PyO3 README contains quick-start examples for both using Rust from Python and Python from Rust.

The PyO3 repository’s examples subdirectory contains some basic packages to demonstrate usage of PyO3.

There are many projects using PyO3 - see a list of some at https://github.com/PyO3/pyo3#examples.

Re-exports

Modules

  • bufferNon-Py_LIMITED_API or Py_3_11
    PyBuffer implementation
  • chronochrono and non-Py_LIMITED_API
    Conversions to and from chrono’s Duration, NaiveDate, NaiveTime, DateTime<Tz>, FixedOffset, and Utc.
  • class
    Old module which contained some implementation details of the #[pyproto] module.
  • conversion
    Defines conversions between Rust and Python types.
  • exceptions
    Exception and warning types defined by Python.
  • eyreeyre
    A conversion from eyre’s Report type to PyErr.
  • ffi
    Raw FFI declarations for Python’s C API.
  • hashbrownhashbrown
    Conversions to and from hashbrown’s HashMap and HashSet.
  • indexmapindexmap
    Conversions to and from indexmap’s IndexMap.
  • marker
    Fundamental properties of objects tied to the Python interpreter.
  • marshalNon-Py_LIMITED_API
    Support for the Python marshal format.
  • num_bigintnum-bigint
    Conversions to and from num-bigint’s BigInt and BigUint types.
  • num_complexnum-complex
    Conversions to and from num-complex’ Complex<f32> and Complex<f64>.
  • panic
    Helper to convert Rust panics to Python exceptions.
  • prelude
    PyO3’s prelude.
  • pycell
    PyO3’s interior mutability primitive.
  • pyclass
    PyClass and related traits.
  • pyclass_init
    Contains initialization utilities for #[pyclass].
  • rust_decimalrust_decimal
    Conversions to and from rust_decimal’s Decimal type.
  • serdeserde
    Enables (de)serialization of Py<T> objects via serde.
  • sync
    Synchronization mechanisms based on the Python GIL.
  • type_object
    Python type object information
  • types
    Various types defined by the Python interpreter such as int, str and tuple.

Macros

  • append_to_inittabmacros and non-PyPy
    Add the module to the initialization table in order to make embedded Python code to use it. Module name is the argument.
  • create_exception
    Defines a new exception type.
  • import_exception
    Defines a Rust type for an exception defined in Python code.
  • intern
    Interns text as a Python string and stores a reference to it in static storage.
  • py_runmacros
    A convenient macro to execute a Python code snippet, with some local variables set.
  • wrap_pyfunctionmacros
    Wraps a Rust function annotated with #[pyfunction].
  • wrap_pymodulemacros
    Returns a function that takes a Python instance and returns a Python module.

Structs

  • GILPool
    A RAII pool which PyO3 uses to store owned Python references.
  • Py
    A GIL-independent reference to an object allocated on the Python heap.
  • PyDowncastError
    Error that indicates a failure to convert a PyAny to a more specific Python type.
  • PyErr
    Represents a Python exception.
  • PythonVersionInfo
    Represents the major, minor, and patch (if any) versions of this interpreter.

Traits

  • PyErrArguments
    Helper conversion trait that allows to use custom arguments for lazy exception construction.
  • PyNativeType
    Types that are built into the Python interpreter.

Functions

Type Aliases

  • PyObject
    A commonly-used alias for Py<PyAny>.
  • PyResult
    Represents the result of a Python call.

Attribute Macros

  • pyclassmacros
    A proc macro used to expose Rust structs and fieldless enums as Python objects.
  • pyfunctionmacros
    A proc macro used to expose Rust functions to Python.
  • pymethodsmacros
    A proc macro used to expose methods to Python.
  • pymodulemacros
    A proc macro used to implement Python modules.

Derive Macros