Boost.Python的自定义转换器(Boost.Python custom converter)

我有一类以向量为参数（二进制文件的内容）。

我想蟒蛇“STR”类型转换为unsigned char型的载体，但只为我的类方法之一。

BOOST_PYTHON_MODULE(hello) {  class_<Hello>("Hello").
     // This method takes a string as parameter and print it
     .def("printChar", &Hello::printChar)
     // This method takes a vector<unsigned char> parameter
     .def("storeFile", &Hello::storeFile) }

使用自定义转换器似乎是我所需要的，但如果我修改我的boost ::蟒蛇::转换::注册表将修改我到printChar所有来电，传递字符串作为参数的所有Python方法将被转换为载体。

我如何注册每个方法转换？

有两种方法可以解决这个问题：

导出一个辅助函数作为Hello.storeFile接受boost::python::str ，构建体std::vector<unsigned char>从字符串，并委托给C ++ Hello::storeFile成员函数。
编写自定义的转换器。虽然转换器不能在每个函数基础上进行注册，他们是相当不错作用域为不执行任何非预期的转换。该方法通常提供了更多的可重用性。

辅助函数

使用辅助功能不会影响任何其他导出函数。因此，蟒串之间的转换std::vector<unsigned char>将仅发生于Hello.storeFile 。

void Hello_storeFile(Hello& self, boost::python::str str)
{
  std::cout << "Hello_storeFile" << std::endl;
  // Obtain a handle to the string.
  const char* begin = PyString_AsString(str.ptr());
  // Delegate to Hello::storeFile().
  self.storeFile(std::vector<unsigned char>(begin, begin + len(str)));
}

...

BOOST_PYTHON_MODULE(hello)
{
  namespace python = boost::python;

  python::class_<Hello>("Hello")
    // This method takes a string as parameter and print it
    .def("printChar", &Hello::printChar)
    // This method takes a vector<unsigned char> parameter
    .def("storeFile", &Hello_storeFile)
    ;
}

自定义转换器

A变换器登记有三个部分：

检查某一个功能PyObject是敞篷车。的返回NULL指示PyObject不能使用已注册的转换器。
的构建函数构建从C ++类型PyObject 。如果此功能仅被称为converter(PyObject)不会返回NULL 。
将要构造的C ++型。

因此，对于给定C ++类型，如果converter(PyObject)返回非NULL值，则construct(PyObject)将创建C ++型。 C ++类型充当关键到注册表，所以Boost.Python的不应执行非预期的转换。

在这个问题的背景下，我们要为一个转换器std::vector<unsigned char>其中， converter(PyObject)返回非NULL如果PyObject是PyString和converter(PyObject)将使用PyObject创建和填充std::vector<unsigned char> 。如果对于具有导出的C ++函数将只发生这种转换std::vector<unsigned char> （或const引用）参数和从蟒提供的参数是字符串。因此，这个自定义转换器会不会影响出口有功能std::string参数。

这是一个完整的例子。我选择使转换器一般允许多种类型的从一个Python字符串构造。凭借其链接的支持，它应该有感觉其他Boost.Python的类型相同。

#include <iostream>
#include <list>
#include <string>
#include <vector>

#include <boost/foreach.hpp>
#include <boost/python.hpp>

class Hello
{
public:
  void printChar(const std::string& str)
  {
    std::cout << "printChar: " << str << std::endl;
  }

  void storeFile(const std::vector<unsigned char>& data)
  {
    std::cout << "storeFile: " << data.size() << ": ";
    BOOST_FOREACH(const unsigned char& c, data)
      std::cout << c;
    std::cout << std::endl;
  }
};

/// @brief Type that allows for conversions of python strings to
//         vectors.
struct pystring_converter
{

  /// @note Registers converter from a python interable type to the
  ///       provided type.
  template <typename Container>
  pystring_converter&
  from_python()
  {
    boost::python::converter::registry::push_back(
      &pystring_converter::convertible,
      &pystring_converter::construct<Container>,
      boost::python::type_id<Container>());
    return *this;
  }

  /// @brief Check if PyObject is a string.
  static void* convertible(PyObject* object)
  {
    return PyString_Check(object) ? object : NULL;
  }

  /// @brief Convert PyString to Container.
  ///
  /// Container Concept requirements:
  ///
  ///   * Container::value_type is CopyConstructable from char.
  ///   * Container can be constructed and populated with two iterators.
  ///     I.e. Container(begin, end)
  template <typename Container>
  static void construct(
    PyObject* object,
    boost::python::converter::rvalue_from_python_stage1_data* data)
  {
    namespace python = boost::python;
    // Object is a borrowed reference, so create a handle indicting it is
    // borrowed for proper reference counting.
    python::handle<> handle(python::borrowed(object));

    // Obtain a handle to the memory block that the converter has allocated
    // for the C++ type.
    typedef python::converter::rvalue_from_python_storage<Container>
                                                                 storage_type;
    void* storage = reinterpret_cast<storage_type*>(data)->storage.bytes;

    // Allocate the C++ type into the converter's memory block, and assign
    // its handle to the converter's convertible variable.  The C++
    // container is populated by passing the begin and end iterators of
    // the python object to the container's constructor.
    const char* begin = PyString_AsString(object);
    data->convertible = new (storage) Container(
      begin,                          // begin
      begin + PyString_Size(object)); // end
  }
};

BOOST_PYTHON_MODULE(hello)
{
  namespace python = boost::python;

  // Register PyString conversions.
  pystring_converter()
    .from_python<std::vector<unsigned char> >()
    .from_python<std::list<char> >()
    ;

  python::class_<Hello>("Hello")
    // This method takes a string as parameter and print it
    .def("printChar", &Hello::printChar)
    // This method takes a vector<unsigned char> parameter
    .def("storeFile", &Hello::storeFile)
    ;
}

和用法示例：

>>> from hello import Hello
>>> h = Hello()
>>> h.printChar('abc')
printChar: abc
>>> h.storeFile('def')
storeFile: 3: def
>>> h.storeFile([c for c in 'def'])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
Boost.Python.ArgumentError: Python argument types in
    Hello.storeFile(Hello, list)
did not match C++ signature:
    storeFile(Hello {lvalue}, std::vector<unsigned char, 
                                          std::allocator<unsigned char> >)

欲了解更多关于自定义转换器和C ++的容器，可以阅读这个答案。