开发者社区> xiaoyuaner> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

Python的C/C++扩展——Python的C语言接口

简介: Python语言最初是用C语言实现的一种脚本语言,后来被称为CPython,是因为后来又有其它语言实现的Python,比如Python实现的Python——PyPy,Java语言实现的Python——Jython,.Net实现的Python——IronPython。
+关注继续查看

Python语言最初是用C语言实现的一种脚本语言,后来被称为CPython,是因为后来又有其它语言实现的Python,比如Python实现的Python——PyPy,Java语言实现的Python——Jython,.Net实现的Python——IronPython。
23e4b95b0fa64f202e3dfa0052519c170d0

CPython具有优良的开放性和可扩展性,并提供了方便灵活的应用程序接口(API),从而使得C/C++程序员能够在各个级别上对Python解释器的功能进行扩展。

Python的C语言接口很适合封装C语言实现的各种函数,如果要封装C++的类,使用boost_python或者SWIG更方便和合适。

1 模块封装

假设我们有一个C函数:

/* 文件名: mylib.c */
int addone(int a) {
    return a+1;
}

如果想在Python解释器中调用该函数,则应该首先将其实现为Python中的一个模块,这需要编写相应的封装接口,如下所示:

/* wrap_mylib.c */
#include <Python.h>
#include "mylib.h"
PyObject* wrap_addone(PyObject* self, PyObject* args) 
{
  int n, result;

  if (! PyArg_ParseTuple(args, "i:fact", &n))
    return NULL;
  result = addone(n); /*这里调用C函数 */
  return Py_BuildValue("i", result);
}
static PyMethodDef mylibMethods[] = 
{
  {"addone", wrap_addone, METH_VARARGS, "Add one to N"},
  {NULL, NULL}
};
void initmylib() 
{
  PyObject* m;
  m = Py_InitModule("mylib", mylibMethods);
}

上面就是一个典型的Python扩展模块,它至少应该包含三个部分:

导出函数:wrap_addone();
方法列表:mylibMethods[];
初始化函数: initmylib()

2 导出函数

要在Python解释器中调用C语言中的某个函数,首先要为它编写对应的导出函数,上述例子中的导出函数为wrap_addone。在Python的C语言扩展中,所有的导出函数都具有相同的函数原型:

PyObject wrap_method(PyObject self, PyObject* args);
这个函数是Python解释器和C函数进行交互的接口,一般以wrap_开头后面跟上C语言的函数名,这样命名把导出函数和C语言函数对应起来使得代码更加清晰。它带有两个参数:self和args。

参数self 只在C函数被实现为内联方法(built-in method)时才被用到,通常该参数的值为空(NULL)。
参数args 中包含了Python解释器要传递给C函数的所有参数,通常使用Python的C语言扩展接口提供的函数PyArg_ParseTuple()来获得这些参数值。

所有的导出函数都返回一个PyObject指针,如果对应的C函数没有真正的返回值(即返回值类型为void),则应返回一个全局的None对象(Py_None),并将其引用计数增1,如下所示:

PyObject* wrap_method(PyObject *self, PyObject *args) 
{
  Py_INCREF(Py_None);
  return Py_None;
}

3 方法列表

方法列表中列出了所有可以被Python解释器使用的方法,上述例子对应的方法列表为:

static PyMethodDef mylibMethods[] = 
{
  {"addone", wrap_addone, METH_VARARGS, "Add one to N"},
  {NULL, NULL}
};

方法列表中的每项由四个部分组成:

  • 方法名
    导出函数

参数传递方式
方法描述

方法名是从Python解释器中调用该方法时所使用的名字。
参数传递方式则规定了Python向C函数传递参数的具体形式,可选的两种方式是METH_VARARGS和METH_KEYWORDS,其中METH_VARARGS是参数传递的标准形式,它通过Python的元组在Python解释器和C函数之间传递参数,若采用METH_KEYWORD方式,则Python解释器和C函数之间将通过Python的字典类型在两者之间进行参数传递。

4 初始化函数

所有的Python扩展模块都必须要有一个初始化函数,以便Python解释器能够对模块进行正确的初始化。Python解释器规定所有的初始化函数的函数名都必须以init开头,并加上模块的名字。对于模块mylib来说,则相应的初始化函数为:

void initmylib() 
{
  PyObject* m;
  m = Py_InitModule("mylib", mylibMethods);
}

当Python解释器需要导入该模块时,将根据该模块的名称查找相应的初始化函数,一旦找到则调用该函数进行相应的初始化工作,初始化函数则通过调用Python的C语言扩展接口所提供的函数Py_InitModule(),来向Python解释器注册该模块中所有可以用到的方法。

5 编译链接

要在Python解释器中使用C语言编写的扩展模块,必须将其编译成动态链接库的形式。下面以Linux为例,介绍如何将C编写的Python扩展模块编译成动态链接库:

$ gcc -fpic -shared -o mylib.so \
             -I/usr/include/python2.7 \
            mylib.c wrap_mylib.c

6 在Python中调用

上面编译生成的Python扩展模块的动态链接库,可以在Python中直接import。如下所示:

veelion@gtx:~$ python
Python 2.7.12 (default, Nov 19 2016, 06:48:10) 
[GCC 5.4.0 20160609] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import example
>>> example.addone(7)
8
>>>

这里生成的.so动态库和上一篇中不用Python的C语言生成的动态库是不一样的,从生成过程和使用方法就可以看出来,这里的动态库使用起来感觉就是一个Python模块,直接import就可以了。

文章来源于:猿人学网站的python教程
版权申明:若没有特殊说明,文章皆是猿人学原创,没有猿人学授权,请勿以任何形式转载。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
用python怎样实现接口测试
一、什么是接口测试? 接口可以分下面几种 1、系统与系统之间的调用,比如银行会提供接口供电子商务网站调用,或者说,支付宝会提供接口给淘宝调用 2、上层服务对下层服务的调用,比如service层会调用DAO层的接口,而应用层又会调用服务层提供的接口,一般会通过服务之间的调用,比如注册用户时,会先调用用户查询的服务,查看该用户是否已经注册。
972 0
+关注
文章
问答
文章排行榜
最热
最新
相关电子书
更多
Python系列直播第一讲——Python中的一切皆对象
立即下载
Python 脚本速查手册
立即下载
使用C++开发PHP7扩展
立即下载