python擴展1-C導出模塊、函數給python使用

導出模塊

當python執行import dllmodule時,執行了以下步驟:

  1. 查找名字為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++導出函數的處理過程

  1. 從args/kwds參數中提取出參數,需要將python類型的參數處理為C/C++類型。
  2. 這一步是我們想在C++層做的所有的邏輯。
  3. 將C++邏輯得到的結果轉為python類型,然后return。
  4. 注意處理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++使用對應類型的變量保存。

Paste_Image.png

關鍵字參數使用函數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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,443評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,530評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,407評論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,981評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,759評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,204評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,263評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,415評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,955評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,782評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,222評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,650評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,892評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,675評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,967評論 2 374

推薦閱讀更多精彩內容