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阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容