如何将C ++类包装到python,以便我可以使用pybind11访问其成员的公共方法(该成员是对象指针)

时间:2019-11-28 11:51:22

标签: python c++ pybind11

我有一个c ++类,将其称为 Example ,我想使用pybind11将其包装到Python。 Example 包含一个成员,该成员是 MemberClassInterface 指针,将其称为 memberClass 。为 memberClass 分配了 MemberClass 的实例,该实例派生自 MemberClassInterface 。在python包装器中,我希望能够访问 memberClass 对象的公共方法,但不知道该怎么做。下面是我尝试在此处解释的结构。

class MemberClass : public MemberClassInterface{
  public:
    MemberClass();
    ~MemberClass();
    someFunc(); //virtual func in interface.
}
someFunc(){
//implementation..
}
class Example{
  public:
    Example();
    MemberClassInterface * memberClass;
}
Example(){
  this->memberClass = new MemberClass();
}

我想包装一些像这样的包装;这是不起作用的,但是我还没有找到方法。我也不具备c ++(或python)方面的最佳知识,因此也无法自行解决。

PYBIND_MODULE(pyexample,m){
  py::class_<Example>(m,"Example")
    .def(py::init<>())
    .def("memberClass", &Example::memberClass); <--- either something like this, or something like the
                                                     row below. 
    .def("someFunc", &Example::memberClass->someFunc); <-- how to achieve something similar to this?
                                                       It complains about someFunc not being non-static,
                                                       which I can understand...

}

我希望能够做到这一点:

>>> import pyexample
>>> a = pyexample.Example()
>>> a.memberClass.someFunc() <--- this is what I want to achieve.
>>> a.someFunc() <---- or possibly this. But this seems to require someFunc to be static.. 
                 or embedding memberClass.someFunc() into another function calling
                 memberClass.someFunc...

我没有包装的经验,因此感到很迷茫。 我没有给出完美的答案,但是如果有人有任何想法或可以引导我走向谈论这种包装的人或事物,我将不胜感激。


更新: pschill的答案为我解决了!

1 个答案:

答案 0 :(得分:1)

这可以通过首先导出MemberClassInterface来实现。下面的示例应该可以正常工作:

PYBIND11_MODULE(pyexample, m)
{
    pybind11::class_<MemberClassInterface>(m, "MemberClassInterface")
        .def("someFunc", &MemberClassInterface::someFunc);

    pybind11::class_<Example>(m, "Example")
        .def(pybind11::init())
        .def_readonly("memberClass", &Example::memberClass);
}

在python中的用法:

>>> import pyexample
>>> a = pyexample.Example()
>>> a.memberClass.someFunc()

如果您需要它,这是一个在我的计算机上成功编译的完整示例。我将memberClass重命名为member,因为发现变量名令人困惑。我还更改了指向unique_ptr的原始指针,因为它避免了一些所有权问题。为了使unique_ptr工作,我不得不将.def_readonly.def_property_readonly和lambda函数进行交换。

#include "pybind11/pybind11.h"
#include <iostream>
#include <memory>

class MemberClassInterface
{
public:
    virtual ~MemberClassInterface() = default;
    virtual void someFunc() = 0;
};

class MemberClass : public MemberClassInterface
{
public:
    virtual void someFunc() override
    {
        std::cout << "Hello from MemberClass" << std::endl;
    }
};

class Example
{
public:
    Example()
        :
        member(std::make_unique<MemberClass>())
    {}

    std::unique_ptr<MemberClassInterface> member;
};


PYBIND11_MODULE(pyexample, m)
{
    pybind11::class_<MemberClassInterface>(m, "MemberClassInterface")
        .def("someFunc", &MemberClassInterface::someFunc);

    pybind11::class_<Example>(m, "Example")
        .def(pybind11::init())
        .def_property_readonly("member", [](Example const& e) { return e.member.get(); });
}