- Notifications
You must be signed in to change notification settings - Fork136
dgrunwald/rust-cpython
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Warning: this package is no longer actively maintained.Please switch toPyO3 instead.
Rust bindings for thepython interpreter.
- Documentation
- Cargo package:cpython
Copyright (c) 2015-2021 Daniel Grunwald.Rust-cpython is licensed under theMIT license.Python is licensed under thePython License.
Supported Python versions:
- Python 2.7
- Python 3.7 to 3.12
Warning: this package is no longer actively maintained.Please switch toPyO3 instead.
Requires Rust 1.41.1 or later.
To usecpython
, add this to yourCargo.toml
:
[dependencies]cpython ="0.7"
use cpython::{Python,PyDict,PyResult};fnmain(){let gil =Python::acquire_gil();hello(gil.python()).unwrap();}fnhello(py:Python) ->PyResult<()>{let sys = py.import("sys")?;let version:String = sys.get(py,"version")?.extract(py)?;let locals =PyDict::new(py); locals.set_item(py,"os", py.import("os")?)?;let user:String = py.eval("os.getenv('USER') or os.getenv('USERNAME')",None,Some(&locals))?.extract(py)?;println!("Hello {}, I'm Python {}", user, version);Ok(())}
The following two files will build withcargo build
, and will generate a python-compatible library.On Mac OS, you will need to rename the output from *.dylib to *.so.On Windows, you will need to rename the output from *.dll to *.pyd.
At build timepython3-sys/build.rs
will look for interpreters in:
PYTHON_SYS_EXECUTABLE
python
python3
picking the first one that works and is compatible with the configured expected version (by default, any Python 3.X interpreter will do). If a specific interpreter is desired, thePYTHON_SYS_EXECUTABLE
environment variable should point to it.
Cargo.toml
:
[lib]name ="rust2py"crate-type = ["cdylib"][dependencies.cpython]version ="0.7"features = ["extension-module"]
src/lib.rs
use cpython::{PyResult,Python, py_module_initializer, py_fn};// add bindings to the generated python module// N.B: names: "rust2py" must be the name of the `.so` or `.pyd` filepy_module_initializer!(rust2py, |py, m|{ m.add(py,"__doc__","This module is implemented in Rust.")?; m.add(py,"sum_as_string", py_fn!(py, sum_as_string_py(a:i64, b:i64)))?;Ok(())});// logic implemented as a normal rust functionfnsum_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.// Note that the py_fn!() macro automatically converts the arguments from// Python objects to Rust values; and the Rust return value back into a Python object.fnsum_as_string_py(_:Python,a:i64,b:i64) ->PyResult<String>{let out =sum_as_string(a, b);Ok(out)}
On windows and linux, you can build normally with cargo build --release. On Mac Os, you need to set additional linker arguments. The simplest solution 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",]
Forsetup.py
integration, seehttps://github.com/PyO3/setuptools-rust
To build the crate, run:make build
To test the crate, run:make test
Note: This crate has several files that are auto-generated using scripts. Using the Makefile ensures that thesefiles are re-generated as needed.
About
Rust <-> Python bindings
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.