如何为继承Python内置类的PyO3 pyclass实现IntoPyObject

当你用PyO3定义继承Python内置类（比如PyException）的pyclass时，自动生成的IntoPyObject实现会失效，而派生#[derive(IntoPyObject)]会把结构体转换成PyDict而非自定义类实例。要解决这个问题，需要手动实现IntoPyObject trait，核心是通过PyCell::new创建包含父类实例的自定义类对象。

完整实现代码 #

use pyo3::{exceptions::PyException, prelude::*, types::PyDict};

#[pyclass(extends=PyException)]
#[derive(Debug)]
pub struct Foo {
    bar: i64,
}

// 手动实现IntoPyObject trait
impl IntoPyObject for Foo {
    fn into_pyobject(self, py: Python<'_>) -> PyResult<PyObject> {
        // 初始化父类PyException实例，可根据需求传递错误信息或参数
        let parent_instance = PyException::new_err("Custom exception message");
        
        // 创建自定义类的PyCell，将自身数据与父类实例绑定
        let py_cell = PyCell::new(py, self, Some(parent_instance.into()))?;
        
        // 将PyCell转换为PyObject返回
        Ok(py_cell.into())
    }
}

#[pyfunction]
pub fn foo2(py: Python) -> PyResult<Bound<'_, Foo>> {
    let foo = Foo { bar: 1 };
    // 调用手动实现的into_pyobject获取PyObject
    let py_obj = foo.into_pyobject(py)?;
    
    // 将PyObject转换为Bound<Foo>类型（更安全的绑定GIL的对象）
    let bound_foo = py_obj.extract_bound(py)?;

    println!("{:?}", bound_foo);  // 输出：<builtins.Foo object at 0x...>
    println!("{:?}", bound_foo.get_type());  // 输出：<class 'builtins.Foo'>
    
    // 验证父类属性是否可访问
    let args = bound_foo.as_ref().getattr("args")?;
    println!("Exception args: {:?}", args);

    Ok(bound_foo)
}

关键步骤说明 #

1. 初始化父类实例：先创建继承的内置类（这里是PyException）的实例，可根据需要传入初始化参数（比如错误信息）。
2. 创建PyCell：通过PyCell::new把自定义结构体、父类实例结合，生成绑定GIL的自定义类对象。第三个参数Some(parent_instance.into())用于关联父类。
3. 转换为PyObject：将PyCell转换为PyObject，满足IntoPyObject trait的返回要求。
4. 转换为Bound类型：如果需要更安全的类型绑定，用extract_bound把PyObject转成Bound<'_, Foo>，方便后续操作。

为什么派生IntoPyObject会失效 #

#[derive(IntoPyObject)]对结构体的默认实现是把每个字段映射为字典的键值对，返回PyDict实例，这和继承父类的自定义类实例完全不是同一个东西，所以无法满足需求。

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