使用 Boost.Python 嵌入 Python 模块到 C++

墨蓝 2022-08-06 10:12 171阅读 0赞

<table style="width: 100%; border-collapse: collapse; word-wrap: break-word;"> 
 <tbody> 
 <tr> 
 <td align="center"> 
 <table style="width: 100%; border-collapse: collapse; word-wrap: break-word;"> 
 <tbody> 
 <tr> 
 <td> 
 <div style="margin: 15px;"> 
 Boost.Python 目前并没有提供完整的将 Python 模块嵌入到 C++ 的包装库，因此许多工作我们还必须通过 Python C API 来进行。 但是， 利用 Boost.Python 中提供的一些模块， 能够给我们的工作带来极大便利。 
 <h2><a rel="nofollow"></a>1&nbsp;修改模块加载路径，装入 Python 模块</h2> 
 与任何一个其它 Python 嵌入 C/C++ 的程序一样， 我们需要在第一条 <code>#include</code> 语句处含入 <code>Python.h</code>， 并在程序开始时调用 <code>Py_Initialize()</code>，在程序结束时调用 <code>Py_Finalize()</code>。 
 接下来， 我们便可以开始准备装入 Python 模块了。 为了让 Python 解释器能够正确地找到 Python 模块所在的位置， 我们需要将 Python 模块所在的路径添加到模块搜索路径中，添加搜索路径的 Python 语句如下： 
 <div> 
 <pre>import sys if not '/module/path' in sys.path: sys.path.append('/module/path') </pre> 
 </div> 
 我们使用 Python C API 执行类似的语句， 就能将模块的搜索路径添加到 Python 解释器中。 添加了搜索路径后， 就可以通过 <code>PyImport_ImportModule</code> 函数加载 Python 模块了。 <code>PyImport_ImportModule</code> 返回值是 <code>PyObject&nbsp;*</code>， 为了避免手工处理繁琐的引用计数等问题，我们求助于 Boost.Python 提供的 <code>handle</code> 模块， 将 <code>PyObject&nbsp;*</code> 封装起来， 以方便使用， 代码如下： 
 <div> 
 <pre>#include &lt;boost/python.hpp&gt; ... boost::python::handle&lt;&gt;* _module; // Module handle. std::string path; // Path of the Python module. std::string module; // Module name. ... try {
 PyRun_SimpleString("import sys"); PyRun_SimpleString((std::string("if not '") + path + "' in sys.path: sys.path.append('" + path + "')").c_str()); _module = new boost::python::handle&lt;&gt;( PyImport_ImportModule((char *) module)); ... } catch (...) {
 PyErr_Print(); PyErr_Clear(); delete _module; _module = NULL; return false; } ... </pre> 
 </div> 
 需要注意的是， 通过 Python C API 加载的 Python 解释器并没有把当前路径列入默认的搜索路径中。因此， 即使你的 Python 模块就存放在当前路径， 你也必须使用上面的代码将当前路径添加到搜索路径中之后，才能通过 <code>PyImport_ImportModule</code> 加载到模块。 
 当 Python 模块使用完毕或程序结束时， 请使用 <code>delete</code> 将 <code>_module</code> 指针释放， <code>handle</code> 被释放的时候会自动释放相应的 Python 模块并回收相应资源。 
 <h2><a rel="nofollow"></a>2&nbsp;调用 Python 函数</h2> 
 导入了 Python 模块之后， 调用 Python 函数就非常容易了。 Boost.Python 里封装了一个非常好用的模板函数 <code>boost::python::call_method</code>，它可以替你处理调用函数时需要处理的种种细节， 将你从 Python C API 中繁琐的“将参数打包为 <code>PyObject&nbsp;*</code>”、 “构造 Tuple”、 “传递 Tuple”、 “解包返回值”等工作中彻底解放出来， 你只需要这样： 
 <div> 
 <pre> boost::python::call_method&lt;返回值类型&gt;(模块指针, "Python 函数名", 参数 1, 参数 2, ...); </pre> 
 </div> 
 模块指针可以通过我们前面得到的 <code>_module</code> 的 <code>get</code> 方法获得， 例如： 
 <div> 
 <pre>... bool result; std::string config_file; ... try {
 return boost::python::call_method&lt;bool&gt;(_module-&gt;get(), "initialize", config_file); } catch (...) {
 PyErr_Print(); PyErr_Clear(); ... } ... </pre> 
 </div> 
 <h2><a rel="nofollow"></a>3&nbsp;使用 Python 类对象</h2> 
 使用 Python C API 调用 Python 函数和调用 Python 类对象是没有太大区别的，我们只需要调用类的构造方法， 得到一个类对象， 然后把该类的指针看做模块指针，按照前面调用普通函数的方法调用类成员方法就可以了。 例如， 下列代码从 <code>_module</code> 中创建了一个 <code>YukiSession</code> 对象， 然后调用了其中的 <code>on_welcome</code> 方法。 除了展示调用类成员方法外， 这段代码还展示了构造 Python list 对象、 从 Python list 对象中获取元素的方式。 
 <div> 
 <pre> ... boost::python::handle&lt;&gt; _yukisession; ... // Retrieve the module handle and namespace handle. boost::python::object main_module(*_module); boost::python::object main_namespace = main_module.attr("__dict__"); // Call the method and get the object handle. _yukisession = boost::python::handle&lt;&gt;((PyRun_String( "YukiSession()", Py_eval_input, main_namespace.ptr(), main_namespace.ptr()))); ... // Compose a list. boost::python::list param; param.append(boost::python::str(_addr.get_host_addr())); param.append(boost::python::str()); // Call the method and retrieve the result. // Method is equivalent to: // "bool __thiscall YukiSession::on_welcome(list param);" result = boost::python::call_method&lt;bool&gt; (_yukisession.get(), "on_welcome", param); // Extract an item from a list. str = boost::python::call_method&lt;std::string&gt; (param.ptr(), "__getitem__", 1); ... </pre> 
 </div> 
 <h1><a rel="nofollow"></a></h1> 
 </div> </td> 
 </tr> 
 </tbody> 
 </table> &nbsp; </td> 
 </tr> 
 <tr> 
 <td>&nbsp;原文地址 <a href="http://learn.tsinghua.edu.cn:8080/2005212716/html/boost_python.html" rel="nofollow">http://learn.tsinghua.edu.cn:8080/2005212716/html/boost_python.html</a> </td> 
 </tr> 
 </tbody> 
</table>