Cython:带有自定义参数类型

时间:2017-08-29 16:19:44

标签: python c++ cython

请在回答之前阅读此帖:Pass a closure from Cython to C++

在接受的答案中,巧妙地展示了如何使用Boost Python将python函数转换为std::function

按照这个例子,我能够将std::function作为参数包装起来,并使用python函数作为输入来调用它们。但是,这仅适用于std::function参数是intdoublestring等原语的情况。

任何关于如何为自定义类型工作的指导都将受到高度赞赏。

1 个答案:

答案 0 :(得分:1)

这不是一个完整的答案 - 它假设您可以填写问题基于my previous answer的差距。不幸的是,它比这种情况稍微复杂一点。

仅定义问题 - 假设您有自定义C ++类的参数,例如:

class cpp_class {
  // some non-trivial contents
};

因此您的C ++界面如下所示:

void call_some_std_func(std::function<void(cpp_class&)> callback) {
    callback(5,std::string("hello"));
}

要做的第一件事就是为C ++类编写一个Cython包装器(原则上你可以改为使用Boost Python包装器)。在这里,您需要选择C ++对象的“所有权”。第一个选择是制作副本:

cdef extern from "cpp_file.hpp":
  cppclass cpp_class:
    pass # details

cdef class CyWrapper:
  cdef cpp_class* ptr
  def __dealloc__(self):
    del self.ptr
  # other details following standard wrapper pattern

cdef public make_CyWrapper(cpp_class& x):
  obj = CyWrapper()
  obj.ptr = new cpp_class(x)
  return obj

我创建了一个包装器类,它包含一个处理内存的析构函数和一个可以从外部代码调用的可公开访问的构造函数。这个版本是安全的,因为你的包装器拥有它所拥有的对象,所以不能写入无效的内存。但是,因为它创建了一个副本,所以无法对原始C ++对象进行更改。

第二个选项是保存指向您不拥有的对象的指针。代码基本相同,只是您删除__dealloc__并避免在make_CyWrapper中复制:

obj.ptr = &x // instead of new cpp_class(x)

这是不安全的 - 您需要确保C ++对象比Cython包装器更长 - 但允许您修改对象。

您还可以想象一些其他选项:您可以使用Cython包装器获取现有对象的所有权(这样的方案必须通过指针而不是引用传递,或者它可以使用移动构造函数);您可以将C ++类解构为基本类型表示的表示形式,并将其传递给Python;你可以使用共享指针来分割所有权;或者你有一个更复杂的方法,一旦你的C ++实例被破坏,你的Cython包装器就会被标记为“无效”。

你接下来要做什么取决于你是使用Boost Python(因为它方便,可调用的Python对象包装),还是你正在制作自己的版本。 (我在上一个答案中展示了两种可能性。)

假设Boost Python,你需要做两件事 - 告诉它转换并确保它导入你的包装器定义的模块(如果你不这样做你会得到令人兴奋的分段错误)

struct convert_to_PyWrapper {
 static PyObject* convert(const cpp_class& rhs) {
    // the const_cast here is a bit dodgy, but was needed to make it work
    return make_CyWrapper(const_cast<cpp_class&>(rhs));
}
};

inline void setup_boost_python() {
    PyInit_your_module_name(); // named inityour_module_name in Python 2
    boost::python::to_python_converter<
        cpp_class,
        convert_to_PyWrapper>();
}

在尝试使用回调之前,你需要确保你的Python / Cython代码调用“setup_boost_python”(如果你把它放在模块级别它是在导入时完成的,这是理想的)。

如果您遵循我的“手动”方案(避免依赖Boost Python),那么您需要修改执行C ++到Cython类型转换的call_obj Cython函数。

cdef public void call_obj(obj, cpp_class& c):
    obj(make_CyWrapper(c))

您还需要确保在使用之前导入包装Cython模块(否则会出现分段错误)。我在“py_object_wrapper.hpp”中做了这个,但是在某个地方完成它可以把它放在你喜欢的地方。

void operator()(cpp_class& a) {
    PyInit_your_module_name();
    if (held) {
        call_obj(held,a);
    }
}