如何在不构建模块的情况下将C ++类公开给Python

时间:2013-08-26 10:53:03

标签: c++ python swig boost-python

我想知道是否有任何方法可以将C ++类公开给Python,但是没有构建中间共享库。

这是我理想的情景。例如,我有以下C ++类:

class toto
     {
     public:
        toto(int iValue1_, int iValue2_): iValue1(iValue1_), iValue2(iValue2_) {}
        int Addition(void) const {if (!this) return 0; return iValue1 + iValue2;}

      private:
        int iValue1;
        int iValue2;
     };

我想以某种方式将此类(或其intance)转换为PyObject *,以便将其作为paremter(args)发送到例如PyObject_CallObject:

PyObject* PyObject_CallObject(PyObject* wrapperFunction, PyObject* args)

另一方面,在我的python方面,我将有一个wrapperFunction,它将我的C ++类(或其实例)上的指针作为参数获取,并调用其方法或使用其属性:

def wrapper_function(cPlusPlusClass):
    instance = cPlusPlusClass(4, 5)
    result = instance.Addition()

正如您所看到的,我并不真正需要/想要拥有一个单独的共享库或通过boost python构建模块。我需要的只是找到一种方法将C ++代码转换为PyObject并将其发送到python。我无法通过C python库,boost或SWIG找到一种方法。

你知道吗? 谢谢你的帮助。

2 个答案:

答案 0 :(得分:6)

据我所知,没有简单的方法可以做到这一点。

要使用C ++扩展Python既不包含模块也不使用中间库,它需要动态加载库,然后导入函数。 ctypes模块使用此方法。要用C ++完成相同的操作,需要编写一个ctypes -like 库来理解目标编译器的C ++ ABI。

为了在不引入模块的情况下扩展Python,可以创建一个中间库,它提供了一个包装C ++库的C API。然后可以通过ctypes在Python中使用此中间库。虽然它没有提供确切的调用语法并且确实引入了一个中间库,但它可能比构建一个可以直接与C ++接口的ctypes -like 库一样省力。

但是,如果要引入中间库,则可能值得使用Boost.Python,SWIG或其他一些C ++ / Python语言绑定工具。虽然其中许多工具将通过模块引入扩展,但它们通常提供更清晰的调用约定,更好的绑定过程中的错误检查,并且可能更容易维护。

答案 1 :(得分:1)

我找到了答案。实际上我在搜索的内容与这个答案非常相似(感谢moooeeeep的评论):

Exposing a C++ class instance to a python embedded interpreter

遵循C ++类(注意!默认构造函数是必需的):

class TwoValues
{
public:
    TwoValues(void): iValue1(0), iValue2(0) {}
    TwoValues(int iValue1, int iValue2): iValue1(iValue1_), iValue2(iValue2_) {}

    int Addition(void) const {if (!this) return 0; return iValue1 + iValue2;}

public:
    int iValue1;
    int iValue2;
};

可以通过跟随宏来提升:

BOOST_PYTHON_MODULE(ModuleTestBoost)
{
class_<TwoValues>("TwoValues")
   .def("Addition",             &TWOVALUES::Addition)
   .add_property("Value1",      &TWOVALUES::iValue1)
   .add_property("Value2",      &TWOVALUES::iValue2);
};

另一方面,我有一个在python_script.py中定义的python函数,它接受这个类的一个实例并做一些事情。例如:

def wrapper_function(instance):
    result = instance.Addition()
    myfile = open(r"C:\...\testboostexample.txt", "w")
    output = 'First variable is {0}, second variable is {1} and finally the addition is {2}'.format(instance.Value1, instance.Value2, result)
    myfile .write(output)
    myfile .close()

然后在C ++方面,我可以通过同时发送我的类的实例来调用此函数,如下所示:

Py_Initialize();

try
    {
    TwoValues instance(5, 10);
    initModuleTestBoost();

    object python_script = import("python_script");
    object wrapper_function = python_script.attr("wrapper_function");
    wrapper_function(&instance);
    }
catch (error_already_set)
    {
    PyErr_Print();
    }

Py_Finalize();

优点:

  • 我不需要构建任何共享库或二进制文件
  • 当我使用Boost时,我不需要担心内存管理 &安培;引用计数
  • 我不使用共享提升指针(boost :: shared_ptr)来指向 我的班级实例