如何将 c++ class 包装到 python 以便我可以使用 pybind11 访问其成员的 public 方法（成员是对象指针）

Question

我有一个 c++ class，将其命名为 Example，我想使用 pybind11 将其包装到 Python。 Example 包含一个成员，它是一个 MemberClassInterface 指针，称之为 memberClass。 memberClass 被分配了一个 MemberClass 的实例，它派生自 MemberClassInterface。在 python 包装器中，我希望能够访问 memberClass 对象的 public 方法，但不知道如何操作。下面是我试图在本文中解释的结构。

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();
}

像这样的一些包装是我要包装的；这是 obv 无法正常工作，但我还没有找到如何去做。我也不具备 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 的回答帮我解决了！

Answer 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(); });
}

如何将 c++ class 包装到 python 以便我可以使用 pybind11 访问其成员的 public 方法（成员是对象指针）

How to wrap a c++ class to python so that I can access its members' public methods (the member is an object pointer) using pybind11

c++

python

pybind11