Python与C/C++的相互调用案例

一、问题

python模块和c/c++的动态库间相互调用在实际的应用中会有所涉及，在此作一总结。

二、python调用c/c++

1、python调用c动态链接库

python调用c库比较简单，不经过任何封装打包成so，再使用python的ctypes调用即可。

（1）c语言文件：pycall.c

（2）gcc编译生成动态库libpycall.so：gcc -o libpycall.so -shared -fpic pycall.c。使用g++编译生成c动态库的代码中的函数或者方法时，需要使用extern "c"来进行编译。

（3）python调用动态库的文件：pycall.py

（4）运行结果：

2、python调用c++(类)动态链接库

需要extern "c"来辅助，也就是说还是只能调用c函数，不能直接调用方法，但是能解析c++方法。不是用extern "c"，构建后的动态链接库没有这些函数的符号表。

（1）c++类文件：pycallclass.cpp

（2）g++编译生成动态库libpycall.so：g++ -o libpycallclass.so -shared -fpic pycallclass.cpp。

（3）python调用动态库的文件：pycallclass.py

（4）运行结果：

3、python调用c/c++可执行程序

（1）c/c++程序：main.cpp

（2）编译成二进制可执行文件：g++ -o testmain main.cpp。

（3） python调用程序：main.py

（4）运行结果：

4、扩展python（c++为python编写扩展模块）

所有能被整合或导入到其它python脚本的代码，都可以被称为扩展。可以用python来写扩展，也可以用c和c++之类的编译型的语言来写扩展。python在设计之初就考虑到要让模块的导入机制足够抽象。抽象到让使用模块的代码无法了解到模块的具体实现细节。python的可扩展性具有的优点：方便为语言增加新功能、具有可定制性、代码可以实现复用等。

为 python 创建扩展需要三个主要的步骤：创建应用程序代码、利用样板来包装代码和编译与测试。

（1）创建应用程序代码

上述代码中有两个函数，一个是递归求阶乘的函数fac()；另一个reverse()函数实现了一个简单的字符串反转算法，其主要目的是修改传入的字符串，使其内容完全反转，但不需要申请内存后反着复制的方法。

（2）用样板来包装代码

接口的代码被称为“样板”代码，它是 应用程序代码与python解释器之间进行交互所必不可少的一部分。样板主要分为4步：a、包含python的头文件；b、为每个模块的每一个函数增加一个型如pyobject* module_func()的包装函数；c、为每个模块增加一个型如pymethoddef modulemethods[]的数组；d、增加模块初始化函数void initmodule()。

python.h头文件在大多数类unix系统中会在/usr/local/include/python2.x或/usr/include/python2.x目录中，系统一般都会知道文件安装的路径。

增加包装函数，所在模块名为extest，那么创建一个包装函数叫extest_fac()，在python脚本中使用是先import extest，然后调用extest.fac()，当 extest.fac()被调用时，包装函数 extest_fac()会被调用，包装函数接受一个 python的整数参数，把它转为c的整数，然后调用c的fac()函数，得到一个整型的返回值，最后把这个返回值转为python的整型数做为整个函数调用的结果返回回去。其他两个包装函数extest_doppel()和extest_test()类似。

从python到c的转换用pyarg_parse*系列函数， int pyarg_parsetuple()：把python传过来的参数转为c；int pyarg_parsetupleandkeywords()与pyarg_parsetuple()作用相同，但是同时解析关键字参数；它们 的用法跟c的sscanf函数很像，都接受一个字符串流，并根据一个指定的格式字符串进行解析，把结果放入到相应的指针所指的变量中去，它们的返回值为1表示解析成功，返回值为0表示失败。 从c到python的转换函数是pyobject* py_buildvalue()：把c的数据转为python的一个对象或一组对象，然后返回之；py_buildvalue的用法跟sprintf很像，把所有的参数按格式字符串所指定的格式转换成一个python的对象。

c与python之间数据转换的转换代码：

为每个模块增加一个型如pymethoddef modulemethods[]的数组，以便于python解释器能够导入并调用它们，每一个数组都包含了函数在python中的名字，相应的包装函数的名字以及一个meth_varargs常量，meth_varargs表示参数以tuple形式传入。 若需要使用 pyarg_parsetupleandkeywords()函数来分析命名参数的话，还需要让这个标志常量与meth_keywords常量进行逻辑与运算常量 。数组最后用两个null来表示函数信息列表的结束。

所有工作的最后一部分就是模块的初始化函数，调用py_initmodule()函数，并把模块名和modulemethods[]数组的名字传递进去，以便于解释器能正确的调用模块中的函数。

（3）编译

为了让新python的扩展能被创建，需要把它们与python库放在一起编译，distutils包被用来编译、安装和分发这些模块、扩展和包。

创建一个setup.py 文件，编译最主要的工作由setup()函数来完成：

extension()第一个参数是(完整的)扩展的名字，如果模块是包的一部分的话，还要加上用'.'分隔的完整的包的名字。上述的扩展是独立的，所以名字只要写"extest"就行；sources参数是所有源代码的文件列表，只有一个文件extest2.c。setup需要两个参数：一个名字参数表示要编译哪个内容；另一个列表参数列出要编译的对象，上述要编译的是一个扩展，故把ext_modules参数的值设为扩展模块的列表。

运行setup.py build命令就可以开始编译我们的扩展了，提示部分信息：

（4）导入和测试

你的扩展会被创建在运行setup.py脚本所在目录下的build/lib.*目录中，可以切换到那个目录中来测试模块，或者也可以用命令把它安装到python中：python setup.py install，会提示相应信息。

测试模块：

（5）引用计数和线程安全

python对象引用计数的宏：py_incref(obj)增加对象obj的引用计数，py_decref(obj)减少对象obj的引用计数。py_incref()和py_decref()两个函数也有一个先检查对象是否为空的版本，分别为py_xincref()和py_xdecref()。

编译扩展的程序员必须要注意，代码有可能会被运行在一个多线程的python环境中。这些线程使用了两个c宏py_begin_allow_threads和py_end_allow_threads， 通过将代码和线程隔离，保证了运行和非运行时的安全性，由这些宏包裹的代码将会允许其他线程的运行。

三、c/c++调用python

c++可以调用python脚本，那么就可以写一些python的脚本接口供c++调用了，至少可以把python当成文本形式的动态链接库，

需要的时候还可以改一改，只要不改变接口。缺点是c++的程序一旦编译好了，再改就没那么方便了。

（1）python脚本：pytest.py

（2）c++代码：

（3）c++编译成二进制可执行文件：g++ -o callpy callpy.cpp -i/usr/include/python2.6 -l/usr/lib64/python2.6/config -lpython2.6，编译选项需要手动指定python的include路径和链接接路径（python版本号根据具体情况而定）。

（4）运行结果：

四、总结

（1）python和c/c++的相互调用仅是测试代码，具体的项目开发还得参考python的api文档。

（2）两者交互，c++可为python编写扩展模块，python也可为c++提供脚本接口，更加方便于实际应用。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。如有错误或未考虑完全的地方，望不吝赐教。