美文网首页
python扩展1-C导出模块、函数给python使用

python扩展1-C导出模块、函数给python使用

作者: 水风 | 来源:发表于2017-05-03 10:27 被阅读263次

    导出模块

    当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

    相关文章

      网友评论

          本文标题:python扩展1-C导出模块、函数给python使用

          本文链接:https://www.haomeiwen.com/subject/ftvabttx.html