如何在Python C/C++扩展中正确定义对象的str方法

安全阿岳

2026-7-19

解决C/C++ Python扩展中__str__实现无效的问题

问题根源

你遇到的问题核心在于：Python的特殊方法（如__str__）不能通过PyMethodDef方法表注册。虽然你把__str__加到了方法表里，导致直接调用myobj.__str__()能生效，但Python内置的str()函数、print()函数会优先查找自定义类型PyTypeObject结构体中的tp_str字段，而非方法表中的__str__条目，所以str(myobj)无法正常工作。

正确实现步骤

1. 在`PyTypeObject`中指定`tp_str`字段

修改你的自定义类型定义，将Foo_str函数赋值给tp_str字段，这是Python识别__str__特殊方法的标准方式：

static PyTypeObject FooType = {
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymodule.Foo",
    .tp_basicsize = sizeof(FooObject),
    .tp_flags = Py_TPFLAGS_DEFAULT,
    .tp_doc = "Foo objects",
    .tp_str = (reprfunc)Foo_str,  // 绑定__str__对应的实现函数
    .tp_methods = Foo_methods,    // 保留其他方法（如果有的话）
};

2. 从`PyMethodDef`中移除`str`条目

既然已经通过tp_str注册了特殊方法，无需再把__str__放到方法表里（保留也不会出错，但属于冗余操作）：

static PyMethodDef Foo_methods[] = {
    // 移除__str__的注册条目
    { NULL }  /* sentinel */
};

3. 确保函数签名匹配（可选优化）

tp_str对应的函数签名是PyObject* (*reprfunc)(PyObject*)，你可以调整Foo_str的签名以更贴合标准，避免类型转换的潜在问题：

static PyObject *
Foo_str(PyObject *self)
{
    // 如果需要访问FooObject的成员，可在此转换类型
    // FooObject *foo = reinterpret_cast<FooObject*>(self);
    return PyUnicode_FromFormat("bar");
}