用C語言擴展Python的功能

一、簡介

Python是一門功能強大的高級腳本語言，它的強大不僅表現在其自身的功能上，而且還表現在其良好的可擴展性上，正因如此，Python已經開始受到越來越多人的青睐，並且被屢屢成功地應用於各類大型軟件系統的開發過程中。

與其它普通腳本語言有所不同，Python程序員可以借助Python語言提供的API，使用C或者C++來對Python進行功能性擴展，從而即可以利用Python方便靈活的語法和功能，又可以獲得與C或者C++幾乎相同的執行性能。執行速度慢是幾乎所有腳本語言都具有的共性，也是倍受人們指責的一個重要因素，Python則通過與C語言的有機結合巧妙地解決了這一問題，從而使腳本語言的應用范圍得到了很大擴展。

在用Python開發實際軟件系統時，很多時候都需要使用C/C++來對Python進行擴展。最常見的情況是目前已經存在一個用C編寫的庫，需要在Python語言中使用該庫的某些功能，此時就可以借助Python提供的擴展功能來實現。此外，由於Python從本質上講還是一種腳本語言，某些功能用Python實現可能很難滿足實際軟件系統對執行效率的要求，此時也可以借助Python提供的擴展功能，將這些關鍵代碼段用C或者C++實現，從而提供程序的執行性能。

本文主要介紹Python提供的C語言擴展接口，以及如何使用這些接口和C/C++語言來對Python進行功能性擴展，並輔以具體的實例講述如何實現Python的功能擴展。

Python是用C語言實現的一種腳本語言，本身具有優良的開放性和可擴展性，並提供了方便靈活的應用程序接口(API)，從而使得C/C++程序員能夠在各個級別上對Python解釋器的功能進行擴展。在使用C/C++對Python進行功能擴展之前，必須首先掌握Python解釋所提供的C語言接口。

2.1 Python對象(PyObject)

Python是一門面向對象的腳本語言，所有的對象在Python解釋器中都被表示成PyObject，PyObject結構包含Python對象的所有成員指針，並且對Python對象的類型信息和引用計數進行維護。在進行Python的擴展編程時，一旦要在C或者C++中對Python對象進行處理，就意味著要維護一個PyObject結構。

在Python的C語言擴展接口中，大部分函數都有一個或者多個參數為PyObject指針類型，並且返回值也大都為PyObject指針。

2.2 引用計數

為了簡化內存管理，Python通過引用計數機制實現了自動的垃圾回收功能，Python中的每個對象都有一個引用計數，用來計數該對象在不同場所分別被引用了多少次。每當引用一次Python對象，相應的引用計數就增1，每當消毀一次Python對象，則相應的引用就減1，只有當引用計數為零時，才真正從內存中刪除Python對象。

下面的例子說明了Python解釋器如何利用引用計數來對Pyhon對象進行管理：

1. 例1:refcount.py  
2. class refcount:  
3.     # etc.   
4. r1 = refcount() # 引用計數為1   
5. r2 = r1         # 引用計數為2   
6. del(r1)         # 引用計數為1   
7. del(r2)         # 引用計數為0，刪除對象   
8.   
9.    

在C/C++中處理Python對象時，對引用計數進行正確的維護是一個關鍵問題，處理不好將很容易產生內存洩漏。Python的C語言接口提供了一些宏來對引用計數進行維護，最常見的是用Py_INCREF()來增加使Python對象的引用計數增1，用Py_DECREF()來使Python對象的引用計數減1。

2.3 數據類型

Python定義了六種數據類型：整型、浮點型、字符串、元組、列表和字典，在使用C語言對Python進行功能擴展時，首先要了解如何在C和Python的數據類型間進行轉化。

2.3.1 整型、浮點型和字符串

在Python的C語言擴展中要用到整型、浮點型和字符串這三種數據類型時相對比較簡單，只需要知道如何生成和維護它們就可以了。下面的例子給出了如何在C語言中使用Python的這三種數據類型：

1. 例2：typeifs.c  
2. // build an integer   
3. PyObject* pInt = Py_BuildValue("i", 2003);  
4. assert(PyInt_Check(pInt));  
5. int i = PyInt_AsLong(pInt);  
6. Py_DECREF(pInt);  
7. // build a float   
8. PyObject* pFloat = Py_BuildValue("f", 3.14f);  
9. assert(PyFloat_Check(pFloat));  
10. float f = PyFloat_AsDouble(pFloat);  
11. Py_DECREF(pFloat);  
12. // build a string   
13. PyObject* pString = Py_BuildValue("s", "Python");  
14. assert(PyString_Check(pString);  
15. int nLen = PyString_Size(pString);  
16. char* s = PyString_AsString(pString);  
17. Py_DECREF(pString);  
18.   
19.    

2.3.2 元組

Python語言中的元組是一個長度固定的數組，當Python解釋器調用C語言擴展中的方法時，所有非關鍵字(non-keyword)參數都以元組方式進行傳遞。下面的例子示范了如何在C語言中使用Python的元組類型：

1. 例3：typetuple.c  
2. // create the tuple   
3. PyObject* pTuple = PyTuple_New(3);  
4. assert(PyTuple_Check(pTuple));  
5. assert(PyTuple_Size(pTuple) == 3);  
6. // set the item   
7. PyTuple_SetItem(pTuple, 0, Py_BuildValue("i", 2003));  
8. PyTuple_SetItem(pTuple, 1, Py_BuildValue("f", 3.14f));  
9. PyTuple_SetItem(pTuple, 2, Py_BuildValue("s", "Python"));  
10. // parse tuple items   
11. int i;  
12. float f;  
13. char *s;  
14. if (!PyArg_ParseTuple(pTuple, "ifs", &i, &f, &s))  
15.     PyErr_SetString(PyExc_TypeError, "invalid parameter");  
16. // cleanup   
17. Py_DECREF(pTuple);  
18.   
19.    

2.3.3 列表

Python語言中的列表是一個長度可變的數組，列表比元組更為靈活，使用列表可以對其存儲的Python對象進行隨機訪問。下面的例子示范了如何在C語言中使用Python的列表類型：

1. 例4：typelist.c  
2. // create the list   
3. PyObject* pList = PyList_New(3); // new reference   
4. assert(PyList_Check(pList));  
5. // set some initial values   
6. for(int i = 0; i < 3; ++i)  
7.     PyList_SetItem(pList, i, Py_BuildValue("i", i));  
8. // insert an item   
9. PyList_Insert(pList, 2, Py_BuildValue("s", "inserted"));  
10. // append an item   
11. PyList_Append(pList, Py_BuildValue("s", "appended"));  
12. // sort the list   
13. PyList_Sort(pList);  
14. // reverse the list   
15. PyList_Reverse(pList);  
16. // fetch and manipulate a list slice   
17. PyObject* pSlice = PyList_GetSlice(pList, 2, 4); // new reference   
18. for(int j = 0; j < PyList_Size(pSlice); ++j) {  
19.   PyObject *pValue = PyList_GetItem(pList, j);  
20.   assert(pValue);  
21. }  
22. Py_DECREF(pSlice);  
23. // cleanup   
24. Py_DECREF(pList);  
25.   
26.    

2.3.4 字典

Python語言中的字典是一個根據關鍵字進行訪問的數據類型。下面的例子示范了如何在C語言中使用Python的字典類型：

1. 例5：typedic.c  
2. // create the dictionary   
3. PyObject* pDict = PyDict_New(); // new reference   
4. assert(PyDict_Check(pDict));  
5. // add a few named values   
6. PyDict_SetItemString(pDict, "first",   
7.                      Py_BuildValue("i", 2003));  
8. PyDict_SetItemString(pDict, "second",   
9.                      Py_BuildValue("f", 3.14f));  
10. // enumerate all named values   
11. PyObject* pKeys = PyDict_Keys(); // new reference   
12. for(int i = 0; i < PyList_Size(pKeys); ++i) {  
13.   PyObject *pKey = PyList_GetItem(pKeys, i);  
14.   PyObject *pValue = PyDict_GetItem(pDict, pKey);  
15.   assert(pValue);  
16. }  
17. Py_DECREF(pKeys);  
18. // remove a named value   
19. PyDict_DelItemString(pDict, "second");  
20. // cleanup   
21. Py_DECREF(pDict);  
22.   
23.