pyo3 README

The project's README from github.com/PyO3/pyo3. As one markdown file: README.md.

PyO3

actions status benchmark codecov crates.io minimum rustc 1.83 discord server contributing notes

Rust bindings for Python, including tools for creating native Python extension modules. Running and interacting with Python code from a Rust binary is also supported.

Usage

Requires Rust 1.83 or greater.

PyO3 supports the following Python distributions:

You can use PyO3 to write a native Python module in Rust, or to embed Python in a Rust binary. The following sections explain each of these in turn.

Using Rust from Python

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 install maturin, use it to generate and build a new Python package, and then launch Python to import and execute a function from the package.

First, follow the commands below to create a new directory containing a new Python virtualenv, and install maturin into the virtualenv using Python's package manager, pip:

# (replace string_sum with the desired package name)
$ mkdir string_sum
$ cd string_sum
$ python -m venv .env
$ source .env/bin/activate
$ pip install maturin

Still inside this string_sum directory, now run maturin init. This will generate the new package source. When given the choice of bindings to use, select pyo3 bindings:

$ maturin init
✔ 🤷 What kind of bindings to use? · pyo3
  ✨ Done! New project created string_sum

The most important files generated by this command are Cargo.toml and lib.rs, which will look roughly like the following:

Cargo.toml

[package]
name = "string_sum"
version = "0.1.0"
edition = "2021"

[lib]
# The name of the native library. This is the name which will be used in Python to import the
# library (i.e. `import string_sum`). If you change this, you must also change the name of the
# `#[pymodule]` in `src/lib.rs`.
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 = "0.29.2"

src/lib.rs

/// A Python module implemented in Rust. The name of this module must match
/// the `lib.name` setting in the `Cargo.toml`, else Python will not be able to
/// import the module.
#[pyo3::pymodule]
mod string_sum {
  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())
  }
}

Finally, run maturin develop. This will build the package and install it into the Python virtualenv previously created and activated. The package is then ready to be used from python:

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

When checking runtime performance, run maturin develop --release to build with optimizations.

To make changes to the package, just edit the Rust source code and then re-run maturin develop to recompile.

To run this all as a single copy-and-paste, use the bash script below (replace string_sum in the first command with the desired package name):

mkdir string_sum && cd "$_"
python -m venv .env
source .env/bin/activate
pip install maturin
maturin init --bindings pyo3
maturin develop

If you want to be able to run cargo test or use this project in a Cargo workspace and are running into linker issues, there are some workarounds in the FAQ.

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

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

To install the Python shared library on RPM based distributions (e.g. Fedora, Red Hat, SuSE), install the python3-devel package.

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

[dependencies.pyo3]
version = "0.29.2"
# Enabling this cargo feature will cause PyO3 to start a Python interpreter on first call to `Python::attach`
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::attach(|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 = c"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.

Tools and libraries

Examples

Articles and other media

Contributing

Everyone is welcomed to contribute to PyO3! There are many ways to support the project, such as:

Our contributing notes and architecture guide have more resources if you wish to volunteer time for PyO3 and are searching where to start.

If you don't have time to contribute yourself but still wish to support the project's future success, some of our maintainers have GitHub sponsorship pages:

License

PyO3 is licensed under the Apache-2.0 license or the MIT license, at your option.

Python is licensed under the Python License.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusi

pyo3 (PyO3/pyo3)

Searching Database…

16.2K ·GitHub
Pyo3
Что это такое?PyO3 — это библиотека на Rust с привязками к интерпретатору Python: она позволяет писать нативные модули-расширения для Python на Rust или встраивать Python и выполнять Python-код из бинарника на Rust.
PyO3 — это инструмент, который я устанавливаю и запускаю, или библиотека, под которую я пишу код?Это то, под что вы пишете код: крейт на Rust, который добавляется в Cargo.toml, а готовый Python-пакет собирается отдельным инструментом — проще всего maturin.
Как собрать свой первый модуль-расширение для Python с его помощью?Создайте виртуальное окружение Python, выполните 'pip install maturin', затем 'maturin init' и выберите привязки pyo3. Команда 'maturin develop' собирает пакет и устанавливает его в виртуальное окружение; добавьте --release для оптимизированной сборки.
Какие версии Rust и Python поддерживаются?Rust 1.83 или новее. Со стороны Python: CPython 3.9 или новее, PyPy 7.3 (Python 3.11+) и GraalPy 25.0 или новее (Python 3.12+).
Что может меня подстерегать при сборке или тестировании?При запуске 'cargo test' или сборке внутри Cargo workspace могут возникнуть проблемы с линковщиком — в FAQ описаны обходные пути. Для встраивания Python также нужна сборка Python с разделяемой библиотекой (python3-dev или python3-devel на Linux).
Под какой лицензией распространяется PyO3?Двойная лицензия: можно использовать под Apache-2.0 или MIT — на ваш выбор.
А можно наоборот — вызывать Python из Rust?Да — встраивание поддерживается наравне с написанием расширений. Добавьте pyo3 в Cargo.toml, убедитесь, что ваша установка Python собрана с разделяемой библиотекой (python3-dev на Ubuntu, python3-devel в RPM-дистрибутивах), — и вы сможете выполнять Python-код и работать с Python-объектами прямо из бинарника на Rust.
Обязательно ли использовать maturin для сборки пакета?Нет. Подойдут и setuptools-rust, и полностью ручная настройка — они дают больше гибкости, но требуют больше конфигурации на старте. Maturin — просто самый простой путь: минимум настроек и быстрая пересборка через 'maturin develop'.
Какие известные Python-проекты собраны на PyO3?В основном пакеты, где важна производительность: Polars, orjson, pydantic-core, tiktoken, Hugging Face tokenizers и cryptography используют PyO3 для своих Rust-ядер. В README перечислены десятки других — от rust-numpy и pyo3-log до Delta Lake, Arrow и HTTP-клиентов.
What are similar projects?liteparse, sghtmltopdf, xi-editor, cython, tinyjsapp, CalcKernel, rust-analyzer, xquad
Which topics is it in?ffi, native, developers, performance, rust, free, tool, apache-2.0, library, python, cross-platform, developer-tools
Creator
PyO3
Size
63.1 MB
Stars
16.2K
Updated
CommitOct 14Releasev0.30.1Oct 14
Age
9y
Commits · 90 Days