python - 使用 boost::python 公开具有 std::function 作为参数的 C++ 成员函数

Question

我有一个包含一个属性的类，它是一个 std::function。我使用成员函数设置此属性的值，因此该类如下所示:

class ClassName
{    
public:
    void SetCallbackFunction(std::function<void (int i)> callbackFun) {
        m_callbackFunction = callbackFun;
    }

protected:
    std::function<void (int i)> m_callbackFunction;
};

我需要向 Python 公开此类，当然，我需要公开 SetCallbackFunction 函数。 我如何使用 boost::python 做到这一点？

Answer 1

由于 Python 对象都是 Callable 和 CopyConstructible，最简单的方法是公开一个辅助函数为 SetCallbackFunction接受 boost::python::object , 然后委托(delegate)给实际的 SetCallbackFunction功能:

void ClassName_SetCallbackFunction_aux(ClassName& self, boost::python::object object)
{
  self.SetCallbackFunction(object);
}

BOOST_PYTHON_MODULE(example)
{
  namespace python = boost::python;
  python::class_<ClassName>("ClassName", python::init<>())
    .def("set_callback", &ClassName_SetCallbackFunction_aux)
    // ...
    ;
}

当 ClassName::SetCallbackFunction直接暴露给 Python 并被调用，Boost.Python 将在运行时搜索其注册表以找到 std::function<void (int)> 的来自 Python 的转换器.由于此转换尚未显式注册，因此 Boost.Python 将无法分派(dispatch)函数调用。辅助函数避免了这种运行时转换检查并构造了一个 std::function<void (int)>。来自 boost::python::object 的对象, 作为 boost::python::object是 Callable 和 CopyConstructible。

---

这是一个例子 demonstrating使用辅助函数将 Python 对象分配为回调:

#include <functional> // std::function
#include <boost/python.hpp>

// Legacy API.
class spam
{
public:
  void SetCallbackFunction(std::function<void (int)> callback)
  {
    callback_ = callback;
  }

  void perform(int x)
  {
    callback_(x);
  }

private:
  std::function<void (int)> callback_;
};

BOOST_PYTHON_MODULE(example)
{
  namespace python = boost::python;
  // Expose spam.
  python::class_<spam>("Spam", python::init<>())
    // Use an auxiliary function to set Python callbacks.
    .def("set_callback", +[](spam& self, boost::python::object object) {
      self.SetCallbackFunction(object);
    })
    .def("perform", &spam::perform)
    ;
}

交互使用:

>>> import example
>>> called = False
>>> def perform_x(x):
...     assert(42 == x)
...     global called
...     called = True
... 
>>> spam = example.Spam()
>>> spam.set_callback(perform_x)
>>> assert(not called)
>>> spam.perform(42)
>>> assert(called) # Verify callback was invoked
>>> spam.set_callback(lambda: None)
>>> try:
...     spam.perform(42)
...     assert(False) # Verify callback fails (the lambda accepts no args)
... except TypeError:
...     pass
...