Python調用windows下DLL詳解 - ctypes庫的使用

做者：童磊（magictong）

P.S. 以前的排版亂掉了，這裏作一下排版，順便改一下里面的一些用詞錯誤。 

2011-08-04 
  
在python中某些時候須要C作效率上的補充，在實際應用中，須要作部分數據的交互。使用python中的ctypes模塊能夠很方便的調用windows的dll（也包括linux下的so等文件），下面將詳細的講解這個模塊（以windows平臺爲例子），固然我假設大家已經對windows下怎麼寫一個DLL是沒有問題的。
  
引入ctypes庫 

[python]  view plain copy

1. from ctypes import *   

假設你已經有了一個的DLL（名字是add.dll)，且該DLL有一個符合cdecl（這裏強調調用約定是由於，stdcall調用約定和cdecl調用約定聲明的導出函數，在使用python加載時使用的加載函數是不一樣的，後面會有說明）調用約定的導出函數Add。
創建一個Python文件DllCall.py測試： 

[python]  view plain copy

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

結果：103 
  
上面是一個簡單的例子。下面簡單聊一下調用流程： 
一、加載DLL 
上面已經說過，加載的時候要根據你將要調用的函數是符合什麼調用約定的。 
stdcall調用約定：兩種加載方式 

[python]  view plain copy

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

cdecl調用約定：也有兩種加載方式 

[python]  view plain copy

1. Objdll = ctypes.cdll.LoadLibrary("dllpath")  
2. Objdll = ctypes.CDLL("dllpath")  
3. <span style="font-family:Microsoft YaHei;">其實windll和cdll分別是WinDLL類和CDll類的對象。</span>  

  
二、調用dll中的方法 
在1中加載dll的時候會返回一個DLL對象（假設名字叫Objdll），利用該對象就能夠調用dll中的方法。 
e.g.若是dll中有個方法名字叫Add（注意若是通過stdcall聲明的方法，若是不是用def文件聲明的導出函數或者extern 「C」 聲明的話，編譯器會對函數名進行修改，這個要注意，我想大家懂的。）
調用：nRet = Objdll.Add(12, 15) 即完成一次調用。 
  
看起來調用彷佛很簡單，不要只看表象，呵呵，這是由於Add這個函數太簡單了，如今假設函數須要你傳入一個int類型的指針（int*），能夠經過庫中的byref關鍵字來實現，假設如今調用的函數的第三個參數是個int類型的指針。

[python]  view plain copy

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

若是是要傳入一個char緩衝區指針，和緩衝區長度，方法至少有四種： 

[python]  view plain copy

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

  
三、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語言中的結構，須要用到類。 
  
四、DLL中的函數返回一個指針。 
雖然這不是個好的編程方法，不過這種狀況的處理方法也很簡單，其實返回的都是地址，把他們轉換相應的python類型，再經過value屬性訪問。 

[python]  view plain copy

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

  
五、處理C中的結構體類型 
爲何把這個單獨提出來講呢，由於這個是最麻煩也是最複雜的，在python裏面申明一個相似c的結構體，要用到類，而且這個類必須繼承自Structure。 
先看一個簡單的例子： 
C裏面dll的定義以下： 

[cpp]  view plain copy

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

  
Python的定義： 

[python]  view plain copy

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

上面例子結構體很簡單，可是若是結構體裏面有指針，甚至是指向結構體的指針，處理起來會複雜不少，不過Python裏面也有相應的處理方法，下面這個例子來自網上，原本想本身寫個，懶得寫了，能說明問題就行：
C代碼以下： 

[cpp]  view plain copy

1. typedef struct   
2.   
3. {  
4.   
5. char words[10];  
6.   
7. }keywords;  
8.   
9.    
10.   
11. typedef struct   
12.   
13. {  
14.   
15. keywords *kws;  
16.   
17. unsigned int len;  
18.   
19. }outStruct;  
20.   
21. extern "C"int __declspec(dllexport) test(outStruct *o);  
22.   
23. int test(outStruct *o)  
24.   
25. {  
26.   
27. unsigned int i = 4;  
28.   
29. o->kws = (keywords *)malloc(sizeof(unsigned char) * 10 * i);  
30.   
31. strcpy(o->kws[0].words, "The First Data");  
32.   
33. strcpy(o->kws[1].words, "The Second Data");  
34.   
35.    
36.   
37. o->len = i;  
38.   
39. return 1;  
40.   
41. }  

Python代碼以下： 

[python]  view plain copy

1. class keywords(Structure):  
2.   
3.         _fields_ = [('words', c_char *10),]  
4.   
5.    
6.   
7. class outStruct(Structure):  
8.   
9.         _fields_ = [('kws', POINTER(keywords)),  
10.   
11.                     ('len', c_int),]  
12.   
13. o = outStruct()  
14.   
15. dll.test(byref(o))  
16.   
17.    
18.   
19. print o.kws[0].words;  
20.   
21. print o.kws[1].words;  
22.   
23. print o.len  

  
六、例子 
說得天花亂墜，嘿嘿，仍是看兩個實際的例子。 
例子1： 
這是一個GUID生成器，其實不少第三方的python庫已經有封裝好的庫能夠調用，不過這得裝了那個庫才行，若是想直接調用一些API，對於python來講，也要藉助一個第三方庫才行，這個例子比較簡單，就是用C++調用win32 API來產生GUID，而後python經過調用C++寫的dll來得到這個GUID。
C++代碼以下： 

[cpp]  view plain copy

1. extern "C"__declspec(dllexport) char* newGUID();   
2.   
3. char* newGUID()   
4.   
5. {  
6.   
7.      static char buf[64] = {0};  
8.   
9.      statc GUID guid;  
10.   
11.      if (S_OK == ::CoCreateGuid(&guid))   
12.   
13.      {  
14.   
15.        _snprintf(buf, sizeof(buf),  
16.   
17. "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",   
18.   
19. guid.Data1,  
20.   
21. guid.Data2,  
22.   
23. guid.Data3,  
24.   
25. guid.Data4[0], guid.Data4[1],  
26.   
27. guid.Data4[2], guid.Data4[3],  
28.   
29. guid.Data4[4], guid.Data4[5],  
30.   
31. guid.Data4[6], guid.Data4[7]  
32.   
33. );   
34.   
35.        ::MessageBox(NULL, buf, "GUID", MB_OK);   
36.   
37.       }  
38.   
39.      return (char*)buf;  
40.   
41. }  

Python代碼以下： 

[python]  view plain copy

1. def CreateGUID():  
2.   
3.     """ 
4.  
5.     建立一個全局惟一標識符 
6.  
7.     相似：E06093E2-699A-4BF2-A325-4F1EADB50E18 
8.  
9.     NewVersion 
10.  
11.     """  
12.   
13.     try:  
14.   
15.         # dll path  
16.   
17.         strDllPath = sys.path[0] + str(os.sep) + "createguid.dll"  
18.   
19.         dll = CDLL(strDllPath)  
20.   
21.         b = dll.newGUID()  
22.   
23.         a = c_char_p(b)  
24.   
25.     except Exception, error:  
26.   
27.         print error  
28.   
29.         return ""  
30.   
31.     return a.value  

  
例子2： 
這個例子是調用kernel32.dll中的createprocessA函數來啓動一個記事本進程 

[python]  view plain copy

1. #  -*- coding:utf-8 -*-   
2.   
3. from ctypes import *   
4.   
5.    
6.   
7. # 定義_PROCESS_INFORMATION結構體  
8.   
9. class _PROCESS_INFORMATION(Structure):  
10.   
11.     _fields_ = [('hProcess', c_void_p),  
12.   
13.                 ('hThread', c_void_p),  
14.   
15.                 ('dwProcessId', c_ulong),  
16.   
17.                 ('dwThreadId', c_ulong)]  
18.   
19.    
20.   
21. # 定義_STARTUPINFO結構體  
22.   
23. class _STARTUPINFO(Structure):  
24.   
25.     _fields_ = [('cb',c_ulong),  
26.   
27.                 ('lpReserved', c_char_p),  
28.   
29.                 ('lpDesktop', c_char_p),  
30.   
31.                 ('lpTitle', c_char_p),  
32.   
33.                 ('dwX', c_ulong),  
34.   
35.                 ('dwY', c_ulong),  
36.   
37.                 ('dwXSize', c_ulong),  
38.   
39.                 ('dwYSize', c_ulong),  
40.   
41.                 ('dwXCountChars', c_ulong),  
42.   
43.                 ('dwYCountChars', c_ulong),  
44.   
45.                 ('dwFillAttribute', c_ulong),  
46.   
47.                 ('dwFlags', c_ulong),  
48.   
49.                 ('wShowWindow', c_ushort),  
50.   
51.                 ('cbReserved2', c_ushort),  
52.   
53.                 ('lpReserved2', c_char_p),  
54.   
55.                 ('hStdInput', c_ulong),  
56.   
57.                 ('hStdOutput', c_ulong),  
58.   
59.                 ('hStdError', c_ulong)]  
60.   
61.    
62.   
63. NORMAL_PRIORITY_CLASS = 0x00000020 #定義NORMAL_PRIORITY_CLASS  
64.   
65. kernel32 = windll.LoadLibrary("kernel32.dll")  #加載kernel32.dll  
66.   
67. CreateProcess = kernel32.CreateProcessA   #得到CreateProcess函數地址  
68.   
69. ReadProcessMemory = kernel32.ReadProcessMemory #得到ReadProcessMemory函數地址  
70.   
71. WriteProcessMemory = kernel32.WriteProcessMemory #得到WriteProcessMemory函數地址  
72.   
73. TerminateProcess = kernel32.TerminateProcess  
74.   
75.    
76.   
77. # 聲明結構體  
78.   
79. ProcessInfo = _PROCESS_INFORMATION()  
80.   
81. StartupInfo = _STARTUPINFO()  
82.   
83. fileName = 'c:/windows/notepad.exe'       # 要進行修改的文件  
84.   
85. address = 0x0040103c        # 要修改的內存地址  
86.   
87. strbuf = c_char_p("_")        # 緩衝區地址  
88.   
89. bytesRead = c_ulong(0)       # 讀入的字節數  
90.   
91. bufferSize =  len(strbuf.value)     # 緩衝區大小  
92.   
93.    
94.   
95. # 建立進程   
96.   
97. CreateProcess(fileName, 0, 0, 0, 0, NORMAL_PRIORITY_CLASS,0, 0, byref(StartupInfo), byref(ProcessInfo))