Python与C/C++的混合调用

一、问题

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

二、Python调用C/C++

1、Python调用C动态链接库

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

(1)C语言文件:pycall.c

  1. /**gcc -o libpycall.so -shared -fPIC pycall.c/
  2. include

  3. include

  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)运行结果:

Python与C/C++的混合调用

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

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

(1)C++类文件:pycallclass.cpp

  1. include

  2. using namespace std;
  3. class TestLib
  4. {
  5. public:
  6. void display ();
  7. void display (int a);
  8. };
  9. void TestLib::display () {
  10. cout<<“First display”<<endl;
  11. }
  12. void TestLib::display (int a) {
  13. cout<<“Second display:”<
  14. }
  15. extern “C” {
  16. TestLib obj;
  17. void display () {
  18. obj.display();
  19. }
  20. void display_int () {
  21. obj.display(2);
  22. }
  23. }

(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)运行结果:

Python与C/C++的混合调用

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

(1)C/C++程序:main.cpp

  1. include

  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=”<
  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. print ‘10
  8. f = os.popen(main)
  9. data = f.readlines()
  10. f.close()
  11. print data
  12. print ‘10
  13. os.system(main)

(4)运行结果:

Python与C/C++的混合调用

4、扩展Python(C++为Python编写扩展模块)

所有能被整合或导入到其它python脚本的代码,都可以被称为扩展。可以用Python来写扩展,也可以用C和C++之类的编译型的语言来写扩展。Python在设计之初就考虑到要让模块的导入机制足够抽象。抽象到让使用模块的代码无法了解到模块的具体实现细节。Python的可扩展性具有的优点:方便为语言增加新功能、具有可定制性、代码可以实现复用等。
为 Python 创建扩展需要三个主要的步骤:创建应用程序代码、利用样板来包装代码和编译与测试。

(1)创建应用程序代码

  1. include

  2. include

  3. include

  4. int fac (int n)
  5. {
  6. if (n < 2) return(1); / 0! == 1! == 1 /
  7. return (n)fac(n -1); / n! == n(n-1)! /
  8. }
  9. char reverse (char s)
  10. {
  11. register char t, / tmp /
  12. p = s, / fwd */
  13. q = (s + (strlen(s) – 1)); / bwd */
  14. while (p < q) / if p < q /
  15. {
  16. t = p; / swap & move ptrs */
  17. p++ = q;
  18. *q– = t;
  19. }
  20. return(s);
  21. }
  22. int main ()
  23. {
  24. char s[BUFSIZ];
  25. printf(“4! == %d\n”, fac(4));
  26. printf(“8! == %d\n”, fac(8));
  27. printf(“12! == %d\n”, fac(12));
  28. strcpy(s, “abcdef”);
  29. printf(“reversing ‘abcdef’, we get ‘%s’\n”, \
  30. reverse(s));
  31. strcpy(s, “madam”);
  32. printf(“reversing ‘madam’, we get ‘%s’\n”, \
  33. reverse(s));
  34. return 0;
  35. }

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

接口的代码被称为”样板”代码,它是应用程序代码与Python解释器之间进行交互所必不可少的一部分。样板主要分为4步:a、包含Python的头文件;b、为每个模块的每一个函数增加一个型如PyObject* Module_func()的包装函数;c、为每个模块增加一个型如PyMethodDef ModuleMethods[]的数组;d、增加模块初始化函数void initModule()。

  1. include

  2. include

  3. include

  4. int fac (int n)
  5. {
  6. if (n < 2) return(1);
  7. return (n)*fac(n -1);
  8. }
  9. char reverse (char s)
  10. {
  11. register char t,
  12. *p = s,
  13. *q = (s + (strlen(s) – 1));
  14. while (s && (p < q))
  15. {
  16. t = *p;
  17. p++ = q;
  18. *q– = t;
  19. }
  20. return(s);
  21. }
  22. int test ()
  23. {
  24. char s[BUFSIZ];
  25. printf(“4! == %d\n”, fac(4));
  26. printf(“8! == %d\n”, fac(8));
  27. printf(“12! == %d\n”, fac(12));
  28. strcpy(s, “abcdef”);
  29. printf(“reversing ‘abcdef’, we get ‘%s’\n”, \
  30. reverse(s));
  31. strcpy(s, “madam”);
  32. printf(“reversing ‘madam’, we get ‘%s’\n”, \
  33. reverse(s));
  34. return 0;
  35. }
  36. include “Python.h”

  37. static PyObject *
  38. Extest_fac (PyObject self, PyObject args)
  39. {
  40. int num;
  41. if (!PyArg_ParseTuple(args, “i”, &num))
  42. return NULL;
  43. return (PyObject*)Py_BuildValue(“i”, fac(num));
  44. }
  45. static PyObject *
  46. Extest_doppel (PyObject self, PyObject args)
  47. {
  48. char *orig_str;
  49. char *dupe_str;
  50. PyObject* retval;
  51. if (!PyArg_ParseTuple(args, “s”, &orig_str))
  52. return NULL;
  53. retval = (PyObject*)Py_BuildValue(“ss”, orig_str,
  54. dupe_str=reverse(strdup(orig_str)));
  55. free(dupe_str); #防止内存泄漏
  56. return retval;
  57. }
  58. static PyObject *
  59. Extest_test (PyObject self, PyObject args)
  60. {
  61. test();
  62. return (PyObject*)Py_BuildValue(“”);
  63. }
  64. static PyMethodDef
  65. ExtestMethods[] =
  66. {
  67. { “fac”, Extest_fac, METH_VARARGS },
  68. { “doppel”, Extest_doppel, METH_VARARGS },
  69. { “test”, Extest_test, METH_VARARGS },
  70. { NULL, NULL },
  71. };
  72. void initExtest ()
  73. {
  74. Py_InitModule(“Extest”, ExtestMethods);
  75. }

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之间数据转换的转换代码:

Python与C/C++的混合调用
为每个模块增加一个型如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. from distutils.core import setup, Extension
  3. MOD = ‘Extest’
  4. setup(name=MOD, ext_modules=[Extension(MOD, sources=[‘Extest2.c’])])

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

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

creating build/lib.linux-x86_64-2.6
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,会提示相应信息。
测试模块:

Python与C/C++的混合调用

(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. def foo(a):
  9. print “in python function foo”
  10. print “a = ” + str(a)
  11. print “ret = ” + str(a * a)
  12. return
  13. class guestlist:
  14. def init(self):
  15. print “aaaa”
  16. def p():
  17. print “bbbbb”
  18. def getitem(self, id):
  19. return “ccccc”
  20. def update():
  21. guest = guestlist()
  22. print guest[‘aa’]
  23. update()

(2)C++代码:

  1. /g++ -o callpy callpy.cpp -I/usr/include/python2.6 -L/usr/lib64/python2.6/config -lpython2.6/
  2. int main (int argc, char** argv)
  3. {
  4. // 初始化Python
  5. //在使用Python系统前,必须使用Py_Initialize对其
  6. //进行初始化。它会载入Python的内建模块并添加系统路
  7. //径到模块搜索路径中。这个函数没有返回值,检查系统
  8. //是否初始化成功需要使用Py_IsInitialized。
  9. Py_Initialize();
  10. // 检查初始化是否成功
  11. if ( !Py_IsInitialized() ) {
  12. return -1;
  13. }
  14. // 添加当前路径
  15. //把输入的字符串作为Python代码直接运行,返回0
  16. //表示成功,-1表示有错。大多时候错误都是因为字符串
  17. //中有语法错误。
  18. PyRun_SimpleString(“import sys”);
  19. PyRun_SimpleString(“print ‘—import sys—‘”);
  20. PyRun_SimpleString(“sys.path.append(‘./’)”);
  21. PyObject pName,pModule,pDict,pFunc,*pArgs;
  22. // 载入名为pytest的脚本
  23. pName = PyString_FromString(“pytest”);
  24. pModule = PyImport_Import(pName);
  25. if ( !pModule ) {
  26. printf(“can’t find pytest.py”);
  27. getchar();
  28. return -1;
  29. }
  30. pDict = PyModule_GetDict(pModule);
  31. if ( !pDict ) {
  32. return -1;
  33. }
  34. // 找出函数名为add的函数
  35. printf(“———————-\n”);
  36. pFunc = PyDict_GetItemString(pDict, “add”);
  37. if ( !pFunc || !PyCallable_Check(pFunc) ) {
  38. printf(“can’t find function [add]”);
  39. getchar();
  40. return -1;
  41. }
  42. // 参数进栈
  43. PyObject *pArgs;
  44. pArgs = PyTuple_New(2);
  45. // PyObject Py_BuildValue(char format, …)
  46. // 把C++的变量转换成一个Python对象。当需要从
  47. // C++传递变量到Python时,就会使用这个函数。此函数
  48. // 有点类似C的printf,但格式不同。常用的格式有
  49. // s 表示字符串,
  50. // i 表示整型变量,
  51. // f 表示浮点数,
  52. // O 表示一个Python对象。
  53. PyTuple_SetItem(pArgs, 0, Py_BuildValue(“l”,3));
  54. PyTuple_SetItem(pArgs, 1, Py_BuildValue(“l”,4));
  55. // 调用Python函数
  56. PyObject_CallObject(pFunc, pArgs);
  57. //下面这段是查找函数foo 并执行foo
  58. printf(“———————-\n”);
  59. pFunc = PyDict_GetItemString(pDict, “foo”);
  60. if ( !pFunc || !PyCallable_Check(pFunc) ) {
  61. printf(“can’t find function [foo]”);
  62. getchar();
  63. return -1;
  64. }
  65. pArgs = PyTuple_New(1);
  66. PyTuple_SetItem(pArgs, 0, Py_BuildValue(“l”,2));
  67. PyObject_CallObject(pFunc, pArgs);
  68. printf(“———————-\n”);
  69. pFunc = PyDict_GetItemString(pDict, “update”);
  70. if ( !pFunc || !PyCallable_Check(pFunc) ) {
  71. printf(“can’t find function [update]”);
  72. getchar();
  73. return -1;
  74. }
  75. pArgs = PyTuple_New(0);
  76. PyTuple_SetItem(pArgs, 0, Py_BuildValue(“”));
  77. PyObject_CallObject(pFunc, pArgs);
  78. Py_DECREF(pName);
  79. Py_DECREF(pArgs);
  80. Py_DECREF(pModule);
  81. // 关闭Python
  82. Py_Finalize();
  83. return 0;
  84. }

(3)C++编译成二进制可执行文件:g++ -o callpy callpy.cpp -I/usr/include/python2.6 -L/usr/lib64/python2.6/config -lpython2.6,编译选项需要手动指定Python的include路径和链接接路径(Python版本号根据具体情况而定)。
(4)运行结果:

Python与C/C++的混合调用

Original: https://www.cnblogs.com/leoking01/p/14591148.html
Author: leoking01
Title: Python与C/C++的混合调用

原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/10758/

转载文章受原作者版权保护。转载请注明原作者出处!

(0)

大家都在看

免费咨询
免费咨询
扫码关注
扫码关注
联系站长

站长Johngo!

大数据和算法重度研究者!

持续产出大数据、算法、LeetCode干货,以及业界好资源!

2022012703491714

微信来撩,免费咨询:xiaozhu_tec

分享本页
返回顶部