Pybind11:用指针成员包装结构?
Pybind11: Wrap a struct with a pointer member?
我有以下结构需要包装
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 文档时,我找不到如何处理结构中的指针。
我之前所做的是围绕 dataStruct
编写一个包装器结构,您将其暴露给 Python。这将允许您保留矢量的额外副本作为实际 Python 列表。
struct dataStructPy : dataStruct {
const py::list & data_py;
}
然后您可以将 data_py
设置为 属性 而不是读写,并且您可以编写 get/set 函数在 std::vector
和 [=17= 之间进行转换].这允许您在 C++ 端使用 std::vector
,而在 Python 端使用标准 Python list
。这些函数可能看起来像:
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 访问向量的内存。
我有以下结构需要包装
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 文档时,我找不到如何处理结构中的指针。
我之前所做的是围绕 dataStruct
编写一个包装器结构,您将其暴露给 Python。这将允许您保留矢量的额外副本作为实际 Python 列表。
struct dataStructPy : dataStruct {
const py::list & data_py;
}
然后您可以将 data_py
设置为 属性 而不是读写,并且您可以编写 get/set 函数在 std::vector
和 [=17= 之间进行转换].这允许您在 C++ 端使用 std::vector
,而在 Python 端使用标准 Python list
。这些函数可能看起来像:
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 访问向量的内存。