PyO3暴露Rust结构体为Python类时f64 trait绑定报错求助

问题描述 #

我正尝试通过PyO3将Rust结构体暴露为Python类，编写的代码如下：

use pyo3::prelude::*;
use std::sync::Arc;
use indexmap::set::IndexSet;
use ndarray::{Array1, Array};

#[pyclass]
#[derive(Clone, Debug)]
pub struct Dual {
    real : f64,
    vars : Arc<IndexSet<String>>,
    dual : Array1<f64>,
}

#[pymethods]
impl Dual {
    fn new(real: f64, vars: Vec<String>, dual: Vec<f64>) -> Self {
        let new_dual;
        if dual.len() != 0 && vars.len() != dual.len() {
            panic!("`dual` must have same length as `vars` or have zero length.")
        } else if dual.len() == 0 && vars.len() > 0 {
            new_dual = Array::ones(vars.len());
        } else {
            new_dual = Array::from_vec(dual);
        }
        Self {
            real: real,
            vars: Arc::new(IndexSet::from_iter(vars)),
            dual: new_dual,
        }
    }

    fn __repr__(&self) -> String {
        return format!("<Dual: ... , [...], [...]>");
    }
}

执行maturin develop命令时，出现如下编译错误：

error[E0277]: the trait bound `f64: From<&PyCell<point::Dual>>` is not satisfied
  --> src\point\mod.rs:23:18
   |
23 |     fn new(real: f64, vars: Vec<String>, dual: Vec<f64>) -> Self {
   |                  ^^^ the trait `From<&PyCell<point::Dual>>` is not implemented for `f64`
   = help: the following other types implement trait `From<T>`:
             <f64 as From<bool>>
             <f64 as From<i8>>
             <f64 as From<i16>>
             <f64 as From<i32>>
             <f64 as From<u8>>
             <f64 as From<u16>>
             <f64 as From<u32>>
             <f64 as From<f32>>
   = note: required for `&PyCell<point::Dual>` to implement `Into<f64>`
   = note: required for `f64` to implement `TryFrom<&PyCell<point::Dual>>`

我无法理解该错误的成因，也不清楚为何基础浮点类型f64会触发此问题，恳请相关指点以解决问题。

问题原因 #

这个错误的核心是PyO3对#[pymethods]内方法的识别规则：PyO3默认会把#[pymethods]中的new方法当成Python实例方法（需要&self或&mut self作为第一个参数），但我们这里的new是构造函数，应该作为类方法存在。

当PyO3错误地将new视为实例方法时，它会自动把调用时的self（即&PyCell<Dual>）传入第一个参数位置，尝试转换为real: f64类型，这就导致了类型不匹配的错误——f64根本无法从&PyCell<Dual>转换而来。

解决方法 #

给new方法添加#[new]属性，明确告诉PyO3这是Python类的构造函数：

修改后的#[pymethods]代码：

#[pymethods]
impl Dual {
    #[new] // 关键标记：告知PyO3这是构造函数
    fn new(real: f64, vars: Vec<String>, dual: Vec<f64>) -> Self {
        let new_dual;
        if dual.len() != 0 && vars.len() != dual.len() {
            panic!("`dual` must have same length as `vars` or have zero length.")
        } else if dual.len() == 0 && vars.len() > 0 {
            new_dual = Array::ones(vars.len());
        } else {
            new_dual = Array::from_vec(dual);
        }
        Self {
            real: real,
            vars: Arc::new(IndexSet::from_iter(vars)),
            dual: new_dual,
        }
    }

    fn __repr__(&self) -> String {
        format!("<Dual: ... , [...], [...]>")
    }
}

额外说明 #

• PyO3中，只有标记了#[new]的方法才会被当作Python类的__new__方法（构造函数）处理，不需要self参数。
• 若没有#[new]标记，PyO3会默认把方法当作实例方法，自动插入self作为第一个参数，进而引发参数数量、类型不匹配的错误。

内容的提问来源于stack exchange，提问作者Attack68