首页 > 解决方案 > Pybind11:用指针成员包装结构?

问题描述

我有以下需要包装的结构

struct dataStruct {
    const std::vector<int>& data;
    bool valid_data = true;
}

在我的包装文件中,PYBIND11_MODULE我有

py::class_<dataStruct>(m, "dataStruct")
   .def(py::init<>())
   .def_readwrite("data", &dataStruct::data)
   .def_readwrite("valid_data", &dataStruct::valid_data);

我收到两个错误

no instance of function template "pybind11::class_<type_, options...>::def_readwrite [with type_=dataStruct, options=<>]" matches the argument list -- argument types are: (const char [7], <error-type>) -- object type is: pybind11::class_<dataStruct>

pointer to member of type "const std::vector<int, std::allocator<int>> &" is not allowed

我知道这是由于结构中的指针,但是在查看 pybind11 文档时,我不知道如何处理结构中的指针。

标签: c++pointersstructpybind11

解决方案


我之前所做的就是围绕dataStruct你暴露给 Python 编写一个包装器结构。这将允许您将向量的额外副本保留为实际的 Python 列表。

struct dataStructPy : dataStruct {
    const py::list & data_py;
}

然后,您可以将其设置data_py为属性而不是读写,并且可以编写在std::vector和之间进行转换的 get/set 函数py::list。这允许您std::vector在 C++ 端使用 a ,同时list在 Python 端使用标准 Python。此类函数可能如下所示:

py::list dataStructPy::data_py_get()
{
    py::list list;
    for(const auto & x : this->data) {
        list.append(x);
    }

    return list;
}

void dataStructPy::data_py_set(const py::list & data_py)
{
    this->data.clear();
    for(int i = 0; i < py::len(data_py); ++i) {
        this->data.emplace_back(data_py[i]);
    }
}

然后你可以暴露dataStructPy给 Python 并调用它dataStruct(你可以看到我们仍然暴露&dataStruct::valid_data):

py::class_<dataStructPy>(m, "dataStruct")
   .def(py::init<>())
   .def_readwrite("valid_data", &dataStruct::valid_data);
   .add_property("data", &dataStructPy::data_py_get, &dataStructPy::data_py_set);

在 Python 中,执行以下操作

x = dataStruct()
x.data = [1, 2, 3, 4]

将导致 C++x.data_py = py::list{1, 2, 3, 4};x.data = std::vector{1, 2, 3, 4};

注意:这仅适用于赋值运算符 (=)。如果在 Python 方面,如果你这样做x.data[3] = 5 ,它不会更新 C++ 向量,为此你需要创建一个对象,该对象使用 [] 运算符从 Python 访问向量的内存。


推荐阅读