導出模塊
當python執行import dllmodule時,執行了以下步驟:
- 查找名字為dllmodule的動態模塊
2.定位C/C++導出模塊初始化函數,名字為init+dllmodule
3.執行這個初始化函數。
4.這個是初始化函數調用函數Py_InitModule
,這個函數會更新sys.modules,從而將這個模塊快加入到python中。
Py_InitModule
函數有兩個參數,第一個為模塊名,第二個為PyMethodDef
列表(或者NULL),保存模塊中的函數信息。
導出函數
使用PyMethodDef
定義需要導出的函數,定義格式如下:
static PyMethodDef addfuncMethods[] = {
{"func_name", func, func_feature_flags, "function docstring"},
{NULL} // 結束標志
};
其中,函數指針func必須使用固定格式:
static PyObject* func(PyObject *self, PyObject *args)
or
static PyObject* func(PyObject *self, PyObject *args, PyObject *kwds)
func_feature_flags說明函數類型,有如下幾種:
METH_VARARGS: 只使用占位參數,比如f(a,b),f(a, b)
METH_KEYWORDS:包含了關鍵字參數,比如f(c), f(a,*c)
METH_NOARGS:沒有參數,比如f()
METH_STATIC對應python中的static函數,staticmethod
METH_STATIC對應class函數,classmethod
3.1 C++導出函數的處理過程
- 從args/kwds參數中提取出參數,需要將python類型的參數處理為C/C++類型。
- 這一步是我們想在C++層做的所有的邏輯。
- 將C++邏輯得到的結果轉為python類型,然后return。
- 注意處理exceptions和引用計數/內存泄漏。
舉例說明
static PyObject* msg_box(PyObject *self, PyObject *args) #函數聲明
{
const char *msg;
if (!PyArg_ParseTuple(args, "s", &msg)) #1 參數轉換
return NULL;
MessageBox(0, msg, "test", 0);#2 C++邏輯
Py_INCREF(Py_None);# 4引用計數
return Py_None; # 3 return python類型結果
}
提取占位參數
提取占位參數,使用函數PyArg_ParseTuple(PyObject *args, char *format, ...)
比如PyArg_ParseTuple(args, "sbi", &argStr, &argChar, &argInt)
,args包含三個參數,分別是string(char *),char和int型,轉換后C++使用對應類型的變量保存。
關鍵字參數使用函數PyArg_ParseTupleAndKeywords
,使用方式類似。
函數返回值
python的函數一定有返回值的,所以導出給python用的C++函數也必須有返回值,沒有也要返回Py_None
。
此外,函數的返回值類型必須為PyObject 。為了達到這個目的,需要將返回的結果轉為python類型,可以使用Py_BuildValue()/PyInt_From()/PyString_From*()/..等函數轉換,這些函數生成的函數對象,可以直接返回表,不需要加引用。
引用計數
非常重要,可能導致引用泄露導致內存泄漏,也可以能減多了,在某一個對象正在被管理的情況下,這個對象已被釋放或者被指向錯了。
Py_INCREAF/Py_DECREF 手動加減引用計數。
New Reference(Owned Reference)
Borrowed Reference
Steal Reference
每個函數必須要以NewReference返回結果。
要看一個API是borrowed reference還是new reference,若borrowed,返回前要increase
異常和異常處理
調用Python C API錯誤,則API會設置異常并且返回一個錯誤標志。我們調用了API后必須檢查錯誤標記,只需要return it(類比stack),不需要設置異常。
若我們希望自己raise一個異常,則必須自己設置exception,并且返回錯誤比較值。
設置異常:PyErr_Set*(),設置后最終保存在sys.exc_type, sys.exc_value, sys.exc_traceback
調用API后發生了異常,但是我們自己處理掉了,這時需要清空異常:PyErr_Clear()
檢查現在是否有一個異常正在發生:PyErr_Occurred()
假如現在有一個未處理的異常,這時若我們主動去再次設置異常,則會覆蓋。(這其實是不對的)
若有一個異常發生,但是我們并沒有處理,也沒有return到上層:異常被保留,并且在任何一個API調用時,都會拋出一個異常。
A函數拋了個異常,但是沒有處理也沒有return,A函數調用后我們又調用了B,則B會拋異常,但是這個異常其實是A的。
若只return了錯誤標記,但是沒有處理異常:vm會知道,并且會提示(有異常發生,但是vm不知道發生了什么)。
錯誤標記是什么:
若函數返回PyObject*, 則將NULL作為錯誤碼。
若返回int,則返回0/-。
1