python-with-rust 0.1.4

Python 调用 Rust 的示例

python_with_rust

演示 Python 如何调用一个 Rust 项目

1. Python 传给 Rust 这些数据结构：str, int, float, list, dict 等
2. Rust 返回给 Python 这些数据结构：String, i32, f64, Vec, Vec
3. Python 使用 Rust 类
4. 把 Python 项目发布，并且兼容多种操作系统

说明

• 自从 PEP 518 以来，pyproject.toml 是比 setup.py 更为先进的构建文件。
• 使用 setup.py 管理方式见于分支 use_setup.py，main 分支使用 pyproject.toml

一、安装

两种方式

• 几个环境可以用 pip install python_with_rust==0.1.3

1. 安装 rust、Python（略），升级
2. 安装必要的包

pip install maturin

3. 从 pypi 安装 python_with_rust

pip install python_with_rust
# 或者在本地安装
matruin develop

说明：为了防止包的数量过多，有些情况没在 pypi 上托管。但是你仍然可以下载仓库后，在本地安装。

这些系统没有在 pypi 上托管（uname -m 查询架构， python -c "import platform; print(platform.machine())" 查询环境）：

• macos x86 版本（也就是 Intel 的 MacBook）
• 虽然是 M 系列处理器，但是 python 环境是通过 Rosetta 2 以 Intel 模拟模式运行的
• Linux 的 glibc 版本为 2.34，低版本的没有在 pypi 上

二、测试

测试

python examples/example1.py # 测试可以调用 Python 函数
python examples/example2.py # 测试可以调用 Rust 函数
python examples/example3.py # 测试相互传递 list、string 等数据
python examples/example4.py # 测试可以调用 Rust 类

三、说明

• ./my_rust_project1 是一个纯 Rust 项目
• ./my_rust_project 是一个中间层，它使用 pyo3，调用 my_rust_project1 并被 Python 调用
  • 目的是让 ./my_rust_project1 不用考虑被 python 调用时的各种问题，成为纯粹的 Rust 项目，不被 pyo3 污染
• 但是在中间层 ./my_rust_project 执行 cargo build 会失败（可能与什么配置有关）
• 另一个方案是 ffi 方法，使用 C 标准编译 my_rust_project1，编译后的代码可以被 Python(ctypes)/C/Rust/Java 调用。具体参见 郭飞的笔记
  • 缺点是需要自定义数据类型，并有内存泄露的风险。优点是某些情况下潜在性能更高
  • 使用 pyo3 是以一个比较好的实践，这个项目展示使用 pyo3 的方案

关于名称

• 使用 python 的 from python_with_rust import my_rust_project 时，这里的 my_rust_project 对应的是 ./my_rust_project/src/lib.rs 中 #[pymodule] 定义的那个函数
• setup.py 中的 RustExtension("python_with_rust.my_rust_project") 对应的是安装后的文件夹名、.so 文件名。为了防止混乱，最好取值为 python 项目名、Rust 项目名