Boost.Python：如何公开std :: unique_ptr

Question

我对boost.python相当新，并尝试将函数的返回值公开给python。

函数签名如下所示：

 std::unique_ptr<Message> someFunc(const std::string &str) const;

在python中调用函数时，我收到以下错误：

TypeError: No to_python (by-value) converter found for C++ type: std::unique_ptr<Message, std::default_delete<Message> >

我在python中的函数调用如下所示：

a = mymodule.MyClass()
a.someFunc("some string here") # error here

我试图暴露std :: unique_ptr但只是无法让它工作..有人知道如何正确暴露指针类？ 谢谢！

编辑：我尝试了以下内容：

class_<std::unique_ptr<Message, std::default_delete<Message>>, bost::noncopyable ("Message", init<>())

;

这个例子编译，但我仍然得到上面提到的错误。 此外，我试图公开类Message本身

class_<Message>("Message", init<unsigned>())

        .def(init<unsigned, unsigned>()) 
        .def("f", &Message::f)
;

Answer 1

简而言之，Boost.Python不支持move-semantics，因此不支持std::unique_ptr 。 Boost.Python的新闻/更改日志没有任何迹象表明它已针对C ++ 11移动语义进行了更新。 此外，针对unique_ptr支持的此功能请求已超过一年未被触及。

然而，Boost.Python支持通过std::auto_ptr将对象的独占所有权转移到Python或从Python转移。 由于unique_ptr本质上是一个更安全的auto_ptr版本，因此使用unique_ptr将API调整为使用auto_ptr的API应该是相当直接的：

• 当C ++将所有权转移到Python时，C ++函数必须：
  • 使用boost::python::manage_new_object结果转换器，使用boost::python::return_value_policy CallPolicy进行公开。
  • 通过release()获得unique_ptr释放控制并返回一个原始指针
• 当Python将所有权转移到C ++时，C ++函数必须：
  • 通过auto_ptr接受实例。 FAQ提到使用manage_new_object策略从C ++返回的指针将通过std::auto_ptr进行管理。
  • 通过release()将auto_ptr释放控制权发送到unique_ptr

---

给定一个无法更改的API /库：

/// @brief Mockup Spam class.
struct Spam;

/// @brief Mockup factory for Spam.
struct SpamFactory
{
  /// @brief Create Spam instances.
  std::unique_ptr<Spam> make(const std::string&);

  /// @brief Delete Spam instances.
  void consume(std::unique_ptr<Spam>);
};

需要通过辅助函数包装SpamFactory::make()和SpamFactory::consume() 。

将所有权从C ++转移到Python的功能通常可以由创建Python函数对象的函数包装：

/// @brief Adapter a member function that returns a unique_ptr to
///        a python function object that returns a raw pointer but
///        explicitly passes ownership to Python.
template <typename T,
          typename C,
          typename ...Args>
boost::python::object adapt_unique(std::unique_ptr<T> (C::*fn)(Args...))
{
  return boost::python::make_function(
      [fn](C& self, Args... args) { return (self.*fn)(args...).release(); },
      boost::python::return_value_policy<boost::python::manage_new_object>(),
      boost::mpl::vector<T*, C&, Args...>()
    );
}

lambda委托给原始函数，并将实例的所有权releases()给Python，调用策略表明Python将取得lambda返回的值的所有权。 mpl::vector描述了Boost.Python的调用签名，允许它正确地管理语言之间的函数调度。

adapt_unique的结果公开为SpamFactory.make() ：

boost::python::class_<SpamFactory>(...)
  .def("make", adapt_unique(&SpamFactory::make))
  // ...
  ;

通常适应SpamFactory::consume()是一件比较困难的事情，但编写简单的辅助函数很容易：

/// @brief Wrapper function for SpamFactory::consume_spam().  This
///        is required because Boost.Python will pass a handle to the
///        Spam instance as an auto_ptr that needs to be converted to
///        convert to a unique_ptr.
void SpamFactory_consume(
  SpamFactory& self,
  std::auto_ptr<Spam> ptr) // Note auto_ptr provided by Boost.Python.
{
  return self.consume(std::unique_ptr<Spam>{ptr.release()});
}

辅助函数委托给原始函数，并将Boost.Python提供的auto_ptr转换为API所需的unique_ptr 。 SpamFactory_consume辅助函数公开为SpamFactory.consume() ：

boost::python::class_<SpamFactory>(...)
  // ...
 .def("consume", &SpamFactory_consume)
 ;

---

这是一个完整的代码示例：

#include <iostream>
#include <memory>
#include <boost/python.hpp>

/// @brief Mockup Spam class.
struct Spam
{
  Spam(std::size_t x) : x(x) { std::cout << "Spam()" << std::endl; }
  ~Spam() { std::cout << "~Spam()" << std::endl; }
  Spam(const Spam&) = delete;
  Spam& operator=(const Spam&) = delete;
  std::size_t x;
};

/// @brief Mockup factor for Spam.
struct SpamFactory
{
  /// @brief Create Spam instances.
  std::unique_ptr<Spam> make(const std::string& str)
  {
    return std::unique_ptr<Spam>{new Spam{str.size()}};
  }

  /// @brief Delete Spam instances.
  void consume(std::unique_ptr<Spam>) {}
};

/// @brief Adapter a non-member function that returns a unique_ptr to
///        a python function object that returns a raw pointer but
///        explicitly passes ownership to Python.
template <typename T,
          typename ...Args>
boost::python::object adapt_unique(std::unique_ptr<T> (*fn)(Args...))
{
  return boost::python::make_function(
      [fn](Args... args) { return fn(args...).release(); },
      boost::python::return_value_policy<boost::python::manage_new_object>(),
      boost::mpl::vector<T*, Args...>()
    );
}

/// @brief Adapter a member function that returns a unique_ptr to
///        a python function object that returns a raw pointer but
///        explicitly passes ownership to Python.
template <typename T,
          typename C,
          typename ...Args>
boost::python::object adapt_unique(std::unique_ptr<T> (C::*fn)(Args...))
{
  return boost::python::make_function(
      [fn](C& self, Args... args) { return (self.*fn)(args...).release(); },
      boost::python::return_value_policy<boost::python::manage_new_object>(),
      boost::mpl::vector<T*, C&, Args...>()
    );
}

/// @brief Wrapper function for SpamFactory::consume().  This
///        is required because Boost.Python will pass a handle to the
///        Spam instance as an auto_ptr that needs to be converted to
///        convert to a unique_ptr.
void SpamFactory_consume(
  SpamFactory& self,
  std::auto_ptr<Spam> ptr) // Note auto_ptr provided by Boost.Python.
{
  return self.consume(std::unique_ptr<Spam>{ptr.release()});
}

BOOST_PYTHON_MODULE(example)
{
  namespace python = boost::python;
  python::class_<Spam, boost::noncopyable>(
      "Spam", python::init<std::size_t>())
    .def_readwrite("x", &Spam::x)
    ;

  python::class_<SpamFactory>("SpamFactory", python::init<>())
    .def("make", adapt_unique(&SpamFactory::make))
    .def("consume", &SpamFactory_consume)
    ;
}

交互式Python：

>>> import example
>>> factory = example.SpamFactory()
>>> spam = factory.make("a" * 21)
Spam()
>>> spam.x
21
>>> spam.x *= 2
>>> spam.x
42
>>> factory.consume(spam)
~Spam()
>>> spam.x = 100
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
Boost.Python.ArgumentError: Python argument types in
    None.None(Spam, int)
did not match C++ signature:
    None(Spam {lvalue}, unsigned int)

Answer 2

我的建议是使用get()从std::unique_ptr容器中get()原始指针。 您将不得不小心地将unique_ptr保留在您希望使用原始指针值的整个时间范围内，否则该对象将被删除，并且您将拥有指向无效内存区域的指针。

Answer 3

从v.1.55开始， Boost支持movable semantics和unique_ptr 。 但在我的项目中，我使用了以前的版本并制作了这样简单的包装器：

class_<unique_ptr<HierarchyT>, noncopyable>(typpedName<LinksT>("hierarchy", false)
, "hierarchy holder")
    .def("__call__", &unique_ptr<HierarchyT>::get,
        return_internal_reference<>(),
        "get holding hierarchy")
    .def("reset", &unique_ptr<HierarchyT>::reset,
        "reset holding hierarhy")
    ;

创建unique_ptr<HierarchyT>像Python shierarchy并将它传递给通过参考接受它的功能。
Python代码：

hier = mc.shierarchy()
mc.clusterize(hier, nds)

其中C ++函数是float clusterize(unique_ptr<HierarchyT>& hier,...) 。
然后在Python中访问结果调用hier()从unique_ptr获取包装对象：

output(hier(), nds)

Answer 4

我认为现在没有办法做你想要的...原因是因为std::unique_ptr<Message> someFunc(const std::string &str)按值返回，这意味着以下两点之一：

1. 将复制返回值（但unique_ptr不可复制 ）;
2. 返回值将被移动（现在问题是boost :: python不提供移动语义的支持）。 （嘿，我正在使用boost 1,53，在最新版本中不确定）;

someFunc（）是否创建了对象？ 如果是，我认为解决方案是创建一个包装器，如果没有，你可以通过引用返回：

std::unique_ptr<Message>& someFunc(const std::string &str)

公开课：

class_<std::unique_ptr<Message, std::default_delete<Message>>, boost::noncopyable>("unique_ptr_message")
    .def("get", &std::unique_ptr<Message>::get, return_value_policy<reference_existing_object>())
;

以及功能：

def("someFunc", someFunc,  return_value_policy<reference_existing_object>());