pybind11封装函数传引用修改Python列表未生效的解决方法

核心原因 #

当你用pybind11暴露接收std::vector<T>&的C类方法时，默认情况下pybind11会将Python列表转换为**临时的C vector拷贝**，函数修改的是这个拷贝而非原Python列表对应的底层对象，因此修改无法同步回Python。

正确简便的解决方法 #

1. 正确绑定自定义结构体/类 #

如果你的vector元素是自定义结构体或类，需用py::class_完整绑定成员，确保可读写：

// 自定义结构体示例
struct MyStruct {
    int value;
    std::string name;
};

// 绑定到Python
void bind_mystruct(py::module_& m) {
    py::class_<MyStruct>(m, "MyStruct")
        .def(py::init<>())
        .def_readwrite("value", &MyStruct::value)
        .def_readwrite("name", &MyStruct::name);
}

使用def_readwrite而非def_readonly，保证C++和Python端的修改能双向同步。

2. 暴露方法时添加noconvert()参数 #

在绑定类方法时，给参数加上py::arg("vec").noconvert()，强制pybind11传递引用而非创建拷贝：

// 示例类
class MyClass {
public:
    void modify_vector(std::vector<MyStruct>& vec) {
        for (auto& item : vec) {
            item.value += 10; // 修改元素成员
        }
    }
};

// 绑定类及方法
void bind_myclass(py::module_& m) {
    py::class_<MyClass>(m, "MyClass")
        .def(py::init<>())
        .def("modify_vector", &MyClass::modify_vector,
             py::arg("vec").noconvert()); // 关键：避免拷贝，传递引用
}

3. Python端使用规范 #

确保传入的列表元素是通过pybind11创建的MyStruct实例，而非Python原生类型：

from my_module import MyClass, MyStruct

cls = MyClass()
data_list = [MyStruct(), MyStruct()]
data_list[0].value = 5
data_list[1].value = 15

cls.modify_vector(data_list)
print(data_list[0].value) # 输出15，修改生效

额外说明 #

如果需要支持Python原生类型（如列表内是int/dict），可以自定义类型转换器，但这种场景下最简便可靠的方式还是使用绑定后的C++对象实例，避免类型转换带来的拷贝问题。

内容的提问来源于stack exchange，提问作者Johann cohen-tanugi