Rust bindings for the Python interpreter
Go to file
Daniel Grunwald 278c1aece8 Fix #56: PyModuleDef changed "m_slots" to "m_reload" in Python 3.5. 2016-12-10 13:03:51 +01:00
examples Put Python argument at beginning of argument list. 2015-10-26 23:52:18 +01:00
extensions #40: split ExtractPyObject into two traits: 2016-05-08 21:25:09 +02:00
python3-sys Fix #56: PyModuleDef changed "m_slots" to "m_reload" in Python 3.5. 2016-12-10 13:03:51 +01:00
python27-sys Make PyStringObject and PyBytesObject public 2016-11-13 11:51:23 +01:00
src Fix #56: PyModuleDef changed "m_slots" to "m_reload" in Python 3.5. 2016-12-10 13:03:51 +01:00
tests Add support for in-place numeric operators in py_class! 2016-06-14 16:00:55 -04:00
.gitignore Update link to documentation. 2015-04-19 07:50:50 +02:00
.travis.yml Fix stable rust version in travis config 2016-03-06 01:11:35 +01:00
Cargo.toml Adjust python3-sys to Python 3.6 RC headers. 2016-12-10 12:07:42 +01:00
LICENSE MIT license headers 2015-04-19 05:22:03 +02:00
Makefile py_class!: add __bool__ slot 2016-05-06 22:05:12 +02:00
README.md added example of implementing a basic python module 2016-10-26 15:55:50 -04:00
appveyor.yml appveyor: fix install script 2015-11-12 00:10:56 +01:00
build.rs windows support for build script 2015-05-28 11:17:14 +01:00

README.md

rust-cpython Build Status

Rust bindings for the python interpreter.


Copyright (c) 2015-2016 Daniel Grunwald. Rust-cpython is licensed under the MIT license. Python is licensed under the Python License.

Supported Python versions:

  • Python 2.7
  • Python 3.3
  • Python 3.4
  • Python 3.5

Supported Rust version:

  • Rust 1.7.0 or later

Usage

To use cpython, add this to your Cargo.toml:

[dependencies]
cpython = { git = "https://github.com/dgrunwald/rust-cpython.git" }

Example program displaying the value of sys.version:

extern crate cpython;

use cpython::Python;
use cpython::ObjectProtocol; //for call method

fn main() {
    let gil = Python::acquire_gil();
    let py = gil.python();

    let sys = py.import("sys").unwrap();
    let version: String = sys.get(py, "version").unwrap().extract(py).unwrap();

    let os = py.import("os").unwrap();
    let getenv = os.get(py, "getenv").unwrap();
    let user: String = getenv.call(py, ("USER",), None).unwrap().extract(py).unwrap();

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

Example library with python bindings:

The following two files will build with cargo build, and will generate a python-compatible library. (On macOS, you will need to rename the output from *.dynlib to *.so)

Cargo.toml:

[lib]
name = "rust2py"
crate-type = ["dylib"]

[dependencies]
cpython = { git = "https://github.com/dgrunwald/rust-cpython.git" }

src/lib.rs

#[macro_use] extern crate cpython;

use cpython::{PyResult, Python};

// add bindings to the generated python module
// N.B: names: "rust2py" must be the lib name in Cargo.toml
py_module_initializer!(librust2py, initlibrust2py, PyInit_librust2py, |py, m| {
    try!(m.add(py, "__doc__", "This module is implemented in Rust."));
    try!(m.add(py, "sum_as_string", py_fn!(py, sum_as_string_py(a: i64, b:i64))));
    Ok(())
});

// logic implemented as a normal rust function
fn sum_as_string(a:i64, b:i64) -> String {
    format!("{}", a + b).to_string()
}

// rust-cpython aware function. All of our python interface could be
// declared in a separate module. 
fn sum_as_string_py(_: Python, a:i64, b:i64) -> PyResult<String> {
    let out = sum_as_string(a, b);
    Ok(out)
}