Python实例浅谈之三Python与C/C++相互调用

转载：http://blog.csdn.net/taiyang1987912/article/details/44779719

一、问题

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

二、Python调用C/C++

 

 

1、Python调用C动态链接库

        Python调用C库比较简单，不经过任何封装打包成so，再使用python的ctypes调用即可。
（1）C语言文件：pycall.c

[html] view plain copy
 
  1. /***gcc -o libpycall.so -shared -fPIC pycall.c*/  
  2. #include <stdio.h>  
  3. #include <stdlib.h>  
  4. int foo(int a, int b)  
  5. {  
  6.   printf("you input %d and %d\n", a, b);  
  7.   return a+b;  
  8. }  
（2）gcc编译生成动态库libpycall.so：gcc -o libpycall.so -shared -fPIC pycall.c。使用g++编译生成C动态库的代码中的函数或者方法时，需要使用extern "C"来进行编译。
（3）Python调用动态库的文件：pycall.py
  1. import ctypes  
  2. ll = ctypes.cdll.LoadLibrary   
  3. lib = ll("./libpycall.so")    
  4. lib.foo(1, 3)  
  5. print '***finish***'  
（4）运行结果：

2、Python调用C++(类)动态链接库 

       需要extern "C"来辅助，也就是说还是只能调用C函数，不能直接调用方法，但是能解析C++方法。不是用extern "C"，构建后的动态链接库没有这些函数的符号表。
（1）C++类文件：pycallclass.cpp
 
  1. #include <iostream>  
  2. using namespace std;  
  3.   
  4. class TestLib  
  5. {  
  6.     public:  
  7.         void display();  
  8.         void display(int a);  
  9. };  
  10. void TestLib::display() {  
  11.     cout<<"First display"<<endl;  
  12. }  
  13.   
  14. void TestLib::display(int a) {  
  15.     cout<<"Second display:"<<a<<endl;  
  16. }  
  17. extern "C" {  
  18.     TestLib obj;  
  19.     void display() {  
  20.         obj.display();   
  21.       }  
  22.     void display_int() {  
  23.         obj.display(2);   
  24.       }  
  25. }  
（2）g++编译生成动态库libpycall.so：g++ -o libpycallclass.so -shared -fPIC pycallclass.cpp。
（3）Python调用动态库的文件：pycallclass.py
 
  1. import ctypes  
  2. so = ctypes.cdll.LoadLibrary   
  3. lib = so("./libpycallclass.so")   
  4. print 'display()'  
  5. lib.display()  
  6. print 'display(100)'  
  7. lib.display_int(100)  
（4）运行结果：

3、Python调用C/C++可执行程序

（1）C/C++程序：main.cpp
[html] view plain copy
 
  1. #include <iostream>  
  2. using namespace std;  
  3. int test()  
  4. {  
  5.     int a = 10, b = 5;  
  6.     return a+b;  
  7. }  
  8. int main()  
  9. {  
  10.     cout<<"---begin---"<<endl;  
  11.     int num = test();  
  12.     cout<<"num="<<num<<endl;  
  13.     cout<<"---end---"<<endl;  
  14. }  
（2）编译成二进制可执行文件：g++ -o testmain main.cpp。
（3）Python调用程序：main.py
 
  1. import commands  
  2. import os  
  3. main = "./testmain"  
  4. if os.path.exists(main):  
  5.     rc, out = commands.getstatusoutput(main)  
  6.     print 'rc = %d, \nout = %s' % (rc, out)  
  7.   
  8. print '*'*10  
  9. f = os.popen(main)    
  10. data = f.readlines()    
  11. f.close()    
  12. print data  
  13.   
  14. print '*'*10  
  15. os.system(main)  
（4）运行结果：

 

4、扩展Python（C++为Python编写扩展模块）

       所有能被整合或导入到其它python脚本的代码，都可以被称为扩展。可以用Python来写扩展，也可以用C和C++之类的编译型的语言来写扩展。Python在设计之初就考虑到要让模块的导入机制足够抽象。抽象到让使用模块的代码无法了解到模块的具体实现细节。Python的可扩展性具有的优点：方便为语言增加新功能、具有可定制性、代码可以实现复用等。
       为 Python 创建扩展需要三个主要的步骤：创建应用程序代码、利用样板来包装代码和编译与测试。
（1）创建应用程序代码
 
  1. #include <stdio.h>  
  2. #include <stdlib.h>  
  3. #include <string.h>  
  4.   
  5. int fac(int n)  
  6. {  
  7.     if (n < 2) return(1); /* 0! == 1! == 1 */  
  8.     return (n)*fac(n-1); /* n! == n*(n-1)! */  
  9. }  
  10.   
  11. char *reverse(char *s)  
  12. {  
  13.     register char t,                    /* tmp */  
  14.             *p = s,                     /* fwd */  
  15.             *q = (s + (strlen(s) - 1)); /* bwd */  
  16.   
  17.     while (p < q)               /* if p < q */  
  18.     {  
  19.         t = *p;         /* swap & move ptrs */  
  20.         *p++ = *q;  
  21.         *q-- = t;  
  22.     }  
  23.     return(s);  
  24. }  
  25.   
  26. int main()  
  27. {  
  28.     char s[BUFSIZ];  
  29.     printf("4! == %d\n", fac(4));  
  30.     printf("8! == %d\n", fac(8));  
  31.     printf("12! == %d\n", fac(12));  
  32.     strcpy(s, "abcdef");  
  33.     printf("reversing 'abcdef', we get '%s'\n", \  
  34.         reverse(s));  
  35.     strcpy(s, "madam");  
  36.     printf("reversing 'madam', we get '%s'\n", \  
  37.         reverse(s));  
  38.     return 0;  
  39. }  
       上述代码中有两个函数，一个是递归求阶乘的函数fac()；另一个reverse()函数实现了一个简单的字符串反转算法，其主要目的是修改传入的字符串，使其内容完全反转，但不需要申请内存后反着复制的方法。
（2）用样板来包装代码
        接口的代码被称为“样板”代码，它是应用程序代码与Python解释器之间进行交互所必不可少的一部分。样板主要分为4步：a、包含Python的头文件；b、为每个模块的每一个函数增加一个型如PyObject* Module_func()的包装函数；c、为每个模块增加一个型如PyMethodDef ModuleMethods[]的数组；d、增加模块初始化函数void initModule()。
 
  1. #include <stdio.h>  
  2. #include <stdlib.h>  
  3. #include <string.h>  
  4.   
  5. int fac(int n)  
  6. {  
  7.     if (n < 2) return(1);  
  8.     return (n)*fac(n-1);  
  9. }  
  10.   
  11. char *reverse(char *s)  
  12. {  
  13.     register char t,  
  14.             *p = s,  
  15.             *q = (s + (strlen(s) - 1));  
  16.   
  17.     while (s && (p < q))  
  18.     {  
  19.         t = *p;  
  20.         *p++ = *q;  
  21.         *q-- = t;  
  22.     }  
  23.     return(s);  
  24. }  
  25.   
  26. int test()  
  27. {  
  28.     char s[BUFSIZ];  
  29.     printf("4! == %d\n", fac(4));  
  30.     printf("8! == %d\n", fac(8));  
  31.     printf("12! == %d\n", fac(12));  
  32.     strcpy(s, "abcdef");  
  33.     printf("reversing 'abcdef', we get '%s'\n", \  
  34.         reverse(s));  
  35.     strcpy(s, "madam");  
  36.     printf("reversing 'madam', we get '%s'\n", \  
  37.         reverse(s));  
  38.     return 0;  
  39. }  
  40.   
  41. #include "Python.h"  
  42.   
  43. static PyObject *  
  44. Extest_fac(PyObject *self, PyObject *args)  
  45. {  
  46.     int num;  
  47.     if (!PyArg_ParseTuple(args, "i", &num))  
  48.         return NULL;  
  49.     return (PyObject*)Py_BuildValue("i", fac(num));  
  50. }  
  51.   
  52. static PyObject *  
  53. Extest_doppel(PyObject *self, PyObject *args)  
  54. {  
  55.     char *orig_str;  
  56.     char *dupe_str;  
  57.     PyObject* retval;  
  58.   
  59.     if (!PyArg_ParseTuple(args, "s", &orig_str))  
  60.         return NULL;  
  61.     retval = (PyObject*)Py_BuildValue("ss", orig_str,  
  62.         dupe_str=reverse(strdup(orig_str)));  
  63.     free(dupe_str);             #防止内存泄漏  
  64.     return retval;  
  65. }  
  66.   
  67. static PyObject *  
  68. Extest_test(PyObject *self, PyObject *args)  
  69. {  
  70.     test();  
  71.     return (PyObject*)Py_BuildValue("");  
  72. }  
  73.   
  74. static PyMethodDef  
  75. ExtestMethods[] =  
  76. {  
  77.     { "fac", Extest_fac, METH_VARARGS },  
  78.     { "doppel", Extest_doppel, METH_VARARGS },  
  79.     { "test", Extest_test, METH_VARARGS },  
  80.     { NULL, NULL },  
  81. };  
  82.   
  83. void initExtest()  
  84. {  
  85.     Py_InitModule("Extest", ExtestMethods);  
  86. }  
        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()函数来完成：
 
  1. #!/usr/bin/env python  
  2.   
  3. from distutils.core import setup, Extension  
  4.   
  5. MOD = 'Extest'  
  6. setup(name=MOD, ext_modules=[Extension(MOD, sources=['Extest2.c'])])  
        Extension()第一个参数是(完整的)扩展的名字，如果模块是包的一部分的话，还要加上用'.'分隔的完整的包的名字。上述的扩展是独立的，所以名字只要写"Extest"就行；sources参数是所有源代码的文件列表，只有一个文件Extest2.c。setup需要两个参数：一个名字参数表示要编译哪个内容；另一个列表参数列出要编译的对象，上述要编译的是一个扩展，故把ext_modules参数的值设为扩展模块的列表。
        运行setup.py build命令就可以开始编译我们的扩展了，提示部分信息：
 
  1. creating build/lib.linux-x86_64-2.6  
  2. gcc -pthread -shared build/temp.linux-x86_64-2.6/Extest2.o -L/usr/lib64 -lpython2.6 -o build/lib.linux-x86_64-2.6/Extest.so  
（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

  1. #test function  
  2. def add(a,b):  
  3.     print "in python function add"  
  4.     print "a = " + str(a)  
  5.     print "b = " + str(b)  
  6.     print "ret = " + str(a+b)  
  7.     return  
  8.   
  9. def foo(a):  
  10.   
  11.     print "in python function foo"  
  12.     print "a = " + str(a)  
  13.     print "ret = " + str(a * a)  
  14.     return   
  15.   
  16. class guestlist:  
  17.     def __init__(self):  
  18.         print "aaaa"  
  19.     def p():  
  20.       print "bbbbb"  
  21.     def __getitem__(self, id):  
  22.       return "ccccc"  
  23. def update():  
  24.     guest = guestlist()  
  25.     print guest['aa']  
  26.   
  27. #update()  
（2）C++代码：
 
  1. /**g++ -o callpy callpy.cpp -I/usr/include/python2.6 -L/usr/lib64/python2.6/config -lpython2.6**/  
  2. #include <Python.h>  
  3. int main(int argc, char** argv)  
  4. {  
  5.     // 初始化Python  
  6.     //在使用Python系统前，必须使用Py_Initialize对其  
  7.     //进行初始化。它会载入Python的内建模块并添加系统路  
  8.     //径到模块搜索路径中。这个函数没有返回值，检查系统  
  9.     //是否初始化成功需要使用Py_IsInitialized。  
  10.     Py_Initialize();  
  11.   
  12.     // 检查初始化是否成功  
  13.     if ( !Py_IsInitialized() ) {  
  14.         return -1;  
  15.     }  
  16.     // 添加当前路径  
  17.     //把输入的字符串作为Python代码直接运行，返回0  
  18.     //表示成功，-1表示有错。大多时候错误都是因为字符串  
  19.     //中有语法错误。  
  20.     PyRun_SimpleString("import sys");  
  21.     PyRun_SimpleString("print '---import sys---'");   
  22.     PyRun_SimpleString("sys.path.append('./')");  
  23.     PyObject *pName,*pModule,*pDict,*pFunc,*pArgs;  
  24.   
  25.     // 载入名为pytest的脚本  
  26.     pName = PyString_FromString("pytest");  
  27.     pModule = PyImport_Import(pName);  
  28.     if ( !pModule ) {  
  29.         printf("can't find pytest.py");  
  30.         getchar();  
  31.         return -1;  
  32.     }  
  33.     pDict = PyModule_GetDict(pModule);  
  34.     if ( !pDict ) {  
  35.         return -1;  
  36.     }  
  37.   
  38.     // 找出函数名为add的函数  
  39.     printf("----------------------\n");  
  40.     pFunc = PyDict_GetItemString(pDict, "add");  
  41.     if ( !pFunc || !PyCallable_Check(pFunc) ) {  
  42.         printf("can't find function [add]");  
  43.         getchar();  
  44.         return -1;  
  45.      }  
  46.   
  47.     // 参数进栈  
  48.     PyObject *pArgs;  
  49.     pArgs = PyTuple_New(2);  
  50.   
  51.     //  PyObject* Py_BuildValue(char *format, ...)  
  52.     //  把C++的变量转换成一个Python对象。当需要从  
  53.     //  C++传递变量到Python时，就会使用这个函数。此函数  
  54.     //  有点类似C的printf，但格式不同。常用的格式有  
  55.     //  s 表示字符串，  
  56.     //  i 表示整型变量，  
  57.     //  f 表示浮点数，  
  58.     //  O 表示一个Python对象。  
  59.   
  60.     PyTuple_SetItem(pArgs, 0, Py_BuildValue("l",3));  
  61.     PyTuple_SetItem(pArgs, 1, Py_BuildValue("l",4));  
  62.   
  63.     // 调用Python函数  
  64.     PyObject_CallObject(pFunc, pArgs);  
  65.   
  66.     //下面这段是查找函数foo 并执行foo  
  67.     printf("----------------------\n");  
  68.     pFunc = PyDict_GetItemString(pDict, "foo");  
  69.     if ( !pFunc || !PyCallable_Check(pFunc) ) {  
  70.         printf("can't find function [foo]");  
  71.         getchar();  
  72.         return -1;  
  73.      }  
  74.   
  75.     pArgs = PyTuple_New(1);  
  76.     PyTuple_SetItem(pArgs, 0, Py_BuildValue("l",2));   
  77.   
  78.     PyObject_CallObject(pFunc, pArgs);  
  79.        
  80.     printf("----------------------\n");  
  81.     pFunc = PyDict_GetItemString(pDict, "update");  
  82.     if ( !pFunc || !PyCallable_Check(pFunc) ) {  
  83.         printf("can't find function [update]");  
  84.         getchar();  
  85.         return -1;  
  86.      }  
  87.     pArgs = PyTuple_New(0);  
  88.     PyTuple_SetItem(pArgs, 0, Py_BuildValue(""));  
  89.     PyObject_CallObject(pFunc, pArgs);       
  90.   
  91.     Py_DECREF(pName);  
  92.     Py_DECREF(pArgs);  
  93.     Py_DECREF(pModule);  
  94.   
  95.     // 关闭Python  
  96.     Py_Finalize();  
  97.     return 0;  
  98. }   
（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++提供脚本接口，更加方便于实际应用。
（3）若有不足，请留言，在此先感谢！
posted @ 2017-12-21 10:52  deadwood_2016  阅读(214)  评论(0)  编辑  收藏  举报