快速实现python c扩展模块

1  python扩展模块的组成

　　在python中，对于一些和系统相关的模块或者对性能要求很高的模块，通常会把这个模块C化。扩展模块中主要包含下面几个部分：

• init函数，函数名为：init+模块名，这个函数负责初始化模块，包括设置模块中的方法、对象和其它相关数据的初始化。这个函数是必须的，在脚本中第一次导入这个模块的时候，会先执行这个方法。
• 定义模块方法描述表，它是一个static类型的PyMethodDef数据结构，用来描述模块中定义的方法。
• C函数定义，这些函数是方法描述表中方法的具体实现。
• 如果模块中定义了类，那么还要定义类方法描述表和对象类型。

2  实现python扩展模块实例

 　　当然，有了上面的组成部分，你还是不知道怎么实现一个模块，下面就用官方的一个例子来演示怎么实现一个python扩展模块，这个扩展模块用来实现在python中执行命令行命令。

 // spam.c
 1 #include "Python.h"

static PyObject *SpamError;

static PyObject *
    spam_system(PyObject *self, PyObject *args)
{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = system(command);
    if (sts < 0) {
        PyErr_SetString(SpamError, "System command failed");
        return NULL;
    }
    return PyLong_FromLong(sts);
}

static PyMethodDef SpamMethods[] = {
    {"system",  spam_system, METH_VARARGS,
    "Execute a shell command."},
    {NULL, NULL, 0, NULL}        /* Sentinel */
};

PyMODINIT_FUNC
    initspam(void)
{
    PyObject *m;

    m = Py_InitModule("spam", SpamMethods);
    if (m == NULL)
        return;

    SpamError = PyErr_NewException("spam.error", NULL, NULL);
    Py_INCREF(SpamError);
    PyModule_AddObject(m, "error", SpamError);
}

 　　上面的initspam是模块的初始化函数，函数开始调用了Py_InitModule初始化了一个名为spam的模块，模块的方法描述表是SpamMethods，它描述了模块有个名为system的方法，这个方法的c/c++实现是spam_system函数。从spam_system函数可以看到它就是调用system函数执行从python传过来的命令。有了上面的代码，我们怎样在python中使用了？很简单，先将上面代码编译成动态链接库，然后直接在python中用import语句导入这个模块就可以用了。在Windows下的用vs编译就行，不过在vs建立了dll工程后，需要设置下工程的属性，目的是设置python扩展涉及到的头文件路径和动态库。具体设置如下：先在VC++目录中设置include和lib路径，然后在链接器的附加依赖项中添加python27.lib库。

　　设置好后直接编译就可以了，将编译生成的dll文件后缀名改成pyd，然后就可以在python中直接用import导入这个模块了。是不是非常的简单！！！！

3  实现python扩展模块中定义类

　　上面的实现是在模块中定义函数来实现执行命令行命令，我们也可以在模块中定义类，然后用类的方法来执行这个命令。代码如下：

 // spam.c
 1 #include "Python.h"

static PyObject *SpamError;

static PyObject *
    spam_system(PyObject *self, PyObject *args)
{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = system(command);
    if (sts < 0) {
        PyErr_SetString(SpamError, "System command failed");
        return NULL;
    }
    return PyLong_FromLong(sts);
}

static PyMethodDef SpamMethods[] = {
    {"system",  spam_system, METH_VARARGS,
    "Execute a shell command."},
    {NULL, NULL, 0, NULL}        /* Sentinel */
};

PyTypeObject *SpamType = NULL;

PyMODINIT_FUNC
    initspam(void)
{
    static PyTypeObject _SpamType = {
        PyObject_HEAD_INIT(NULL)
        0,                                // ob_size
        "spam.Spam",                // tp_name
        sizeof(PyObject),                // tp_basicsize
        0,                                // tp_itemsize
        0,        // tp_dealloc
        0,                                // tp_print
        0,                                // tp_getattr
        0,                                // tp_setattr
        0,                                // tp_compare
        0,            // tp_repr
        0,                                // tp_as_number
        0,                                // tp_as_sequence
        0,                                // tp_as_mapping
        0,                                // tp_hash
        0,                                // tp_call
        0,            // tp_str
        0,                                // tp_getattro
        0,                                // tp_setattro
        0,                                // tp_as_buffer
        Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE ,    // tp_flags
        0,                    // tp_doc
        0,                                // tp_traverse
        0,                                // tp_clear
        0,                                // tp_richcompare
        0,                                // tp_weaklistoffset
        0,                                // tp_iter
        0,                                // tp_iternext
        SpamMethods,                    // tp_methods
        0,                                // tp_members
        0,                // tp_getset
        0,                                // tp_base
        0,                                // tp_dict
        0,                                // tp_descr_get
        0,                                // tp_descr_set
        0,                                // tp_dictoffset
        0,            // tp_init
        0,                                // tp_alloc
        PyType_GenericNew,                // tp_new
    };

    PyObject *m;

    m = Py_InitModule("spam", NULL);
    if (m == NULL)
        return;
    if (PyType_Ready(&_SpamType) < 0)
        return;
    SpamType = &_SpamType;
    Py_INCREF(SpamType);
    PyModule_AddObject(m, "Spam", (PyObject*)SpamType);
    SpamError = PyErr_NewException("spam.error", NULL, NULL);
    Py_INCREF(SpamError);
    PyModule_AddObject(m, "error", SpamError);
}

　　上面的代码与之前的代码只是多了个Spam类的定义，使用的时候通过Spam的实例化对象来调用system函数。

4  Python/C API涉及的引用计数问题

　　通过上面的例子，是不是觉得写python的C扩展模块非常的简单呢？其实不然，主要是python中有个引用计数问题，在写扩展模块的时候必须非常小心的处理，否则很有容易导致内存泄露。根据python官方的定义，在Python/C API中，引用计数的行为被归纳为三种：new reference、borrow reference和steal reference，前两种用于描述返回PyObject*类型的函数对返回的这个对象的引用计数的行为；后一种用于将一个PyObject*类型传入函数后，函数对这个对象的引用计数的行为。new referenc表示函数将这个对象引用的所有权转交给函数调用者了，由函数的调用者来管理这个引进的计数，也就是说调用者不用这个引用的时候必须显示的调用 Py_DECREF()或者Py_XDECREF()来释放这个引用，典型的函数是PyObject_、PyNumber_、PySequence_和PyMapping_；borrow reference与new reference刚好相反，表示函数的调用者只管用这个引用，不用关心它的引用计数，用完了也不用显示调用Py_DECREF()或者Py_XDECREF()来释放这个引用，典型的函数是PyList_GetItem、PyTuple_GetItem；steal reference表示函数内部只会使用这个引用，不会调用Py_INCREF来增加这个引用的引用计数，相当于“偷了”被调用者的一个引用计数，典型的函数是PyList_SetItem()和PyTuple_SetItem()。因此，在编写C扩展的时，如果遇到某个Python/C API不确定是哪种reference的时候，建议查下官方文档，文档中会明确的说明这个函数是哪类reference（如下图所示），这样能大大减少引用计数的问题。

5  参考

　　python官网