PyO3でPythonからRustで作ったライブラリを呼ぶ

#PyO3  #Rust  #シミュレーション  #Python 

Python，手軽で便利ライブラリたくさんあって良いですね．
Rust，厳格で素早くて良いですね．

一緒に使えれば素晴らしいですね¹．

ということで，これを実現するライブラリであるPyO3を使ってみました²．他にもrust-cpythonも有名ですが，更新頻度やスター数からPyO3に勢いが出ているので，今回はPyO3を選びました．

Rustのバージョンはrustc 1.34.0-nightlyで試しました．nightly³じゃないとPyo3は動かないようです．なぜならspecializationを使ってるから．（この点rust-cpythonはstableで動くんですけどねー．それでもPyO3の方がスターが多くなるのはこの界隈が良い意味で発展中ということなのかな）

まずは
cargo new python_rust_example --lib
でライブラリ用のプロジェクトを作ります．

それから，Cargo.tomlに

[package]
name = "python_rust_example"
version = "0.1.0"

[lib]
name = "python_rust_example"
crate-type = ["cdylib"]

[dependencies.pyo3]
version = "0.5.2"
features = ["extension-module"]

と記述します．ここで，バージョン0.5.2を指定したのは次の記事でNumPyと一緒に使うためのバージョン合わせです（あと，最新バージョンのReadme.mdのサンプルが動かなかったのも理由としてある）

そして，試しに値を2つ渡して和を返す関数として，

#![feature(proc_macro)]

extern crate pyo3;
use pyo3::prelude::*;

#[pymodinit]
fn python_rust_example(_py: Python, m: &PyModule) -> PyResult<()> {
    #[pyfn(m, "add_double")]
    fn add_double_py(_py: Python, a: f64, b: f64) -> PyResult<f64> {
        Ok(a + b)
    }

    Ok(())
}

のようにadd_double()を作ります．pyfn()に渡す文字列引数がpythonから呼ぶときの関数名となります．

次にビルドします．

ここで，Macユーザーは.cargo/config（.cargoがなければmkdirする）に

[target.x86_64-apple-darwin]
rustflags = [
    "-C", "link-arg=-undefined",
    "-C", "link-arg=dynamic_lookup",
]

としてコンパイル時のパラメータを渡してやる必要がある模様．

そして，cargo build --releaseでビルド！

ビルド完了したら，Macユーザーは

cp targets/release/libpython_rust_example.dylib python_rust_example.so

Linuxユーザーは

cp targets/release/libpython_rust_example.so python_rust_example.so

Windowsユーザーはtargets/release/libpython_rust_example.dllをstring_sum.pydへコピー．

あとは最後にPythonシェルで

>>> from python_rust_example import add_double
>>> add_double(3, 5)
8.0
>>> add_double('hoge', 2)
Traceback (most recent call last):
  File "<input>", line 1, in <module>
    add_double('hoge', 2)
TypeError: must be real number, not str

と確認して完了．ちゃんと他の型を渡すとエラーを出してくれますね．

次: PyO3とrust-numpyを使ってPythonからNumPyをRustに渡して操作する