Python调用windows下DLL详解 - ctypes库的使用

在python中某些时候需要C做效率上的补充，在实际应用中，需要做部分数据的交互。使用python中的ctypes模块可以很方便的调用windows的dll（也包括linux下的so等文件），下面将详细的讲解这个模块（以windows平台为例子），当然我假设你们已经对windows下怎么写一个DLL是没有问题的。
  
引入ctypes库

1. from ctypes import *

假设你已经有了一个的DLL（名字是add.dll)，且该DLL有一个符合cdecl（这里强调调用约定是因为，stdcall调用约定和cdecl调用约定声明的导出函数，在使用python加载时使用的加载函数是不同的，后面会有说明）调用约定的导出函数Add。
建立一个Python文件DllCall.py测试：

1. from ctypes import *
2. dll = CDLL("add.dll")
3. print dll.Add(1, 102)

结果：103 
  
上面是一个简单的例子。下面简单聊一下调用流程： 
1、加载DLL 
上面已经说过，加载的时候要根据你将要调用的函数是符合什么调用约定的。 
stdcall调用约定：两种加载方式

1. Objdll = ctypes.windll.LoadLibrary("dllpath")
2. Objdll = ctypes.WinDLL("dllpath")

cdecl调用约定：也有两种加载方式

1. Objdll = ctypes.cdll.LoadLibrary("dllpath")
2. Objdll = ctypes.CDLL("dllpath")
3. /*其实windll和cdll分别是WinDLL类和CDll类的对象。*/

2、调用dll中的方法 
在1中加载dll的时候会返回一个DLL对象（假设名字叫Objdll），利用该对象就可以调用dll中的方法。 
e.g.如果dll中有个方法名字叫Add（注意如果经过stdcall声明的方法，如果不是用def文件声明的导出函数或者extern “C” 声明的话，编译器会对函数名进行修改，这个要注意，我想你们懂的。）
调用：nRet = Objdll.Add(12, 15) 即完成一次调用。 
  
看起来调用似乎很简单，不要只看表象，呵呵，这是因为Add这个函数太简单了，现在假设函数需要你传入一个int类型的指针（int*），可以通过库中的byref关键字来实现，假设现在调用的函数的第三个参数是个int类型的指针。

1. intPara = c_int(9)
2. dll.sub(23, 102, byref(intPara))
3. print intPara.value

如果是要传入一个char缓冲区指针，和缓冲区长度，方法至少有四种：

1. # 方法1
2. szPara = create_string_buffer('/0'*100)
3. dll.PrintInfo(byref(szPara), 100);
4. print szPara.value
5. # 方法2
6. sBuf = 'aaaaaaaaaabbbbbbbbbbbbbb'
7. pStr = c_char_p( )
8. pStr.value = sBuf
9. #pVoid = ctypes.cast( pStr, ctypes.c_void_p ).value
10. dll.PrintInfo(pStr, len(pStr.value))
11. print pStr.value
12. # 方法3
13. strMa = "/0"*20
14. FunPrint  = dll.PrintInfo
15. FunPrint.argtypes = [c_char_p, c_int]
16. #FunPrint.restypes = c_void_p
17. nRst = FunPrint(strMa, len(strMa))
18. print strMa,len(strMa)
19. # 方法4
20. pStr2 = c_char_p("/0")
21. print pStr2.value
22. #pVoid = ctypes.cast( pStr, ctypes.c_void_p ).value
23. dll.PrintInfo(pStr2, len(pStr.value))
24. print pStr2.value

3、C基本类型和ctypes中实现的类型映射表 
ctypes数据类型          C数据类型 
c_char                          char 
c_short                         short 
c_int                             int 
c_long                          long 
c_ulong                        unsign long 
c_float                          float 
c_double                      double 
c_void_p                       void 
对应的指针类型是在后面加上"_p"，如int*是c_int_p等等。 
在python中要实现c语言中的结构，需要用到类。 
  
4、DLL中的函数返回一个指针。 
虽然这不是个好的编程方法，不过这种情况的处理方法也很简单，其实返回的都是地址，把他们转换相应的python类型，再通过value属性访问。

1. pchar = dll.getbuffer()
2. szbuffer = c_char_p(pchar)
3. print szbuffer.value

5、处理C中的结构体类型 
为什么把这个单独提出来说呢，因为这个是最麻烦也是最复杂的，在python里面申明一个类似c的结构体，要用到类，并且这个类必须继承自Structure。 
先看一个简单的例子： 
C里面dll的定义如下：

1. typedef struct _SimpleStruct
2. {
3. int    nNo;
4. float  fVirus;
5. char   szBuffer[512];
6. } SimpleStruct, *PSimpleStruct;
7. typedef const SimpleStruct*  PCSimpleStruct;
8. extern "C"int  __declspec(dllexport) PrintStruct(PSimpleStruct simp);
9. int PrintStruct(PSimpleStruct simp)
10. {
11. printf ("nMaxNum=%f, szContent=%s", simp->fVirus, simp->szBuffer);
12. return simp->nNo;
13. }

Python的定义：

1. from ctypes import *
2. class SimpStruct(Structure):
3. _fields_ = [ ("nNo", c_int),
4. ("fVirus", c_float),
5. ("szBuffer", c_char * 512)]
6. dll = CDLL("AddDll.dll")
7. simple = SimpStruct();
8. simple.nNo = 16
9. simple.fVirus = 3.1415926
10. simple.szBuffer = "magicTong/0"
11. print dll.PrintStruct(byref(simple))

上面例子结构体很简单，但是如果结构体里面有指针，甚至是指向结构体的指针，处理起来会复杂很多，不过Python里面也有相应的处理方法，下面这个例子来自网上，本来想自己写个，懒得写了，能说明问题就行：
C代码如下：

1. typedef struct
2. {
3. char words[10];
4. }keywords;
5. typedef struct
6. {
7. keywords *kws;
8. unsigned int len;
9. }outStruct;
10. extern "C"int __declspec(dllexport) test(outStruct *o);
11. int test(outStruct *o)
12. {
13. unsigned int i = 4;
14. o->kws = (keywords *)malloc(sizeof(unsigned char) * 10 * i);
15. strcpy(o->kws[0].words, "The First Data");
16. strcpy(o->kws[1].words, "The Second Data");
17. o->len = i;
18. return 1;
19. }

Python代码如下：

1. class keywords(Structure):
2. _fields_ = [('words', c_char *10),]
3. class outStruct(Structure):
4. _fields_ = [('kws', POINTER(keywords)),
5. ('len', c_int),]
6. o = outStruct()
7. dll.test(byref(o))
8. print o.kws[0].words;
9. print o.kws[1].words;
10. print o.len

6、例子 
说得天花乱坠，嘿嘿，还是看两个实际的例子。 
例子1： 
这是一个GUID生成器，其实很多第三方的python库已经有封装好的库可以调用，不过这得装了那个库才行，如果想直接调用一些API，对于python来说，也要借助一个第三方库才行，这个例子比较简单，就是用C++调用win32 API来产生GUID，然后python通过调用C++写的dll来获得这个GUID。
C++代码如下：

1. extern "C"__declspec(dllexport) char* newGUID();
2. char* newGUID()
3. {
4. static char buf[64] = {0};
5. statc GUID guid;
6. if (S_OK == ::CoCreateGuid(&guid))
7. {
8. _snprintf(buf, sizeof(buf),
9. "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
10. guid.Data1,
11. guid.Data2,
12. guid.Data3,
13. guid.Data4[0], guid.Data4[1],
14. guid.Data4[2], guid.Data4[3],
15. guid.Data4[4], guid.Data4[5],
16. guid.Data4[6], guid.Data4[7]
17. );
18. ::MessageBox(NULL, buf, "GUID", MB_OK);
19. }
20. return (char*)buf;
21. }

Python代码如下：

1. def CreateGUID():
2. """
3. 创建一个全局唯一标识符
4. 类似：E06093E2-699A-4BF2-A325-4F1EADB50E18
5. NewVersion
6. """
7. try:
8. # dll path
9. strDllPath = sys.path[0] + str(os.sep) + "createguid.dll"
10. dll = CDLL(strDllPath)
11. b = dll.newGUID()
12. a = c_char_p(b)
13. except Exception, error:
14. print error
15. return ""
16. return a.value