• Python/C API

    Python/C API

    Python/C API可能是被最广泛使用的方法。它不仅简单，而且可以在C代码中操作你的Python对象。

    这种方法需要以特定的方式来编写C代码以供Python去调用它。所有的Python对象都被表示为一种叫做PyObject的结构体，并且Python.h头文件中提供了各种操作它的函数。例如，如果PyObject表示为PyListType(列表类型)时，那么我们便可以使用PyList_Size()函数来获取该结构的长度，类似Python中的len(list)函数。大部分对Python原生对象的基础函数和操作在Python.h头文件中都能找到。

    示例

    编写一个C扩展，添加所有元素到一个Python列表(所有元素都是数字)

    来看一下我们要实现的效果，这里演示了用Python调用C扩展的代码

    1. #Though it looks like an ordinary python import, the addList module is implemented in C
    2. import addList
    4. l = [1,2,3,4,5]
    5. print "Sum of List - " + str(l) + " = " +  str(addList.add(l))

    上面的代码和普通的Python文件并没有什么分别，导入并使用了另一个叫做addList的Python模块。唯一差别就是这个模块并不是用Python编写的，而是C。

    接下来我们看看如何用C编写addList模块，这可能看起来有点让人难以接受，但是一旦你了解了这之中的各种组成，你就可以一往无前了。

    1. //Python.h has all the required function definitions to manipulate the Python objects
    2. #include <Python.h>
    4. //This is the function that is called from your python code
    5. static PyObject* addList_add(PyObject* self, PyObject* args){
    7.     PyObject * listObj;
    9.     //The input arguments come as a tuple, we parse the args to get the various variables
    10.     //In this case it's only one list variable, which will now be referenced by listObj
    11.     if (! PyArg_ParseTuple( args, "O", &listObj ))
    12.         return NULL;
    14.     //length of the list
    15.     long length = PyList_Size(listObj);
    17.     //iterate over all the elements
    18.     int i, sum =0;
    19.     for (i = 0; i < length; i++) {
    20.         //get an element out of the list - the element is also a python objects
    21.         PyObject* temp = PyList_GetItem(listObj, i);
    22.         //we know that object represents an integer - so convert it into C long
    23.         long elem = PyInt_AsLong(temp);
    24.         sum += elem;
    25.     }
    27.     //value returned back to python code - another python object
    28.     //build value here converts the C long to a python integer
    29.     return Py_BuildValue("i", sum);
    31. }
    33. //This is the docstring that corresponds to our 'add' function.
    34. static char addList_docs[] =
    35. "add(  ): add all elements of the list\n";
    37. /* This table contains the relavent info mapping -
    38.    <function-name in python module>, <actual-function>,
    39.    <type-of-args the function expects>, <docstring associated with the function>
    40.  */
    41. static PyMethodDef addList_funcs[] = {
    42.     {"add", (PyCFunction)addList_add, METH_VARARGS, addList_docs},
    43.     {NULL, NULL, 0, NULL}
    45. };
    47. /*
    48.    addList is the module name, and this is the initialization block of the module.
    49.    <desired module name>, <the-info-table>, <module's-docstring>
    50.  */
    51. PyMODINIT_FUNC initaddList(void){
    52.     Py_InitModule3("addList", addList_funcs,
    53.             "Add all ze lists");
    55. }

    逐步解释

    • Python.h头文件中包含了所有需要的类型(Python对象类型的表示)和函数定义(对Python对象的操作)
    • 接下来我们编写将要在Python调用的函数, 函数传统的命名方式由{模块名}_{函数名}组成，所以我们将其命名为addList_add
    • 然后填写想在模块内实现函数的相关信息表，每行一个函数，以空行作为结束
    • 最后的模块初始化块签名为PyMODINIT_FUNC init{模块名}。

    函数addList_add接受的参数类型为PyObject类型结构(同时也表示为元组类型，因为Python中万物皆为对象，所以我们先用PyObject来定义)。传入的参数则通过PyArg_ParseTuple()来解析。第一个参数是被解析的参数变量。第二个参数是一个字符串，告诉我们如何去解析元组中每一个元素。字符串的第n个字母正是代表着元组中第n个参数的类型。例如，”i”代表整形，”s”代表字符串类型, “O”则代表一个Python对象。接下来的参数都是你想要通过PyArg_ParseTuple()函数解析并保存的元素。这样参数的数量和模块中函数期待得到的参数数量就可以保持一致，并保证了位置的完整性。例如，我们想传入一个字符串，一个整数和一个Python列表，可以这样去写

    1. int n;
    2. char *s;
    3. PyObject* list;
    4. PyArg_ParseTuple(args, "siO", &n, &s, &list);

    在这种情况下，我们只需要提取一个列表对象，并将它存储在listObj变量中。然后用列表对象中的PyList_Size()函数来获取它的长度。就像Python中调用len(list)。

    现在我们通过循环列表，使用PyList_GetItem(list, index)函数来获取每个元素。这将返回一个PyObject*对象。既然Python对象也能表示PyIntType，我们只要使用PyInt_AsLong(PyObj *)函数便可获得我们所需要的值。我们对每个元素都这样处理，最后再得到它们的总和。

    总和将被转化为一个Python对象并通过Py_BuildValue()返回给Python代码，这里的i表示我们要返回一个Python整形对象。

    现在我们已经编写完C模块了。将下列代码保存为setup.py

    1. #build the modules
    3. from distutils.core import setup, Extension
    5. setup(name='addList', version='1.0',  \
    6.       ext_modules=[Extension('addList', ['adder.c'])])

    并且运行

    1. python setup.py install

    现在应该已经将我们的C文件编译安装到我们的Python模块中了。

    在一番辛苦后，让我们来验证下我们的模块是否有效

    1. #module that talks to the C code
    2. import addList
    4. l = [1,2,3,4,5]
    5. print "Sum of List - " + str(l) + " = " +  str(addList.add(l))

    输出结果如下

    1. Sum of List - [1, 2, 3, 4, 5] = 15

    如你所见，我们已经使用Python.h API成功开发出了我们第一个Python C扩展。这种方法看似复杂，但你一旦习惯，它将变的非常有效。

    Python调用C代码的另一种方式便是使用Cython让Python编译的更快。但是Cython和传统的Python比起来可以将它理解为另一种语言，所以我们就不在这里过多描述了。