c++ - 如何在 native 回调中使用 Cython cdef 类成员方法

Question

我有一个主要由回调驱动的 C++ 库。回调被注册为 std::function 实例。

回调注册函数可能类似于:

void register(std::function<void(int)> callback);

我可以通过创建 libcpp.functional.function 对象来注册纯 cdef 函数。假设我有这个回调:

cdef void my_callback(int n):
    # do something interesting with n

我可以注册成功:

cdef function[void(int)]* f_my_callback = new function[void(int)](my_callback)
register(deref(f_my_callback))

问题是我想将 cdef class methods 注册为回调。假设我有一节课:

cdef class MyClass:

    cdef function[void(int)]* f_callback
    py_callback = lambda x: None

    # some more init/implementation

    def __init__(self):
        # ** this is where the problem is **
        self.f_callback = new function[void(int)](self.member_callback)
        register(deref(self.f_callback))

    cdef void member_callback(self, int n) with gil:
        self.py_callback(n)

    def register_py(self, py_callback):
        self.py_callback = py_callback

self.f_callback = new function[void(int)](self.member_callback) 行不起作用，因为 function[T] 构造函数正在查看MyClass 参数(self)。在常规 python 中，执行 self.member_callback 基本上等同于将 self 部分应用于 MyClass.member_callback，所以我认为这会很好，但事实并非如此。

我做了一个typedef:

ctypedef void (*member_type)(int)

然后如果我转换，我可以让它编译:

self.f_callback = new function[void(int)](<member_type>self.member_callback)

但是当回调真正进来时，一切都坏了。对 self 做任何事情都会导致段错误。

将 cython 类成员方法作为 C/C++ 回调传递的“正确”方法是什么？

编辑:

澄清一下，这个问题具体是关于将成员方法(即以self 作为第一个参数的函数)传递给需要 类型参数的C++ 函数std::function.

如果我用 @staticmethod 修饰 member_callback 并删除所有对 self 的引用，它就会按预期工作。不幸的是，该方法需要访问 self 才能正确执行类实例的逻辑。

Answer 1

std::function可以接受一系列参数。在其最简单的形式中，它采用直接映射到其模板类型的函数指针，这就是它的 Cython 包装器真正设置来处理的所有内容。为了包装 C++ 成员函数，您通常会使用 std::mem_fun或 std::mem_fun_ref获取相关类实例的拷贝或引用(在现代 C++ 中，您也可以选择 lambda 函数，但这实际上只会为您提供相同的选项)。

将其转换为 Python/Cython 你需要持有一个 PyObject*到您正在调用其成员的对象，随之而来的是自己处理引用计数的责任。不幸的是，Cython 目前无法为您生成包装器，因此您需要自己编写一个容器。本质上，您需要一个可调用对象来处理引用计数。

在a previous answer我展示了两种创建这种包装器的方法(一种是手动的，第二种是通过使用已经实现了非常相似的东西的 Boost Python 来节省工作量)。我在那里展示的方案适用于匹配相关签名的任何 Python 可调用。尽管我用标准的 Python 模块级函数对其进行了说明，但自 instance.memberfunction 以来，它对于成员函数同样适用。生成一个绑定(bind)成员函数 - 一个同样有效的 Python 可调用函数。

对于您的问题，唯一的区别是您使用的是 cdef成员函数而不是 def成员函数。这看起来应该有效，但实际上无效(最近版本的 Cython 尝试自动转换为 Python 可调用对象，但由于运行时错误而失败)。您可以创建一个 lambda 函数作为一个非常简单的包装器。从速度的角度来看，这有点不太理想，但具有使用现有代码的优势。

您需要对之前的答案进行如下修改:

• 如果您尝试使用手册 PyObjectWrapper version 然后更改参数类型以匹配您的签名(即将 int, string& 更改为 int )。对于提升版本，您不必执行此操作。

• void register(std::function<void(int)> callback); 的包装器需要:

  cdef extern from "whatever.hpp":
    void register(PyObjWrapper)
    # or
    void register(bpo)
  

  取决于您使用的版本。这在签名方面对 Cython 撒谎，但由于这两个对象都是可调用的 C++ 对象，它们会自动转换为 std::function。由 C++ 编译器。

• 调用register作为register(PyObjWrapper(lambda x: self.member_callback(x)))或 register(get_as_bpo(lambda x: self.member_callback(x))) .

---

有可能创建一个更高效的版本，专门针对使用 cdef功能。它将基于一个与 PyObjWrapper 非常相似的对象。 .但是，鉴于我已经编写的代码可以工作，我不愿意在没有明确理由的情况下这样做。