舒彩光的互联网生涯
用心做事做人,做最认真的程序员

用一个简单示例演示在python中调用C及C++

2016年11月20日 05:15,by 舒彩光

只要会C语言编程就很容易为python添加新的内置模块。可以通的C的扩展模块做两种事,一是实现新的内置对象类型。另一个是调用c的库函数与系统调用。

为了支持C扩展,Python API定义了一系列函数,变量及宏。只要在C或C++代码里引入“python.h”头文件就可以使用这些定义。

简单示例:hello world

现在我们写一个简单的扩展模块实例,用c输出hello world!。我们将这个模块命名为hello。于是我们

创建一个名称为hellomodule.c的文件,文件第一行我们引入头文件

#include <Python.h>

Python API 里的变量,函数,宏都是是 Py或PY 开头。在python.h 里已经包含了<stdio.h><string.h><errno.h>和<stdlib.h>这几个头文件。如果这些系统头文件不存在,python将自己定义malloc(),free(),和realloc()三个函数。

接下来我们将要实现的功能以c函数的形式定在代码里

static PyObject* hello(PyObject* self,PyObject* args)
{
	return Py_BuildValue("s","hello world!");
}

这个函数只有一个功能就是返回hello world!的字符串。这个c函数包含self与args两个参数。

如果当作模块函数,self通常为NULL或初始化模块时选择的指针。如果作为方法,self指向对象实例

args顾名思义是python传给c的参数,它是以元组的形式组合的多个参数。用PyArg_ParseTuple()函数就可将这个元组转换为c的值。以后的内容我们会介绍这个函数。

模块函数表

为了能够在python中调用这个c函数,我们需要将函数名称和函数地址写进函数表。

static PyMethodDef methods[]={
	{"hello",hello,METH_VARARGS,"示例"},
	{NULL,NULL,0,NULL}
};

第三个参数“METH_VARARGS”告诉解释器用于c函数的调用约定,这个参数经常是“METH_VARARGS”或“METH_VARARGS|METH_KEYWORDS”。

如果只为METH_VARARGS时, 传入的参数可以使用PyArg_ParseTuple()解析

如果包含METH_KEYWORDS,这个函数将会有三个参数keywords

hello(PyObject* self,PyObject* args,PyObject* keywords)

第三个参数需要用PyArg_ParseTupleAndKeywords()解析出里面的值

初始化

函数表必须通过初始函数传递给解析器。初始化函数的名称必须是init+模块名。这个函数必须是non-static的。我们示例中的初始化函数如下:

PyMODINIT_FUNC inithello()
{
	Py_InitModule("hello",methods);
}

PyMODINIT_FUNC定义这个函数的返回值为void类型。如果代码是c++还定义extern "C"

至此整个hellomodule.c的内容全部完成。

编译

在hellomodule.c文件同目录编写setup.py内容如下:

from distutils.core import setup, Extension  

MOD = 'hello'
setup(name=MOD,ext_modules=[Extension(MOD,sources=['hellowmodule.c'])])

编写完后,保存退出。输入如下的命令:

setup.py build

然后就会开始编译成hello模块

安装

运行命今

setup.py install

刚刚编译好的模块就已安装完成。

编写测试代码test.py:

import hello

s = hello.hello()
print s

保存运行一下test.py。输出结果为

hello world!