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

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

本文关键字：成员 pybind11 访问 方法 指针 一个对象 可以使 包装 c++ python 我可以      更新时间：2023-10-16

我有一个 c++ 类，称之为Example，我想使用 pybind11 将其包装到 Python 中。示例包含一个成员，它是一个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();
}

像这样的一些包装是我想要包装的; 这是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的答案为我解决了！

这可以通过首先导出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(); });
}
相关文章：