简介
本章节将介绍如何使用 Rust 编写 Python 扩展模块。通过使用 PyO3 库，开发者可以充分利用 Rust 的高性能和安全性来扩展 Python 应用程序的功能。
安装 PyO3
安装 Rust 和 Cargo
首先确保你的系统上已经安装了 Rust 和 Cargo。可以通过以下命令安装：
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
安装完成后，需要重启终端或重新加载 shell 配置文件，使安装生效。
创建一个新的 Rust 项目
创建一个新项目并添加 PyO3 依赖：
cargo new my_python_extension cd my_python_extension
在 Cargo.toml 文件中添加 PyO3 依赖：
[dependencies.pyo3] version = "0.16" features = ["extension-module"]
配置项目
在项目的 src/lib.rs 文件中，你需要做一些基本的配置。以下是一个简单的示例，展示了如何定义一个简单的 Python 函数：
// www.javascriptcn.com code example
use pyo3::prelude::*;
use pyo3::wrap_pyfunction;
/// Formats the sum of two numbers as a string.
#[pyfunction]
fn sum_as_string(a: usize, b: usize) -> PyResult<String> {
Ok(format!("The sum of {} and {} is {}", a, b, a + b))
}
/// A Python module implemented in Rust.
#[pymodule]
fn my_python_extension(_py: Python, m: &PyModule) -> PyResult<()> {
m.add_function(wrap_pyfunction!(sum_as_string, m)?)?;
Ok(())
}编译和测试扩展
编译
你可以通过 Cargo 来编译你的 Rust 项目，并生成对应的 Python 扩展模块：
cargo build --release
测试
生成的扩展模块将会被放置在 target/release/ 目录下。为了测试这个扩展，你需要在 Python 中导入并调用它。首先，创建一个 Python 脚本来测试扩展模块：
import my_python_extension print(my_python_extension.sum_as_string(10, 20))
运行这个脚本：
python test.py
你应该会看到输出结果：
The sum of 10 and 20 is 30
这表明你的 Rust 编写的 Python 扩展模块已经成功工作了。
更复杂的示例
类的实现
除了简单的函数，你还可以定义类并在 Python 中使用它们。以下是一个简单的示例：
// www.javascriptcn.com code example
use pyo3::prelude::*;
use pyo3::types::PyModule;
/// A Python class implemented in Rust.
#[pyclass]
struct Greeter {
#[pyo3(get, set)]
greeting: String,
}
#[pymethods]
impl Greeter {
#[new]
fn new(greeting: &str) -> Self {
Greeter { greeting: greeting.to_string() }
}
fn greet(&self, name: &str) -> PyResult<String> {
Ok(format!("{} {}", self.greeting, name))
}
}
#[pymodule]
fn my_python_extension(_py: Python, m: &PyModule) -> PyResult<()> {
m.add_class::<Greeter>()?;
Ok(())
}在 Python 中使用这个类
import my_python_extension
greeter = my_python_extension.Greeter("Hello")
print(greeter.greet("World"))这将输出：
Hello World
错误处理
处理 Rust 错误
在 Rust 中，错误通常通过返回 Result<T, E> 类型来处理。在 PyO3 中，你可以将这些错误转换为 Python 异常。例如：
#[pyfunction]
fn divide(a: i32, b: i32) -> PyResult<f64> {
if b == 0 {
return Err(pyo3::exceptions::PyZeroDivisionError::new_err("division by zero"));
}
Ok(a as f64 / b as f64)
}在 Python 中捕获异常
在 Python 中，你可以像处理任何其他异常一样处理这些异常：
import my_python_extension
try:
print(my_python_extension.divide(10, 0))
except Exception as e:
print(f"An error occurred: {e}")这将输出：
An error occurred: division by zero
总结
通过以上步骤，我们介绍了如何使用 Rust 和 PyO3 来编写 Python 扩展模块。从简单的函数到更复杂的类定义，再到错误处理，PyO3 提供了丰富的工具和 API，使得这一过程变得简单而高效。希望本章节的内容能帮助你在实际项目中应用 Rust 和 PyO3。