本文介绍如何用 C 语言来扩展 python。所举的例子是,为 python 添加一个设置字符串到 windows 的剪切板(Clipboard)的功能。我在写以下代码的时候用到的环境是:windows xp, gcc.exe 4.7.2, Python 3.2.3。
第一步 撰写C语言的DLL
创建一个 clip.c 文件,内容如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
// 设置 UNICODE 库,这样的话才可以正确复制宽字符集 #define UNICODE #include <windows.h> #include <python.h> // 设置文本到剪切板(Clipboard) static PyObject *setclip(PyObject *self, PyObject *args) { LPTSTR lptstrCopy; HGLOBAL hglbCopy; Py_UNICODE *content; int len = 0; // 将 python 的 UNICODE 字符串及长度传入 if (!PyArg_ParseTuple(args, "u#" , &content, &len)) return NULL; Py_INCREF(Py_None); if (!OpenClipboard(NULL)) return Py_None; EmptyClipboard(); hglbCopy = GlobalAlloc(GMEM_MOVEABLE, (len+1) * sizeof (Py_UNICODE)); if (hglbCopy == NULL) { CloseClipboard(); return Py_None; } lptstrCopy = GlobalLock(hglbCopy); memcpy (lptstrCopy, content, len * sizeof (Py_UNICODE)); lptstrCopy[len] = (Py_UNICODE) 0; GlobalUnlock(hglbCopy); SetClipboardData(CF_UNICODETEXT, hglbCopy); CloseClipboard(); return Py_None; } // 定义导出给 python 的方法 static PyMethodDef ClipMethods[] = { { "setclip" , setclip, METH_VARARGS, "Set string to clip." }, {NULL, NULL, 0, NULL} }; // 定义 python 的 model static struct PyModuleDef clipmodule = { PyModuleDef_HEAD_INIT, "clip" , NULL, -1, ClipMethods }; // 初始化 python model PyMODINIT_FUNC PyInit_clip( void ) { return PyModule_Create(&clipmodule); } |
第二步 写 python 的 setup.py
创建一个 setup.py 文件,内容如下:
1
2
3
4
5
6
7
8
9
|
from distutils.core import setup, Extension module1 = Extension( ‘clip‘ , sources = [ ‘clip.c‘ ]) setup (name = ‘clip‘ , version = ‘1.0‘ , description = ‘This is a clip package‘ , ext_modules = [module1]) |
第三步 用 python 编译
运行以下命令:
python setup.py build --compiler=mingw32 install
在我的环境中会提示以下错误:
gcc: error: unrecognized command line option ‘-mno-cygwin‘
error: command ‘gcc‘ failed with exit status 1
打开 %PYTHON安装目录%/Lib/distutils/cygwinccompiler.py 文件,将里面的 -mno-cygwin 删除掉,然后再运行即可。
正常运行后,会生成一个 clip.pyd 文件,并将该文件复制到 %PYTHON安装目录%/Lib/site-packages 目录中
第四步 测试该扩展
写一个 test.py, 内容如下:
1
2
3
|
# -*- encoding: gbk -*- import clip clip.setclip( "Hello python" ) |
运行
python test.py
再到任何一个地方粘贴,即可验证是否正确。
***************************************************************************************************
一个Python扩展模块是一个普通的C语言库,对于UNIX计算机,这些库通常以.so(表示共享对象)结尾。Python模块会把代码分成3个部分:
(1)希望作为模块接口呈现的C函数;
(2)将Python开发人员所看到的那些函数的名称映射为扩展模块中的C函数的一个表;
(3)初始化函数;
大多数扩展模块可以包含在一个单独的C源文件中,这个文件被称为胶水文件,启动包含Python.h的文件,它允许访问内部的Python
API,这些API将模块与解释器相关联。下面分别来讲解上述的三个部分。
****************************************************************************************************
C函数签名:
函数的C语言实现的签名总是采用如下三个形式之一
(1)PyObject
*MyFunction(PyObject *self , PyObject *args);
(2)PyObject
*MyFunction(PyObject *self , PyObject *args , PyObject *kw);
(3)PyObject
*MyFunction(PyObject
*self);
通常,C函数会采用第一种形式,传递到这些函数中的参数被包装成一个元组,为了使用这些参数,必须分解它们,可以使用PyArg_ParseTuple函数和PyArg_ParseTupleAndKeywords函数
PyArg_ParseTuple(args
, "ids" , &i , &d , &s)
将args分成int , double , char*,分别存入i , d ,
s
****************************************************************************************************
方法表:
方法表是PyMethodDef结构的一个简单数组
struct
PyMethodDef
{
char
*ml_name; #Python中使用的名字
PyCFunction
ml_meth; #C函数的名字
int
ml_flags; #表示使用哪种C函数的签名形式
char
ml_doc;
#函数的字符串文档
};
ml_flags向解释器表明ml_meth正使用三个签名中的哪一个。ml_flags的值通常是METH_VARARGS。如果希望将关键字参数引入到函数中,那么这个值可以与METH_KEYWORDS按位或。它的值也可以是METH_NOARGS,表示不希望接受任何形式的参数。
下面是是一个例子,包含函数MyFunction的表:
static PyMethodDef myFunction[] = {
{"pythonName" ,
(PyCFuntion)MyFunction , METH_NOARGS , "my first function"} ,
{ NULL ,
NULL , 0 ,
NULL}
};
****************************************************************************************************
初始化函数:
扩展模块的最后一部分是初始化函数。当模块被加载时,Python解释器调用此函数。需要将函数命名为init模块名,例如initChenhuan,模块名为Chenhuan
****************************************************************************************************
下面是一个典型的C扩展模块:
个人比较喜欢用g++来编译,error和warming区分的很清楚,格式如下:
g++ -Wall -shared -I /usr/local/python2.6 foo.c -o
foo.so
成功的话,会在文件夹下生成foo.so,就可以使用这个模块了:
原文:http://www.cnblogs.com/yinguo/p/4641349.html