rustdef
Jupyter extension for jupyter notebook and rust user.
You can define functions in rust and run them as python functions. This extension is built on PyO3 and maturin.
Examples
Prerequisite
- Python >= 3.6 and pip >= 19.3
- Jupyter notebook
- Rust
- cargo-edit
Install
$ pip install rustdef
Usage
Define rust functions,
%%rustdef
#[pyfunction]
fn my_func(x: i64, y: &str) -> i64 {
println!("{}", y);
x + y.len() as i64
}
Add dependencies, (e.g. num crate)
%rustdef deps add [email protected]
Defined dependencies are valid only in the current notebook.
Show dependencies,
%rustdef deps show
num = "0.4.0"
[pyo3]
version = "0.13.2"
features = [ "extension-module",]
pyo3 is included by default.
Develop
How it works?
Roughly, definitions in rustdef are available in python after the following steps.
- Each rustdef magic cell is populated with module definition of pyo3
- A new crate is generated for the rustdef cell
- The crate is compiled into a python wheel by
maturin - Install the wheel with pip
- Functions with
#[pyfunction]attributes are exported into interpreter name space in notebook - Ready to call the function in notebook!
Build
maturin is required.
$ pip install maturin
$ maturin build
$ pip install target/wheels/rustdef-{version}-{python}-{platform}.whl
ToDo
- execute within rustdef cell
- class/module supports
- customizable module name
- use functions defined in another cell
- verbose flag
- serde support
- windows support
10 Jan 1, 2023
2 Nov 16, 2022
22 Apr 4, 2023
315 Apr 10, 2023
6 Jun 12, 2023
3 Jul 28, 2023
3 Dec 1, 2023
4 Feb 16, 2024
20 Nov 11, 2022
8.7k Dec 31, 2022
326 Dec 21, 2022
1 Apr 10, 2022
13 Dec 6, 2022
7 Mar 30, 2023
4 May 4, 2023
6 May 14, 2023
242 Jul 5, 2023
252 Sep 7, 2023
529 Dec 4, 2023