学步园

Python与C集成 

作者：张元礼 

   近期为了研究一个新的测试工具，需要Python与C集成交互，为此特对Python进行初步的研究和查阅相关资料，得出一个初步的研究成果，供大家分享交流。 

一、 软件安装

1、  Python-2.3.3.exe（注意：版本有关系，有些高版本有问题）

2、  VC 6.0

二、运行环境配置

1、本文默认Python的安装目录为：C:/Python23；在VC IDE中Tools->Options->Directories配置Include files为：C:/Python23/include；Library files为：C:/Python23/libs；

2、如需要Debug版本的要下载python23_d.lib和python23_d.dll这两个文件，也可以下载Python源码来编译获得，具体可查阅相应文档。

三、C调用Python

1、Test.c源码

int main(int argc, char** argv)<br /> {<br /> //初始化Python<br /> //在使用Python系统前，必须使用Py_Initialize对其<br /> //进行初始化。它会载入Python的内建模块并添加系统路<br /> //径到模块搜索路径中。这个函数没有返回值，检查系统<br /> //是否初始化成功需要使用Py_IsInitialized。<br /> PyObject *pName,*pModule,*pDict,*pFunc,*pArgs;<br /> Py_Initialize();</p> <p> // 检查初始化是否成功<br /> if ( !Py_IsInitialized() )<br /> {<br /> return -1;<br /> } </p> <p> //添加当前路径<br /> //把输入的字符串作为Python代码直接运行，返回0<br /> //表示成功，-1表示有错。大多时候错误都是因为字符串<br /> //中有语法错误。<br /> PyRun_SimpleString("import sys");<br /> PyRun_SimpleString("sys.path.append('./')"); </p> <p> // 载入名为pytest的脚本<br /> pName = PyString_FromString("pytest");</p> <p> pModule = PyImport_Import(pName);<br /> if ( !pModule )<br /> {<br /> printf("can't find pytest.py");<br /> getchar();<br /> return -1;<br /> } </p> <p> pDict = PyModule_GetDict(pModule);<br /> if ( !pDict )<br /> {<br /> return -1;<br /> } </p> <p> // 找出函数名为add的函数<br /> pFunc = PyDict_GetItemString(pDict, "vcadd");<br /> if ( !pFunc || !PyCallable_Check(pFunc) )<br /> {<br /> printf("can't find function [vcadd]");<br /> getchar();<br /> return -1;<br /> } </p> <p> // 参数进栈<br /> *pArgs;<br /> pArgs = PyTuple_New(2); </p> <p> // PyObject* Py_BuildValue(char *format, ...)<br /> // 把C++的变量转换成一个Python对象。当需要从<br /> // C++传递变量到Python时，就会使用这个函数。此函数<br /> // 有点类似C的printf，但格式不同。常用的格式有<br /> // s 表示字符串，<br /> // i 表示整型变量，<br /> // f 表示浮点数，<br /> // O 表示一个Python对象。<br /> PyTuple_SetItem(pArgs, 0, Py_BuildValue("l",3));<br /> PyTuple_SetItem(pArgs, 1, Py_BuildValue("l",4)); </p> <p> // 调用Python函数<br /> PyObject_CallObject(pFunc, pArgs); </p> <p> //下面这段是查找函数foo 并执行foo<br /> pFunc = PyDict_GetItemString(pDict, "vcfoo");<br /> if ( !pFunc || !PyCallable_Check(pFunc) )<br /> {<br /> printf("can't find function [vcfoo]");<br /> getchar();<br /> return -1;<br /> } </p> <p> pArgs = PyTuple_New(1);<br /> PyTuple_SetItem(pArgs, 0, Py_BuildValue("l",2)); // </p> <p> PyObject_CallObject(pFunc, pArgs); </p> <p> Py_DECREF(pName);<br /> Py_DECREF(pArgs);<br /> Py_DECREF(pModule); </p> <p> // 关闭Python<br /> Py_Finalize();<br /> return 0;<br /> }    

2、  pytest.py源码

def add(a,b):<br /> print "in python function add"<br /> print "a = " + str(a)<br /> print "b = " + str(b)<br /> print "ret = " + str(a+b)<br /> return</p> <p>  

3、运行设置

 将pytest.py文件与C工程编译的exe文件存放同一目录下（具体的存放路径应该可以统一配置，在此不便描述），启动编译的exe文件后即可调用pytest.py文件的函数及执行结果。

四、Python调用C

1、建立一个目录，整个目录名中不要包含中文。在目录下建立 add.c，内容如下：

#include <Python.h>;<br /> static PyObject* add(PyObject *self, PyObject *args);<br /> //一定声明为static，把他们限制在这个文件范围里。 几乎所有的参数都是PyObject类型。 在python，每个东西都是object。<br /> static PyObject* add(PyObject* self, PyObject* args)<br /> {<br /> int x=0 ;<br /> int y=0;<br /> int z=0;<br /> if (! PyArg_ParseTuple(args, "i|i", &x, &y))<br /> return NULL;<br /> /*第一个参数是self，这个是python用的， 每个函数都要有。我们暂时不管。args是一个参数列表。她把所有的参数都整合成一个string。所以 我们需要从这个string里来解析我们的参数。PyArg_ParseTuple来完成这个任务。第一个参数是args， 就是我们要转换的参数。第二个是格式符号。“s”代表是个string。 从args里提取一个参数就写"s", 两个的话就写"s|s", 如果是一个string，一个int，就写"s|i", 和printf差不多。第三个 参数就是提取出来的参数放置的真正位置。必须传递这个参数的地址。对于add， 他将提取两个参数。分别是x和y。*/<br /> z=x+y;<br /> return Py_BuildValue("i", z);<br /> /*调用完之后我们需要返回结果。这个结果是c的type或者是我们自己定义的类型。必须把他转换成PyObject， 让python认识。这个用Py_BuildValue 来完成。他是PyArg_ParseTuple的逆过程。他的第一个参数和PyArg_ParseTuple的第二个参数一样， 是个格式化符号。第三个参数 是我们需要转换的参数。Py_BuildValue会把所有的返回只组装成一个tutple给python。*/<br /> }<br /> static PyMethodDef addMethods[] =<br /> {<br /> {"add", add, METH_VARARGS, "Execute a shell command."},<br /> {NULL, NULL, 0, NULL}<br /> }<br /> /*这个是一个c的结构。他来完成一个映射。 我们需要把我们扩展的函数都映射到这个表里。表的第一个字段是python真正认识的。是python 里的方法名字。 第二个字段是python里的这个方法名字的具体实现的函数名。 在python里调用add， 真正执行的是用c写的add函数。第三个字段是METH_VARARGS， 他告诉python，add是调用c函数来实现的。第四个字段是这个函数的说明。如果你在python里来help这个函数，将显示这个说明。相当于在python里的函数的文档说明。*/<br /> PyMODINIT_FUNC initadd()<br /> {<br /> Py_InitModule("vince", addMethods);<br /> }<br /> /*注意，这个函数的名字不能改动。 必须是init+模块名字。 我们的模块名字是add。所以这个函数是initadd()。这样python在导入add 的模块时候，才会找到这个函数，并调用。这个函数调用Py_InitModule来将模块名字和映射表结合在一起。 他表示，add这个模块使用addMethods这个映射表。python应该这样导入我们的module的.*/<br />

然后建立setup.py这个文件，内容如下:

#! /usr/bin/python<br /> from distutils.core import setup, Extension<br /> module1 = Extension('add', sources = ['add.c'])<br /> setup (name = 'PackageName', version = '1.0', description = 'This is a demo package', ext_modules = [module1])<br />

在msdos下进入这个目录，输入命令setup.py build。 如果你能编译成功，到你所在目录的build/lib.win32-2.3下会发现add.pyd文件，将文件复制到你所需要的地方(与python同目录下，放在其他目录的话要配置环境变量)，启动python，然后：

D:/c>;python<br /> Python 2.3.3 (#51, Dec 18 2003, 20:22:39) [MSC v.1200 32 bit (Intel)] on win32<br /> Type "help", "copyright", "credits" or "license" for more information.<br /> >;>;>; import add<br /> >;>;>; print dir(add)<br /> ['__doc__', '__file__', '__name__', 'add']<br /> >;>;>; add.add(1,2)<br /> 3<br /> >;>;>;
2、C源码

static PyObject* add(PyObject *self, PyObject *args)<br /> {<br /> int x=0 ;<br /> int y=0;<br /> int z=0;<br /> if (!PyArg_ParseTuple(args, "i|i", &x, &y))return NULL;<br /> z=x+y;<br /> return Py_BuildValue("i", z);<br /> }</p> <p>static PyMethodDef addMethods[] =<br /> {<br /> {"add", add, METH_VARARGS, "Execute a shell command,Create by Vince."},<br /> {NULL, NULL, 0, NULL}<br /> }</p> <p>PyMODINIT_FUNC initvince()<br /> {<br /> Py_InitModule("vince", addMethods);<br /> }</p> <p>

3、  setup.py

#! /usr/bin/python<br /> from distutils.core import setup, Extension<br /> module1 = Extension('vince', sources = ['Test.c'])<br /> setup (name = 'PackageName', version = '1.0', description = 'This is a demo package', ext_modules = [module1])<br />

欢迎转载此文，转载时请注明文章来源：张元礼的博客 http://blog.csdn.net/vincetest