python - 将 C++ 对象传递给 Python

Question

这个问题是关于如何将 C++ 对象传递给在 (C++) 嵌入式 Python 解释器中调用的 Python 函数。

以下 C++ 类 (MyClass.h) 专为测试而设计:

#ifndef MyClassH
#define MyClassH
#include <string>

using std::string;
class MyClass
{
    public:
                        MyClass(const string& lbl): label(lbl) {}
                        ~MyClass(){}
        string          getLabel() {return label;}

    private:
        string          label;
};
#endif

可以通过以下 Swig 接口(interface)文件生成一个暴露 C++ 类的 python 模块:

%module passmetopython

%{    #include "MyClass.h"    %}

%include "std_string.i"

//Expose to Python
%include "MyClass.h"

下面是一个使用 python 模块的 Python 脚本

import passmetopython as pmtp

def execute(obj):
    #This function is to be called from C/C++, with a
    #MyClass object as an argument
    print ("Entering execute function")
    lbl = obj.getLabel();
    print ("Printing from within python execute function. Object label is: " + lbl)
    return True

def main():
    c = pmtp.MyClass("Test 1")
    retValue = execute(c)
    print("Return value: " + str(retValue))

#Test function from within python
if __name__ == '__main__':
    main()

这个问题是关于如何让 python execute() 函数在从 c++ 调用时以 C++ 对象作为参数工作。

编写了以下 C++ 程序来测试功能(最少的错误检查):

#include "Python.h"
#include <iostream>
#include <sstream>
#include "MyClass.h"

using namespace std;

int main()
{
    MyClass obj("In C++");
    cout << "Object label: \"" << obj.getLabel() << "\"" << endl;

    //Setup the Python interpreter and eventually call the execute function in the
    //demo python script
    Py_Initialize();

    //Load python Demo script, "passmetopythonDemo.py"
    string PyModule("passmetopythonDemo");
    PyObject* pm = PyUnicode_DecodeFSDefault(PyModule.c_str());

    PyRun_SimpleString("import sys");
    stringstream cmd;
    cmd << "sys.path.append(\"" << "." << "\")";
    PyRun_SimpleString(cmd.str().c_str());
    PyObject* PyModuleP = PyImport_Import(pm);
    Py_DECREF(pm);

    //Now create PyObjects for the Python functions that we want to call
    PyObject* pFunc = PyObject_GetAttrString(PyModuleP, "execute");

    if(pFunc)
    {
        //Setup argument
        PyObject* pArgs = PyTuple_New(1);

        //Construct a PyObject* from long
        PyObject* pObj(NULL);

        /* My current attempt to create avalid argument to Python */
        pObj = PyLong_FromLong((long) &obj);


        PyTuple_SetItem(pArgs, 0, pObj);

        /***** Calling python here *****/
        cout<<endl<<"Calling function with an MyClass argument\n\n";
        PyObject* res = PyObject_CallObject(pFunc, pArgs);
        if(!res)
        {
            cerr << "Failed calling function..";
        }
    }

    return 0;
}

运行上述代码时，execute() python 函数以 MyClass 对象作为参数，失败并返回 NULL。但是，输入了Python函数，在控制台输出中我可以看到输出(Entering execute function)，表明传递的对象不是，确实，一个有效的MyClass 对象。

有很多关于如何将简单类型(如整数、 double 类型或字符串类型)从 C/C++ 传递给 Python 的示例。但是很少有例子展示如何传递一个 C/C++ 对象/指针，这有点令人费解。

上面的代码，带有一个 CMake 文件，可以从 github 上 checkout : https://github.com/TotteKarlsson/miniprojects/tree/master/passMeToPython

此代码不使用任何 boost python 或其他 API。不过，Cython 听起来很有趣，如果它可以用于 C++ 方面的简化，它是可以接受的。

Answer 1

这是对我自己问题的部分回答。我说的是片面的，因为我确实相信有更好的方法。

在这篇文章的基础上 http://swig.10945.n7.nabble.com/Pass-a-Swig-wrapped-C-class-to-embedded-Python-code-td8812.html我生成了 swig 运行时 header ，如此处所述，第 15.4 节:http://www.swig.org/Doc2.0/Modules.html#Modules_external_run_time

在上面的C++代码中包含生成的header，允许编写如下代码:

    PyObject* pObj = SWIG_NewPointerObj((void*)&obj, SWIG_TypeQuery("_p_MyClass"),  0 ); 

此代码使用来自 Swig python 包装源文件的信息，即 MyClass 类型的“swig”名称，即 _p_MyClass。

使用上面的 PyObject* 作为 PyObject_CallObject 函数的参数，上面代码中的 python execute() 函数可以正常执行，并且使用生成的 python 模块的 Python 代码确实有适当的访问 MyClass 对象的内部数据。这很棒。

虽然上面的代码以一种非常简单的方式说明了如何在 C++ 和 Python 之间传递和检索数据，但在我看来，它并不理想。

swig 头文件在 C++ 代码中的使用确实不是很漂亮，此外，它需要用户“手动”查看 swig 生成的包装器代码才能找到“_p_MyClass”代码。

一定有更好的方法!？或许应该在 swig 接口(interface)文件中添加一些内容以使其看起来更好？