談 Python 程序和 C 程序的整合 （轉載）

http://www.ibm.com/developerworks/cn/linux/l-cn-pythonandc/

 

 

概覽

Python 是一種用於快速開發軟件的編程語言，它的語法比較簡單，易於掌握，但存在執行速度慢的問題，而且在處理某些問題時存在不足，如對計算機硬件系統的訪問，對媒體文件的訪問等。而做爲軟件開發的傳統編程語言—— C 語言，卻能在這些問題上很好地彌補 Python 語言的不足。所以，本文經過實例研究如何在 Python 程序中整合既有的 C 語言模塊，包括用 C 語言編寫的源程序和動態連接庫等，從而充分發揮 Python 語言和 C 語言各自的優點。

回頁首

背景知識介紹

Python 語言的特色

Python 做爲一門程序開發語言，被愈來愈多地運用到快速程序開發。Python 是一種解釋型的，互動的，面向對象的編程語言，它包含了模塊化的操做，異常處理，動態資料形態，以及類型的使用。它的語法表達優美易讀，具備不少優秀的腳本語言的特色：解釋的，面向對象的，內建的高級數據結構，支持模塊和包，支持多種平臺，可擴展。並且它還支持交互式方式運行，圖形方式運行。它擁有衆多的編程界面支持各類操做系統平臺以及衆多的各種函數庫，利用 C 和 C++ 能夠對它進行擴充。

C 語言的特色

C 語言做爲最受人們歡迎的語言之一，有普遍的發展基礎。簡潔緊湊、靈活方便，功能強大是其特色。另外，C 語言是一門中級語言。它把高級語言的基本結構和語句與低級語言的實用性結合起來。因爲能夠直接訪問物理地址，能夠方便的對硬件進行操做。所以，不少的系統軟件都是由 C 語言編寫。

Python 語言與 C 語言的交互

爲了節省軟件開發成本，軟件開發人員但願可以縮短的軟件的開發時間，但願可以在短期內開發出穩定的產品。Python 功能強大，簡單易用，可以快速開發應用軟件。可是因爲 Python 自身執行速度的侷限性，對性能要求比較高的模塊須要使用效率更高的程序語言進行開發，例如 C 語言，系統的其餘模塊運用 Python 進行快速開發，最後將 C 語言開發的模塊與 Python 開發的模塊進行整合。在此背景下，基於 Python 語言與 C 語言的各自特色，用 C 語言來擴展示有的 Python 程序，顯得頗有意義。本文首先介紹幾種經常使用的整合 Python 程序與 C 語言程序的方法，最後給出相應的實例。

回頁首

利用 ctypes 模塊整合 Python 程序和 C 程序

ctypes 模塊

ctypes 是 Python 的一個標準模塊，它包含在 Python2.3 及以上的版本里。ctypes 是一個 Python 的高級外部函數接口，它使得 Python 程序能夠調用 C 語言編譯的靜態連接庫和動態連接庫。運用 ctypes 模塊，可以在 Python 源程序中建立，訪問和操做簡單的或複雜的 C 語言數據類型。最爲重要的是 ctypes 模塊可以在多個平臺上工做，包括 Windows，Windows CE，Mac OS X，Linux，Solaris，FreeBSD，OpenBSD。

接下來經過幾個簡單的例子來看一下 ctypes 模塊如何整合 Python 程序和 C 程序。

源代碼層面上的整合

利用 Python 自己提供的 ctypes 模塊可使 Python 語言和 C 語言在源代碼層面上進行整合。本節介紹瞭如何經過使用 ctypes 庫，在 Python 程序中能夠定義相似 C 語言的變量。

下表列出了 ctypes 變量類型，C 語言變量類型和 Python 語言變量類型之間的關係：

表 1. ctypes，c 語言和 Python 語言變量類型關係

ctypes type	c type	Python type
c_char	char	1-character string
c_wchar	wchar_t	1-character unicode string
c_byte	char	int/long
c_ubyte	unsigned char	int/long
c_short	short	int/long
c_ushort	unsigned short	int/long
c_int	int	int/long
c_uint	unsigned int	int/long
c_long	long	int/long
c_ulong	unsigned long	int/long
c_longlong	__int64 or long long	int/long
c_ulonglong	unsigned __int64 or unsigned long long	int/long
c_float	float	float
c_double	double	float
c_char_p	char * (NUL terminated)	string or None
c_wchar_p	wchar_t * (NUL terminated)	unicode or None
c_void_p	void *	int/long or None

表 1 中的第一列是在 ctypes 庫中定義的變量類型，第二列是 C 語言定義的變量類型，第三列是 Python 語言在不使用 ctypes 時定義的變量類型。

舉例：

清單 1. ctypes 簡單使用

 >>> from ctypes import *               # 導入 ctypes 庫中全部模塊
 >>> i = c_int(45)                        # 定義一個 int 型變量，值爲 45 
 >>> i.value                               # 打印變量的值
 45 
 >>> i.value = 56                         # 改變該變量的值爲 56 
 >>> i.value                               # 打印變量的新值
 56

從下面的例子能夠更明顯地看出 ctypes 裏的變量類型和 C 語言變量類型的類似性：

清單 2. ctypes 使用 C 語言變量

 >>> p = create_string_buffer(10)      # 定義一個可變字符串變量，長度爲 10 
 >>> p.raw                                  # 初始值是全 0，即 C 語言中的字符串結束符’ \0 ’
'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
 >>> p.value = "Student"                 # 字符串賦值
 >>> p.raw                                  # 後三個字符還是’ \0 ’
'Student\x00\x00\x00'
 >>> p.value = "Big"                      # 再次賦值
 >>> p.raw                                   # 只有前三個字符被修改，第四個字符被修改成’ \0 ’
'Big\x00ent\x00\x00\x00'

下面例子說明了指針操做：

清單 3. ctypes 使用 C 語言指針

 >>> i = c_int(999)                                 # 定義 int 類型變量 i，值爲 999 
 >>> pi = pointer(i)                                # 定義指針，指向變量 i 
 >>> pi.contents                                     # 打印指針所指的內容
 c_long(999) 
 >>> pi.contents = c_long(1000)                   # 經過指針改變變量 i 的值
 >>> pi.contents                                     # 打印指針所指的內容
 c_long(1000)

下面例子說明告終構和數組的操做：

清單 4. ctypes 使用 C 語言數組和結構體

 >>> class POINT(Structure):                 # 定義一個結構，內含兩個成員變量 x，y，均爲 int 型
 ...     _fields_ = [("x", c_int), 
 ...                 ("y", c_int)] 
 ... 
 >>> point = POINT(2,5) 	                   # 定義一個 POINT 類型的變量，初始值爲 x=2, y=5 
 >>> print point.x, point.y                     # 打印變量
 2 5 
 >>> point = POINT(y=5) 	                         # 從新定義一個 POINT 類型變量，x 取默認值
 >>> print point.x, point.y                     # 打印變量
 0 5 
 >>> POINT_ARRAY = POINT * 3                    # 定義 POINT_ARRAY 爲 POINT 的數組類型
 # 定義一個 POINT 數組，內含三個 POINT 變量
 >>> pa = POINT_ARRAY(POINT(7, 7), POINT(8, 8), POINT(9, 9)) 	
 >>> for p in pa: print p.x, p.y                # 打印 POINT 數組中每一個成員的值
 ... 
 7 7 
 8 8 
 9 9

Python 訪問 C 語言 dll

經過 ctypes 模塊，Python 程序能夠訪問 C 語言編譯的 dll，本節經過一個簡單的例子，Python 程序 helloworld.py 中調用 some.dll 中的 helloworld 函數，來介紹 Python 程序如何調用 windows 平臺上的 dll。

1. 導入動態連接庫

   清單 5. ctypes 導入 dll

    from ctypes import windll # 首先導入 ctypes 模塊的 windll 子模塊
    somelibc = windll.LoadLibrary(some.dll) # 使用 windll 模塊的 LoadLibrary 導入動態連接庫

2. 訪問動態連接庫中的函數

   清單 6. ctypes 使用 dll 中的函數

    somelibc. helloworld() # 這樣就能夠獲得 some.dll 的 helloworld 的返回值。

   整個 helloworld.py 是這樣的：

   清單 7. Python hellpworld 代碼

    from ctypes import windll 
   
    def callc(): 
    # load the some.dll 
    somelibc = windll.LoadLibrary(some.dll) 
    print somelibc. helloworld() 
    if __name__== 「__main__」: 
    callc()

   在命令行運行 helloworld.py，在 console 上能夠看到 some.dll 中 helloworld 的輸出。

   清單 8. Python hellpworld Windows command console 運行輸出

    C:\>python C:\python\test\helloworld.py 
    Hello World! Just a simple test.

Python 調用 C 語言 so

經過 ctypes 模塊，Python 程序也能夠訪問 C 語言編譯的 so 文件。與 Python 調用 C 的 dll 的方法基本相同，本節經過一個簡單的例子，Python 程序 helloworld.py 中調用 some.so 中的 helloworld 函數，來介紹 Python 程序如何調用 linux 平臺上的 so。

1. 導入動態連接庫

   清單 9. ctypes 導入 so

    from ctypes import cdll      
    # 首先導入 ctypes 模塊的 cdll 子模塊，注意 linux 平臺上使用 cdll 的，而不是 windll。
    somelibc = cdll.LoadLibrary(「./some.so」)
     # 使用 cdll 模塊的 LoadLibrary 導入動態連接庫

2. 訪問動態連接庫中的函數

   清單 10. ctypes 使用 so 中的函數

    somelibc. helloworld() # 使用方法與 windows 平臺上是同樣的。

   整個 helloworld.py 是這樣的：

   清單 11. Python helloworld 代碼

    from ctypes import cdll 
   
    def callc(): 
    # load the some.so 
    somelibc = cdll.LoadLibrary(some.so) 
    print somelibc. helloworld() 
    if __name__== 「__main__」: 
    callc()

   在命令行運行 helloworld.py，在 linux 標準輸出上能夠看到 some.so 中 helloworld 的輸出。

   清單 12. Python hellpworld Linux shell 運行輸出

    [root@linux-790t] python ./helloworld.py 
    Hello World! Just a simple test.

回頁首

Python 程序和 C 程序整合實例

如下咱們舉例用 Python 來實現一個小工具，用來實現 hash 算法，查看文件的校驗和（MD5,CRC,SHA1 等等）。經過查看文件的校驗和，能夠知道文件在傳輸過程當中是否被破壞或篡改。

Hash，通常翻譯作「散列」，也有直接音譯爲"哈希"的，就是把任意長度的輸入（又叫作預映射，pre-image），經過散列算法，變換成固定長度的輸出，該輸出就是散列值。這種轉換是一種壓縮映射，也就是，散列值的空間一般遠小於輸入的空間，不一樣的輸入可能會散列成相同的輸出，而不可能從散列值來惟一的肯定輸入值。簡單的說就是一種將任意長度的消息壓縮到某一固定長度的消息摘要的函數。

因爲相對 C 語言來講，Python 的運行效率較低，所以咱們的 Python 小工具利用一個已有的 C 語言的動態連接庫 (hashtcalc.dll) 來實現咱們的程序。本例中，咱們運用 wxPython 編寫簡單的 GUI 界面，經過 python 調用 hashtcalc.dll 的接口計算文件的校驗和，而後輸出在界面上。

架構圖

圖 1. 工具的架構圖

hashcalc.dll 接口描述

函數名：calc_CRC32

函數：char* calc_CRC32(char *filename);

參數：文件名

返回值：字符串

說明：該函數對輸入的文件內容進行計算，而且返回它的 CRC32

函數名：calc_MD5

函數：char* calc_MD5(char *filename);

參數：文件名

返回值：字符串

說明：該函數對輸入的文件內容進行計算，而且返回它的 MD5

函數名：calc_SHA1

函數：char* calc_SHA1 (char *filename);

參數：文件名

返回值：字符串

說明：該函數對輸入的文件內容進行計算，而且返回它的 SHA1

HashcalcAdapter 代碼

HashcalcAdapter.py 實現了一個 python 的 class HashcalcAdapter，HashcalcAdapter 對 hashtcalc.dl 的 C 語言接口進行了封裝，使得其餘 python 模塊能夠直接經過 HashcalcAdapter 使用 hashtcalc.dll 中實現的 hash 算法。具體的代碼以下：

清單 13. HashcalcAdapter.py 代碼

 from ctypes import windll 
 from ctypes import * 

 class HashcalcAdapter(object): 
    def __init__(self, dllpath): 
        self._dllpath = dllpath 
        self._libc = windll.LoadLibrary(self._dllpath) 

    def calc_CRC32(self, filename): 
		 new_filename = c_char_p(filename) 
		 return self._libc.calc_CRC32(new_filename) 

    def calc_MD5(self, filename): 
		 new_filename = c_char_p(filename) 
		 return self._libc.calc_MD5(new_filename) 

    def calc_SHA1(self, filename): 
		 new_filename = c_char_p(filename) 
		 return self._libc.calc_SHA1(new_filename)

運行界面

圖 2. 工具的運行界面

回頁首

總結

在軟件開發過程當中同時運用 Python 語言和 C 語言，既可以在加快開發速度的同時，也可以保證軟件的運行性能。