pyo3/README.md

118 lines
3.6 KiB
Markdown
Raw Normal View History

2017-11-27 19:40:03 +00:00
# PyO3 [![Build Status](https://travis-ci.org/PyO3/pyo3.svg?branch=master)](https://travis-ci.org/PyO3/pyo3) [![Build Status](https://ci.appveyor.com/api/projects/status/github/PyO3/pyo3?branch=master&svg=true)](https://ci.appveyor.com/project/fafhrd91/pyo3) [![codecov](https://codecov.io/gh/PyO3/pyo3/branch/master/graph/badge.svg)](https://codecov.io/gh/PyO3/pyo3) [![Join the dev chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/PyO3/Lobby)
2015-04-19 03:29:19 +00:00
[Rust](http://www.rust-lang.org/) bindings for the [python](https://www.python.org/) interpreter.
2017-07-13 20:14:47 +00:00
* [User Guide](https://pyo3.github.io/pyo3/guide/)
* [API Documentation](http://pyo3.github.io/pyo3/pyo3/)
2017-05-19 06:30:36 +00:00
* Cargo package: [pyo3](https://crates.io/crates/pyo3)
2015-04-19 03:29:19 +00:00
---
2017-07-23 23:28:13 +00:00
PyO3 is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
2015-04-19 03:29:19 +00:00
Python is licensed under the [Python License](https://docs.python.org/2/license.html).
2015-08-02 19:56:03 +00:00
Supported Python versions:
2017-05-21 12:37:56 +00:00
2017-06-12 06:45:06 +00:00
* Python2.7, Python 3.5 and up
2015-04-19 03:29:19 +00:00
2015-09-20 17:43:24 +00:00
Supported Rust version:
2017-05-21 12:37:56 +00:00
* Rust 1.23.0-nightly 2017-11-07 or later
* On Windows, we require rustc 1.23.0-nightly 2017-11-07
2015-09-20 17:43:24 +00:00
2017-05-21 12:37:56 +00:00
## Usage
2015-04-19 03:29:19 +00:00
2017-05-13 05:30:25 +00:00
To use `pyo3`, add this to your `Cargo.toml`:
2015-04-19 03:29:19 +00:00
```toml
[dependencies]
2017-08-15 01:30:55 +00:00
pyo3 = "0.2"
2015-04-19 03:29:19 +00:00
```
Example program displaying the value of `sys.version`:
```rust
2017-05-13 05:30:25 +00:00
extern crate pyo3;
2015-04-19 03:29:19 +00:00
use pyo3::{Python, PyDict, PyResult, ObjectProtocol};
2015-04-19 03:29:19 +00:00
fn main() {
let gil = Python::acquire_gil();
hello(gil.python()).unwrap();
}
fn hello(py: Python) -> PyResult<()> {
let sys = py.import("sys")?;
2017-06-29 05:26:25 +00:00
let version: String = sys.get("version")?.extract()?;
let locals = PyDict::new(py);
2017-05-30 19:42:07 +00:00
locals.set_item("os", py.import("os")?)?;
2017-06-29 05:26:25 +00:00
let user: String = py.eval("os.getenv('USER') or os.getenv('USERNAME')", None, Some(&locals))?.extract()?;
println!("Hello {}, I'm Python {}", user, version);
Ok(())
2015-04-19 03:29:19 +00:00
}
```
Example library with python bindings:
2016-12-17 20:41:14 +00:00
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](examples/word-count) and the associated setup.py.
Also on macOS, you will need to rename the output from \*.dylib to \*.so.
2016-12-17 20:41:14 +00:00
On Windows, you will need to rename the output from \*.dll to \*.pyd.
**`Cargo.toml`:**
2017-05-21 12:37:56 +00:00
```toml
[lib]
name = "rust2py"
2016-12-17 20:41:14 +00:00
crate-type = ["cdylib"]
2017-05-19 04:35:08 +00:00
[dependencies.pyo3]
2017-09-27 10:10:56 +00:00
version = "0.2"
2016-12-17 20:41:14 +00:00
features = ["extension-module"]
```
**`src/lib.rs`**
2017-05-21 12:37:56 +00:00
```rust
2017-07-14 10:17:57 +00:00
#![feature(proc_macro, specialization)]
2017-06-14 21:42:05 +00:00
extern crate pyo3;
2017-07-31 17:42:55 +00:00
use pyo3::prelude::*;
// add bindings to the generated python module
2016-12-17 20:41:14 +00:00
// N.B: names: "librust2py" must be the name of the `.so` or `.pyd` file
2017-06-18 15:00:27 +00:00
/// This module is implemented in Rust.
2017-06-12 06:45:06 +00:00
#[py::modinit(rust2py)]
fn init_mod(py: Python, m: &PyModule) -> PyResult<()> {
#[pyfn(m, "sum_as_string")]
2017-06-15 21:20:30 +00:00
// 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.
2017-07-26 21:30:01 +00:00
fn sum_as_string_py(a:i64, b:i64) -> PyResult<String> {
let out = sum_as_string(a, b);
Ok(out)
}
Ok(())
2017-06-12 06:57:21 +00:00
}
// logic implemented as a normal rust function
fn sum_as_string(a:i64, b:i64) -> String {
format!("{}", a + b).to_string()
}
```
2017-03-12 11:54:21 +00:00
2017-05-21 12:37:56 +00:00
For `setup.py` integration, see [setuptools-rust](https://github.com/PyO3/setuptools-rust)
2017-05-13 05:51:14 +00:00
2017-05-19 04:35:08 +00:00
**This is fork of rust-cpython project https://github.com/dgrunwald/rust-cpython**
2017-07-23 23:27:04 +00:00
2017-07-23 23:28:13 +00:00
[Motivation for fork](https://github.com/PyO3/pyo3/issues/55)