e585f5881d | ||
---|---|---|
examples | ||
guide | ||
pyo3cls | ||
src | ||
tests | ||
.gitignore | ||
.travis.yml | ||
CHANGES.txt | ||
Cargo.toml | ||
LICENSE | ||
Makefile | ||
README.md | ||
appveyor.yml | ||
build.rs | ||
rust-toolchain |
README.md
PyO3
Rust bindings for the python interpreter.
- User Guide
- API Documentation
- Cargo package: pyo3
PyO3 is licensed under the Apache-2.0 license. Python is licensed under the Python License.
Supported Python versions:
- Python2.7, Python 3.5 and up
Supported Rust version:
- Rust 1.23.0-nightly 2017-11-07 or later
Usage
To use pyo3
, add this to your Cargo.toml
:
[dependencies]
pyo3 = "0.2"
Example program displaying the value of sys.version
:
extern crate pyo3;
use pyo3::{Python, PyDict, PyResult, ObjectProtocol};
fn main() {
let gil = Python::acquire_gil();
hello(gil.python()).unwrap();
}
fn hello(py: Python) -> PyResult<()> {
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(())
}
Example library with python bindings:
The following two files will build with cargo build
, and will generate a python-compatible library.
For MacOS, "-C link-arg=-undefined -C link-arg=dynamic_lookup" is required to build the library.
setuptools-rust
includes this by default.
See examples/word-count and the associated setup.py.
Also on macOS, you will need to rename the output from *.dylib to *.so.
On Windows, you will need to rename the output from *.dll to *.pyd.
Cargo.toml
:
[lib]
name = "rust2py"
crate-type = ["cdylib"]
[dependencies.pyo3]
version = "0.2"
features = ["extension-module"]
src/lib.rs
#![feature(proc_macro, specialization)]
extern crate pyo3;
use pyo3::prelude::*;
// add bindings to the generated python module
// N.B: names: "librust2py" must be the name of the `.so` or `.pyd` file
/// This module is implemented in Rust.
#[py::modinit(rust2py)]
fn init_mod(py: Python, m: &PyModule) -> PyResult<()> {
#[pyfn(m, "sum_as_string")]
// pyo3 aware function. All of our python interface could be declared in a separate module.
// Note that the `#[pyfn()]` annotation automatically converts the arguments from
// Python objects to Rust values; and the Rust return value back into a Python object.
fn sum_as_string_py(a:i64, b:i64) -> PyResult<String> {
let out = sum_as_string(a, b);
Ok(out)
}
Ok(())
}
// logic implemented as a normal rust function
fn sum_as_string(a:i64, b:i64) -> String {
format!("{}", a + b).to_string()
}
For setup.py
integration, see setuptools-rust
This is fork of rust-cpython project https://github.com/dgrunwald/rust-cpython