pyo3/README.md

129 lines
4.8 KiB
Markdown
Raw Normal View History

2018-05-17 21:59:11 +00:00
# PyO3
2015-04-19 03:29:19 +00:00
2018-07-30 20:52:22 +00:00
[![Build Status](https://travis-ci.org/PyO3/pyo3.svg?branch=master)](https://travis-ci.org/PyO3/pyo3)
2018-08-11 15:35:03 +00:00
[![Build Status](https://ci.appveyor.com/api/projects/status/github/PyO3/pyo3?branch=master&svg=true)](https://ci.appveyor.com/project/fafhrd91/pyo3)
2018-07-30 20:52:22 +00:00
[![crates.io](http://meritbadge.herokuapp.com/pyo3)](https://crates.io/crates/pyo3)
[![Join the dev chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/PyO3/Lobby)
2018-05-17 21:59:11 +00:00
2018-07-30 20:52:22 +00:00
[Rust](http://www.rust-lang.org/) bindings for [Python](https://www.python.org/). This includes running and interacting with python code from a rust binaries as well as writing native python modules.
2015-04-19 03:29:19 +00:00
2018-06-01 13:03:04 +00:00
* User Guide: [stable](https://pyo3.rs) | [master](https://pyo3.rs/master)
2015-04-19 03:29:19 +00:00
2018-10-04 06:46:15 +00:00
* API Documentation: [master](https://pyo3.rs/master/doc)
2018-06-14 08:10:39 +00:00
A comparison with rust-cpython can be found [in the guide](https://pyo3.rs/master/rust-cpython.html).
2017-05-21 12:37:56 +00:00
2018-05-17 21:59:11 +00:00
## Usage
2017-05-21 12:37:56 +00:00
2018-08-19 18:42:17 +00:00
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.
2015-09-20 17:43:24 +00:00
2018-07-30 20:52:22 +00:00
You can either write a native python module in rust or use python from a rust binary.
2015-04-19 03:29:19 +00:00
2018-08-30 21:19:23 +00:00
## Using rust from python
2015-04-19 03:29:19 +00:00
2018-07-30 20:52:22 +00:00
Pyo3 can be used to generate a native python module.
**`Cargo.toml`:**
2017-05-21 12:37:56 +00:00
```toml
[package]
2018-08-30 21:19:23 +00:00
name = "string-sum"
version = "0.1.0"
[lib]
2018-08-30 21:19:23 +00:00
name = "string_sum"
2016-12-17 20:41:14 +00:00
crate-type = ["cdylib"]
2017-05-19 04:35:08 +00:00
[dependencies.pyo3]
2018-08-19 18:42:17 +00:00
version = "0.4"
2016-12-17 20:41:14 +00:00
features = ["extension-module"]
```
**`src/lib.rs`**
2017-05-21 12:37:56 +00:00
```rust
2018-08-19 18:42:17 +00:00
#![feature(specialization)]
2018-07-30 20:52:22 +00:00
#[macro_use]
2017-06-14 21:42:05 +00:00
extern crate pyo3;
2018-07-30 20:52:22 +00:00
use pyo3::prelude::*;
2018-07-30 20:52:22 +00:00
#[pyfunction]
/// Formats the sum of two numbers as string
fn sum_as_string(a: usize, b: usize) -> PyResult<String> {
Ok((a + b).to_string())
}
2018-05-01 13:31:11 +00:00
2018-09-27 23:54:53 +00:00
/// This module is a python module implemented in Rust.
#[pymodinit]
2018-08-30 21:19:23 +00:00
fn string_sum(py: Python, m: &PyModule) -> PyResult<()> {
2018-07-30 20:52:22 +00:00
m.add_function(wrap_function!(sum_as_string))?;
Ok(())
2017-06-12 06:57:21 +00:00
}
```
2017-03-12 11:54:21 +00:00
2018-09-27 23:55:25 +00:00
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:
```toml
[target.x86_64-apple-darwin]
rustflags = [
"-C", "link-arg=-undefined",
"-C", "link-arg=dynamic_lookup",
]
```
2018-09-27 23:55:25 +00:00
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 `libstring_sum.so`. Then open a python shell in the same folder and you'll be able to `import string_sum`.
2018-08-30 21:19:23 +00:00
To build, test and publish your crate as python module, you can use [pyo3-pack](https://github.com/PyO3/pyo3-pack) or [setuptools-rust](https://github.com/PyO3/setuptools-rust). You can find an example for setuptools-rust in [examples/word-count](examples/word-count), while pyo3-pack should work on your crate without any configuration.
2017-05-13 05:51:14 +00:00
2018-08-30 21:19:23 +00:00
## Using python from rust
2018-07-30 20:52:22 +00:00
Add `pyo3` this to your `Cargo.toml`:
```toml
[dependencies]
pyo3 = "0.4"
2018-07-30 20:52:22 +00:00
```
Example program displaying the value of `sys.version`:
```rust
2018-08-19 18:42:17 +00:00
#![feature(specialization)]
2018-07-30 20:52:22 +00:00
extern crate pyo3;
use pyo3::prelude::*;
2018-09-21 21:32:48 +00:00
use pyo3::types::PyDict;
2018-07-30 20:52:22 +00:00
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
2018-10-29 10:09:29 +00:00
* [examples/word-count](examples/word-count) _Counting the occurrences of a word in a text file_
2018-07-30 20:52:22 +00:00
* [hyperjson](https://github.com/mre/hyperjson) _A hyper-fast Python module for reading/writing JSON data using Rust's serde-json_
* [rust-numpy](https://github.com/rust-numpy/rust-numpy) _Rust binding of NumPy C-API_
* [html-py-ever](https://github.com/PyO3/setuptools-rust/tree/master/html-py-ever) _Using [html5ever](https://github.com/servo/html5ever) through [kuchiki](https://github.com/kuchiki-rs/kuchiki) to speed up html parsing and css-selecting._
2018-07-30 20:52:22 +00:00
* [pyo3-built](https://github.com/PyO3/pyo3-built) _Simple macro to expose metadata obtained with the [`built`](https://crates.io/crates/built) crate as a [`PyDict`](https://pyo3.github.io/pyo3/pyo3/struct.PyDict.html)_
2018-08-11 15:35:03 +00:00
* [point-process](https://github.com/ManifoldFR/point-process-rust/tree/master/pylib) _High level API for pointprocesses as a Python library_
2018-09-08 06:12:36 +00:00
* [autopy](https://github.com/autopilot-rs/autopy) _A simple, cross-platform GUI automation library for Python and Rust._
2018-07-30 20:52:22 +00:00
2018-05-17 21:59:11 +00:00
## License
2017-05-13 05:51:14 +00:00
2018-05-17 21:59:11 +00:00
PyO3 is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
2018-06-14 08:10:39 +00:00
Python is licensed under the [Python License](https://docs.python.org/2/license.html).