使用C语言扩展Python（一）

xinjiang · 发表于 2017-4-29 13:49:36

　　开发环境：Ubuntu9.10,python2.6,gcc4.4.1
　　1,ubuntu下的python运行包和开发包是分开的，因此需要在新利得里面安装python-all-dev,从而可以在代码中引用python的头文件和库。
　　2.下面是一个最简单的可以供python调用的c扩展模块，假设c程序文件名为foo.c:

代码#include<Python.h>

staticPyObject*foo_bar(PyObject*self,PyObject*args){
Py_RETURN_NONE;
}

staticPyMethodDeffoo_methods[]={
{"bar",(PyCFunction)foo_bar,METH_NOARGS,NULL},
{NULL,NULL,0,NULL}
};

PyMODINIT_FUNCinitfoo(){
Py_InitModule3("foo",foo_methods,"Myfirstextensionmodule.");
}

　　我们可以将上述模块分成3个部分：1）c模块想对外暴露的接口函数。2）提供给外部的python程序使用的一个c模块函数名称映射表。3）c模块的初始化函数。模块的第一行将Python.h引入到模块中，这个文件将使得你的模块可以hook进python的解释器，从而可以为外部的python程序所使用。
　　c模块中的函数签名一般有下列三种形式：
PyObject*MyFunction(PyObject*self,PyObject*args);
PyObject*MyFunctionWithKeywords(PyObject*self,PyObject*args,PyObject*kw);
PyObject*MyFunctionWithNoArgs(PyObject*self);

　　一般我们使用的是第一种方式，函数的参数将会一个元组(tuple)的形式传进来，因此我们在c模块的函数中需要对其进行解析。Python中不能象c语言一样声明一个void类型的函数，如果你不想函数返回一个值的话，那就返回一个NONE,在这里我们可以通过Python头文件中的一个宏Py_RETURN_NONE来实现。
　　C模块中的函数名称其实对外部来说是不可见的，因此可以随便你命名，一般我们可以使用static函数（这在C语言里表示在当前文件以外是不可见的）。本文函数命名方式采用模块名加上函数名，例如foo_bar,这表示在模块foo中会有一个bar函数。然后就是函数映射表了，它是一个PyMethodDef结构体数组，
structPyMethodDef{
char*ml_name;
PyCFunctionml_meth;
intml_flags;
char*ml_doc;
};

　　第一个成员ml_name是函数名，当我们在外部的Python代码中使用此模块时利用这个名称进行函数调用。ml_meth是函数地址。ml_flags告诉解释器ml_meth将会使用上述三种方法签名的哪一种，一般设置为METH_VARARGS,如果你想允许关键字参数，则可以将其与METH_KEYWORDS进行或运算。若不想接受任何参数，则可以将其设置为METH_NOARGS.最后，ml_doc字段是函数的注释文档信息，最好还是写几句吧，不然会被鄙视的。。。另外，这个表必须以{NULL,NULL,0,NULL}这样一条空记录结尾。
　　模块的初始化函数是在模块被加载时被Python解释器所调用的，如果你的模块名为foo,则要求命名为initfoo.Py_InitModule3函数一般用来定义一个模块。
　　3,现在我们来将foo.c文件编译为一个扩展模块，使用下述命令进行编译：
gcc-shared-I/usr/include/python2.6foo.c-ofoo.so

　　注意shared object的名称必须和传给Py_InitModule3函数的字符串一致，另一种可选的方式是加上module后缀，因此上述foo模块可以命名为foo.so或foomodule.so。
　　4,上面的编译方式可以完成任务，但更好的生成扩展模块的方法是使用distutils。首先写一个setup.py脚本：
fromdistutils.coreimportsetup,Extension
setup(name='foo',version='1.0',ext_modules=[Extension('foo',['foo.c'])])

　　然后执行下述命令进行build:
python./setup.pybuild

　　这会在当前目录下生成一个build子目录，其中包含了中间生成的foo.o以及最后生成出来的foo.so。当然，最简单的方法是使用下述命令进行模块的生成和安装：
python./setup.pyinstall

　　注：由于需要获得dist-packages的写权限，最好先切换到root用户，如果直接使用su切换出现下面的错误：
su:Authenticationfailure

　　则为root用户设置一个新密码：
sudopasswdroot

　　再用新密码切换到root用户。查看build时的详细情况，我们可以发现这么一句：
copyingbuild/lib.linux-i686-2.6/foo.so->/usr/local/lib/python2.6/dist-packages

　　这是将生成的模块拷贝到/usr/local/lib/python2.6/dist-packages下了，这样就将我们的foo模块安装到系统中了，我们可以验证如下，在python命令行中，
importfoo
dir(foo)

　　结果如下：

['__doc__','__file__','__name__','__package__','bar']

　　呵呵，不错吧，这个foo模块现在已经和其他系统模块一样了，原因就在于dist-packages是在sys.path这个路径中的，
5,现在我们手上已经有一个生成并安装好的C扩展模块了，剩下的就是在python代码中引入这个新模块，并调用它的方法

importfoo
foo.bar()

　　当然，由于在c模块中的bar函数里，我们目前什么都还没做，所以现在啥都没有，在下一篇中我们实现：1)从python脚本里向C模块中传递参数。2)从C模块中返回值给外部的Python脚本

　　夜已经深了，这个python和c/c++,java相结合系列的第一篇就暂时写到这里。。。

账号		自动登录	找回密码
密码			立即注册

大疆运维招人啦，

C++ :try 语句块和异常处理

C++的多态

Red Hat RHCE 8 (EX294) Cert Guide

Java/C++ 区别：看完这一篇，就够用！

别再用过时库了！这 13 个顶级 C++ 库才是

c++ size_t 和 int 的区别

[经验分享] 使用C语言扩展Python（一）

浏览过的版块

扫码加入运维网微信交流群