使用Pybind11

时间:2017-09-01 21:29:11

标签: python c++ pybind11

我想要包装一个C ++函数(使用Pybind11),该函数返回一个STL容器,该容器本身包含在一个智能指针中。一个例子如下所示。该函数已重载,因此我必须指定签名。

#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include "my_class.h"

typedef std::array<std::complex<double>, 4> ArrayComplex4;
PYBIND11_MAKE_OPAQUE(ArrayComplex4);

namespace py = pybind11;
using namespace my_namespace;

PYBIND11_MODULE(my_module, m) {
    py::class_<MyClass>(m, "MyClass", py::dynamic_attr())
        .def("my_function", (std::unique_ptr<ArrayComplex4> (MyClass::*)(double)) &MyClass::my_function)
        .def("my_function", (std::unique_ptr<ArrayComplex4> (MyClass::*)(double, double)) &MyClass::my_function);
}

模块将编译,但当我尝试在Python中使用该函数时会出错:

  

TypeError:无法将函数返回值转换为Python类型!

我确定我只是为Pybind11设置错误。谢谢你的帮助!

修改

问题肯定在于我尝试绑定std::Array数据类型。我最后修改代码以使用std::Vector,然后Pybind11没有问题。请参阅下面的AS Mackey的答案,了解如何绑定std::Array容器。

1 个答案:

答案 0 :(得分:1)

问题可能在于对ArrayComplex4数据结构的PYBIND11_MAKE_OPAQUE处理,我无法解决这个问题,但是当我有时间的时候我会再看一下它。

以下代码,我确实开始工作,是我到目前为止最接近你的设计。我使用了一个额外的用户定义数据结构来包装std :: elements:

#include <pybind11/pybind11.h>
#include <pybind11/complex.h>
#include <pybind11/stl.h>
#include <memory>
#include <complex>
#include <array>
#include <cmath>

namespace py = pybind11;


typedef std::array<std::complex<double>, 4> ArrayComplex4;

struct ArrayComplex4Holder
{
    ArrayComplex4 data;
    ArrayComplex4 getData() { return data; }
};

class MyClass {
public:
    MyClass() { }
    std::unique_ptr<ArrayComplex4Holder> my_function(double x)
    {
        std::unique_ptr<ArrayComplex4Holder> ph( new ArrayComplex4Holder());
        ph->data[0] = std::complex<double>(x);
        return ph;
    }
    std::unique_ptr<ArrayComplex4Holder> my_function(double x, double y)
    {
        std::unique_ptr<ArrayComplex4Holder> ph( new ArrayComplex4Holder());
        ph->data[0] = std::complex<double>(x);
        ph->data[1] = std::complex<double>(y);
        return ph;
    }
};

PYBIND11_MODULE(example, m) {
    m.doc() = "pybind11 example"; // optional module docstring

    py::class_<ArrayComplex4Holder>(m, "ArrayComplex4Holder")
            .def(py::init<>())
            .def("getData", &ArrayComplex4Holder::getData);

    py::class_<MyClass>(m, "MyClass")
            .def(py::init<>())
            .def("my_function", (std::unique_ptr<ArrayComplex4Holder> (MyClass::*)(double))         &MyClass::my_function)
            .def("my_function", (std::unique_ptr<ArrayComplex4Holder> (MyClass::*)(double, double)) &MyClass::my_function);
}

注意,我发现需要额外的pybind #includes来使python转换工作。

简单的python代码是:

import sys
sys.path.append('/Volumes/RAID 1/Projects/workspace/Project CPP 1')
import example

p = example.MyClass()
print (p.my_function(1.2345).getData())
print (p.my_function(1.2345, 6.7890).getData())

这会产生以下输出,看起来是正确的:

[(1.2345+0j), 0j, 0j, 0j]
[(1.2345+0j), (6.789+0j), 0j, 0j]

我希望这能为你提供一个起点。我有兴趣知道你是否找到了更好的选择......问候,AS