Rust bindings for the Python interpreter
Go to file
Joar Wandborg 2bd5931a04
Pass -c to "examples/*" tox invocation
The `-c example-path/tox.init` parameter will read the tox.ini from the
provided location and also set `workdir` and `toxinidir` to the
directory of the passed tox.ini

Previously, when only --workdir was passed, tox read the root `tox.ini`,
with the effect that tox was never run on the projects in `examples/`.
2019-01-09 21:19:23 +01:00
.github Update issue_template.md 2018-09-13 19:34:06 +02:00
benches Use LinkedList<[T; 256]> in ReleasePool 2018-11-21 16:00:26 +09:00
ci/travis Pass -c to "examples/*" tox invocation 2019-01-09 21:19:23 +01:00
examples Fix #314 2018-12-28 20:29:12 +01:00
guide Don't require feature when PYTHON_SYS_EXECUTABLE is set 2019-01-07 22:46:01 +01:00
pyo3-derive-backend rustfmt 2019-01-08 20:18:06 +01:00
pyo3cls Bump to 0.6.0-alpha.1 and update changelog from 0.5.3 2019-01-04 11:53:46 +01:00
src rustfmt 2019-01-08 20:18:06 +01:00
tests Replace deprecated methods 2018-12-15 14:15:43 +01:00
.gitignore Improve testing setup 2019-01-08 20:18:23 +01:00
.travis.yml Travis uses 3.7 instead of 3.7-dev 2018-11-23 19:49:12 +00:00
CHANGELOG.md Bump to 0.6.0-alpha.1 and update changelog from 0.5.3 2019-01-04 11:53:46 +01:00
Cargo.toml Bump to 0.6.0-alpha.1 and update changelog from 0.5.3 2019-01-04 11:53:46 +01:00
LICENSE Rename LICENSE-APACHE to LICENSE 2017-10-04 08:56:57 -07:00
Makefile Improve testing setup 2019-01-08 20:18:23 +01:00
README.md Fix #298 2018-12-04 22:50:16 +01:00
appveyor.yml Enable backtrace on AppVeyor too 2018-03-15 13:51:12 +03:00
build.rs Remove format! 2019-01-08 20:20:42 +01:00
rust-toolchain add a rust-toolchain file in the repo to indicate the toolchain used 2017-12-27 22:36:13 +08:00
tox.ini Fix tox config 2018-11-12 22:30:43 +01:00

README.md

PyO3

Build Status Build Status crates.io Join the dev chat

Rust bindings for Python. This includes running and interacting with python code from a rust binaries as well as writing native python modules.

A comparison with rust-cpython can be found in the guide.

Usage

Pyo3 supports python 2.7 as well as python 3.5 and up. The minimum required rust version is 1.30.0-nightly 2018-08-18.

You can either write a native python module in rust or use python from a rust binary.

On some OSs, you need some additional packages.

E.g. if you are on Ubuntu18.04, please run

sudo apt install python3-dev python-dev

Using rust from python

Pyo3 can be used to generate a native python module.

Cargo.toml:

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

[lib]
name = "string_sum"
crate-type = ["cdylib"]

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

src/lib.rs

#![feature(specialization)]

#[macro_use]
extern crate pyo3;

use pyo3::prelude::*;

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

/// This module is a python module implemented in Rust.
#[pymodule]
fn string_sum(py: Python, m: &PyModule) -> PyResult<()> {
    m.add_wrapped(wrap_function!(sum_as_string))?;

    Ok(())
}

On windows and linux, you can build normally with cargo build --release. On macOS, you need to set additional linker arguments. One option is to compile with cargo rustc --release -- -C link-arg=-undefined -C link-arg=dynamic_lookup, the other is to create a .cargo/config with the following content:

[target.x86_64-apple-darwin]
rustflags = [
  "-C", "link-arg=-undefined",
  "-C", "link-arg=dynamic_lookup",
]

For developing, you can copy and rename the shared library from the target folder: On macOS, rename libstring_sum.dylib to string_sum.so, on windows libstring_sum.dll to string_sum.pyd and on linux libstring_sum.so to string_sum.so. Then open a python shell in the same folder and you'll be able to import string_sum.

To build, test and publish your crate as python module, you can use pyo3-pack or setuptools-rust. You can find an example for setuptools-rust in examples/word-count, while pyo3-pack should work on your crate without any configuration.

Using python from rust

Add pyo3 this to your Cargo.toml:

[dependencies]
pyo3 = "0.5"

Example program displaying the value of sys.version:

#![feature(specialization)]

extern crate pyo3;

use pyo3::prelude::*;
use pyo3::types::PyDict;

fn main() -> PyResult<()> {
    let gil = Python::acquire_gil();
    let py = gil.python();
    let sys = py.import("sys")?;
    let version: String = sys.get("version")?.extract()?;

    let locals = PyDict::new(py);
    locals.set_item("os", py.import("os")?)?;
    let user: String = py.eval("os.getenv('USER') or os.getenv('USERNAME')", None, Some(&locals))?.extract()?;

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

Examples and tooling

License

PyO3 is licensed under the Apache-2.0 license. Python is licensed under the Python License.