如何使用 Boost.Python 将C++对象传递给另一个C++对象

class A {
    public:
        A(long n, long x, long y) : _n(n), _x(x), _y(y) {};
        long get_n() { return _n; }
        long get_x() { return _x; }
        long get_y() { return _y; }
    private:
        long _n, _x, _y;
};
class B {
    public:
        B(A a) : _a(a) {};
        doSomething() { ... };
    private:
        A _a;
};

struct A_from_python_A {
    static void * convertible(PyObject* obj_ptr) {
        // assume it is, for now...
        return obj_ptr;
    }
    // Convert obj_ptr into an A instance
    static void construct(PyObject* obj_ptr,
                      boost::python::converter::rvalue_from_python_stage1_data* data) {
        // extract 'n':
        PyObject * n_ptr = PyObject_CallMethod(obj_ptr, (char*)"get_n", (char*)"()");
        long n_val = 0;
        if (n_ptr == NULL) {
            cout << "... an exception occurred (get_n) ..." << endl;
        } else {
            n_val = PyInt_AsLong(n_ptr);
            Py_DECREF(n_ptr);
        }
        // [snip] - also do the same for x, y
        // Grab pointer to memory into which to construct the new A
        void* storage = (
            (boost::python::converter::rvalue_from_python_storage<A>*)
            data)->storage.bytes;
        // in-place construct the new A using the data
        // extracted from the python object
        new (storage) A(n_val, x_val, y_val);
        // Stash the memory chunk pointer for later use by boost.python
        data->convertible = storage;
    }
    // register converter functions
    A_from_python_A() {
        boost::python::converter::registry::push_back(
            &convertible,
            &construct,
            boost::python::type_id<A>());
    }
};

BOOST_PYTHON_MODULE(interpolation_ext)
{
    // register the from-python converter for A
    A_from_python_A();
    class_<A>("A", init<long, long, long>())
        ;
    class_<B>("B", init<object>())
        ;
}

from my_ext import A, B
a = A(1,2,3)
b = B(a)
b.doSomething()

简而言之，将B的包装器定义为：

class_<B>( "B", init< A >() )

而不是

class_<B>( "B", init< object >() )

在 Boost.Python 中为类定义包装器时（至少在 1.50 中），class_模板会生成转换和构造函数。 这允许A转换为A的包装器并从中构造。 这些PyObject转换具有严格的类型检查，并要求在python中满足以下条件：isinstance( obj, A )。

自定义转换器通常用于支持：

• 自动转换到现有 Python 类型或从现有 Python 类型转换。 例如，将std::pair< long, long >与PyTupleObject相互转换。
• 鸭子打字。 例如，B接受类 D，它不是派生自 A 的，只要D提供兼容的接口。

<小时 />

从A实例构造B

由于A和B既不是现有的 Python 类型，也不需要鸭子类型，因此不需要自定义转换器。 对于B采取A实例，可以像指定init采用A一样简单。

这是一个简化的A和B的例子，其中B可以从A构造。

class A
{
public:
  A( long n ) : n_( n ) {};
  long n() { return n_; }
private:
  long n_;
};
class B
{
public:
  B( A a ) : a_( a ) {};
  long doSomething() { return a_.n() * 2; }
private:
  A a_;
};

包装器将被定义为：

using namespace boost::python;
BOOST_PYTHON_MODULE(example)
{
  class_< A >( "A", init< long >() )
    ;
  class_<B>( "B", init< A >() )
    .def( "doSomething", &B::doSomething )
    ;
}

B 的包装器明确表示它将通过 init< A >() 从A对象构造。 此外，A 的接口没有完全暴露给 Python 对象，因为没有为 A::n() 函数定义包装器。

>>> from example import A, B
>>> a = A( 1 )
>>> b = B( a )
>>> b.doSomething()
2

这也适用于派生自 A 的类型。 例如：

>>> from example import A, B
>>> class C( A ):
...     def __init__( self, n ):
...         A.__init__( self, n )
... 
>>> c = C( 2 )
>>> b = B( c )
>>> b.doSomething()
4

但是，未启用鸭子类型。

>>> from example import A, B
>>> class E: pass
... 
>>> e = E()
>>> b = B( e )
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
Boost.Python.ArgumentError: Python argument types in
    B.__init__(B, instance)
did not match C++ signature:
    __init__(_object*, A)

<小时 />

从可转换为 A 的对象构造B。

为了支持可以从提供兼容接口的对象构造B的情况，则需要自定义转换器。 虽然以前没有为 A::n() 生成包装器，但让我们继续语句，如果对象提供返回 int 的get_num()方法，则可以将对象转换为 A。

首先，编写一个提供转换器和构造函数的 A_from_python 结构。

struct A_from_python
{
  static void* convertible( PyObject* obj_ptr )
  {
    // assume it is, for now...
    return obj_ptr;
  }
  // Convert obj_ptr into an A instance
  static void construct(
    PyObject* obj_ptr,
    boost::python::converter::rvalue_from_python_stage1_data* data)
  {
    std::cout << "constructing A from ";
    PyObject_Print( obj_ptr, stdout, 0 );
    std::cout << std::endl;
    // Obtain a handle to the 'get_num' method on the python object.
    // If it does not exists, then throw.
    PyObject* n_ptr = 
      boost::python::expect_non_null( 
        PyObject_CallMethod( obj_ptr,
                             (char*)"get_num",
                             (char*)"()"  ));
    long n_val = 0;
    n_val = PyInt_AsLong( n_ptr );
    Py_DECREF( n_ptr );
    // Grab pointer to memory into which to construct the new A
    void* storage = (
      (boost::python::converter::rvalue_from_python_storage< A >*)
       data)->storage.bytes;
    // in-place construct the new A using the data
    // extracted from the python object
    new ( storage ) A( n_val );
    // Stash the memory chunk pointer for later use by boost.python
    data->convertible = storage;
  }
  A_from_python()
  {
    boost::python::converter::registry::push_back(
      &convertible,
      &construct,
      boost::python::type_id< A >() );
  }
};

boost::python::expect_non_null用于在返回NULL时引发异常。 这有助于提供鸭子类型保证，即 python 对象必须提供get_num方法。 如果已知PyObject是给定类型的实例，则可以使用 boost::python::api::handle 和 boost::python::api::object 直接提取类型，而不必通常通过 PyObject 接口进行调用。

接下来，在模块中注册转换器。

using namespace boost::python;
BOOST_PYTHON_MODULE(example)
{
  // register the from-python converter for A
  A_from_python();
  class_< A >( "A", init< long >() )
    ;
  class_<B>( "B", init< A >() )
    .def( "doSomething", &B::doSomething )
    ;
}

A、B 或其关联的包装器定义没有发生任何更改。 创建自动转换函数，然后在模块中定义/注册。

>>> from example import A, B
>>> a = A( 4 )
>>> b = B( a )
>>> b.doSomething()
8
>>> class D:
...     def __init__( self, n ):
...         self.n = n
...     def get_num( self ):
...         return self.n
... 
>>> d = D( 5 )
>>> b = B( d )
constructing A from <__main__.D instance at 0xb7f7340c>
>>> b.doSomething()
10
>>> class E: pass
...
>>> e = E()
>>> b = B( e )
constructing A from <__main__.E instance at 0xb7f7520c>
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: get_num

D::get_num()存在，因此当D传递给B的构造函数时，A是从D的实例构造的。 但是，E::get_num()不存在，并且尝试从 E 的实例构造A时会引发异常。

<小时 />

另一种转换解决方案。

对于较大的类型，通过 C-API 实现鸭子类型可能会变得非常复杂。 另一种解决方案是在 python 中执行鸭子输入，并将 python 文件与库一起分发。

example_ext.py将导入A和B类型，以及猴子补丁B的构造函数：

from example import A, B
def monkey_patch_B():
    # Store handle to original init provided by Boost.
    original_init = B.__init__
    # Construct an A object via duck-typing.
    def construct_A( obj ):
        return A( obj.get_num() )
    # Create a new init that will delegate to the original init.
    def new_init( self, obj ):
        # If obj is an instance of A, use it.  Otherwise, construct
        # an instance of A from object.
        a = obj if isinstance( obj, A ) else construct_A ( obj )
        # Delegate to the original init.
        return original_init( self, a )
    # Rebind the new_init.
    B.__init__ = new_init
monkey_patch_B()

最终用户需要的唯一更改是导入example_ext而不是example：

>>> from example_ext import A, B
>>> a = A( 6 )
>>> b = B( a )
>>> b.doSomething()
12
>>> class D:
...     def __init__( self, n ):
...         self.n = n
...     def get_num( self ):
...         return self.n
... 
>>> d = D( 7 )
>>> b = B( d )
>>> b.doSomething()
14
>>> class E: pass
... 
>>> e = E()
>>> b = B( e )
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "example_ext.py", line 15, in new_init
    a = obj if isinstance( obj, A ) else construct_A ( obj )
  File "example_ext.py", line 9, in construct_A
    return A( obj.get_num() )
AttributeError: E instance has no attribute 'get_num'

由于修补的构造函数保证A的实例将被传递给B，因此A_from_python::construct不会被调用。 因此，输出中缺少打印语句。

虽然这种方法避免了 C-API，使其更容易执行鸭子类型，但它确实有一个主要的权衡，因为它需要专门修补 API 的某些部分以进行转换。 另一方面，当自动类型转换功能可用时，不需要修补。

<小时 />

此外，就其价值而言，C++和Python中的访问控制旨在防止意外滥用。 两者都不能防止故意获得对具有私人可见性的成员的访问权限。 这在 Python 中要容易得多，但在 C++ 标准中通过显式模板实例化是明确允许的。