使用PyO3从Python调用 Rust:加速Python

21-11-25 banq

使用 Rust 加速你的 Python:PyO3使从 Python 调用 Rust 代码变得容易。您可以编写 Rust 库,并依靠 PyO3 和生态系统中maturin的支持工具的组合PyO3来编译 Rust 库并将其作为 Python 模块直接安装。其中,PyO3 可以在 Python 和 Rust 之间转换类型,并且可以通过一组宏轻松地将 Rust 函数导出到 Python。

在这篇博文中,我将简要介绍 PyO3。之后,我将讨论几个用 Rust 编写并从 Python 调用的示例函数。这些例子包括:

  • 在 Python 和 Rust 中计算第 n 个斐波那契数
  • 让 Python 在 Rust 函数中使用多种类型
  • 在 Python 代码中使用 Rust 结构
  • 使用 Python 将 JSON 发送到 Rust 并将该 JSON 序列化为结构
  • 允许 Rust 从 Python 运行时使用记录器
  • 在 Rust 中生成错误并将其作为异常在 Python 中捕获

 

PyO3 简介

PyO3 为想要将 Rust 和 Python 代码粘合在一起的人们提供了一些人体工程学设计。它可以帮助您从 Rust 调用 Python 代码以及从 Python 调用 Rust 代码。由于我只使用它从 Python 调用 Rust 代码,这是我在这里写的唯一内容。

那么 PyO3 给你什么?

首先,有maturin。该工具将为您编译 Rust 代码,并将编译后的代码作为 Python 模块安装在您的虚拟环境中。之后,您可以在 Python 代码中导入此模块并使用它。在您pip install maturin 之后,您只需要运行 1 个命令 ( maturin develop ) 即可在 Python 中使用 Rust 代码。

除了maturin,当然还有 PyO3 本身。PyO3 为 Python 解释器提供 Rust 绑定。这使得您不必真正为 Python 和 Rust 之间的交互而烦恼。例如,您不必担心如何在 C 中将 Python 字符串转换为某些内容,然后在 Rust 中再次转换为其他内容。整数、浮点数、列表、字典等也是如此。为了方便起见,PyO3 附带了许多宏,可以防止您编写过多的样板代码。要将 Rust 函数公开给 Python,您可以使用宏注释它们。在此之后,PyO3 将负责其余的工作。如果您想导出结构或方法,这同样适用。

 

从 Python 调用 Rust 函数

在第一个示例中,我们将从 Python 调用 Rust 乘法函数。通常,我们可以这样写:

fn multiply(a: isize, b: isize) -> isize {
    a * b
}

在不添加太多东西的情况下,我们可以让这个函数从 Python 中调用。首先,我们需要:

  • 引入pyo3 prelude
  • 注释函数#[pyfunction]以将其转换为 PyCFunction
  • 将结果包装在一个 PyResult
  • 将函数添加到 #[pymodule]

下面的代码以相同的顺序说明了上述步骤:

use pyo3::prelude::*;

#[pyfunction]
fn multiply(a: isize, b: isize) -> PyResult<isize> {
    Ok(a * b)
}

#[pymodule]
fn rust(_py: Python, m: &PyModule) -> PyResult<()> {
    m.add_function(wrap_pyfunction!(multiply, m)?)?;
    Ok(())
}

以上将在一个名为rust(在最后一个函数的名称之后)的Python 模块中公开乘法函数。我们还需要放置适当的Cargo.toml文件。

为方便起见,请确保 Cargo.toml 中库的名称与使用#[pymodule]. 在我的示例中,我将以下内容放入我的Cargo.toml:

[lib]
name = "rust"

当这两个名称匹配时,maturin构建工具将使用该名称将 Rust 库安装为 Python 模块。

因此,在这种情况下,选择rust作为包的名称,我们可以编写以下 Python 来调用乘法函数:

import rust

result = rust.multiply(2, 3)
print(result)

为了能够运行此代码,我们需要编译 Rust 代码并将其安装为 Python 库。这是maturin进来的地方:

root@rust:/# git clone https://github.com/saidvandeklundert/pyo3.git
Cloning into 'pyo3'...
remote: Enumerating objects: 36, done.
    ...
Resolving deltas: 100% (9/9), done.
root@rust:/# cd pyo3/multiply/
root@rust:/pyo3/multiply# python3 -m venv .env
root@rust:/pyo3/multiply# source .env/bin/activate
(.env) root@rust:/pyo3/multiply# pip install maturin
Collecting maturin
    ...
Installing collected packages: toml, maturin
Successfully installed maturin-0.11.5 toml-0.10.2
(.env) root@rust:/pyo3/multiply# maturin develop
 Found pyo3 bindings
 Found CPython 3.9 at python
   Compiling proc-macro2 v1.0.32
    ...
   Compiling multiply v0.1.0 (/pyo3/multiply)
    Finished dev [unoptimized + debuginfo] target(s) in 23.48s
(.env) root@rust:/pyo3/multiply# python3 multiply.py
6

现在我可以运行这个脚本::

(.env) root@rust: multiply# python3 multiply.py
6

更多点击标题

猜你喜欢