Python【八】：扩展C代码

sky

Python作为一门高级动态语言，其优势在于灵活性，比如其弱类型的特点，以及处理字节流的简洁高效；但是不可否认，Python作为一种偏向人工的接口语言，其最大的问题在于其效率，比着C/C++差了许多，也许平时写小程序感觉不明显，但是当遇到大量的数据运算时，就会体现出Python的效能瓶颈。所以自己现在正在摸索着使用Python开发程序的主框架，然后使用C/C++改写其中的部分代码以消除性能瓶颈。今天介绍的内容即如何在Python中引入C/C++代码模块。
   Python中嵌入其他代码的行为称作Python扩展，可以扩展C/C++、Java、C#等，这里主要介绍自己常用的C/C++，扩展的方法也有多种，比如直接使用Python的C API来包装C/C++代码，实现Python与C/C++之间的数据转换，但是这种方法比较繁琐，需要自己编写包装函数，因此自己使用的是SWIG，即简单包装盒接口生成器，可以将C/C++代码扩展到高级语言Python、Perl、Ruby和Java中。使用SWIG扩展Python时主要有三个步骤，下面我们逐步来介绍。
   SWIG可以从官网（http://www.swig.org）下载后源码configure/make install安装，一般的Linux系统上会自带，比如自己的Ubuntu12.04上就默认安装了SWIG。

一、接口文件
   在使用SWIG之前，我们必须提供接口文件，其实就是对于SWIG来说的头文件，它用来告诉SWIG编译处理的C/C++模块中引入了哪些C/C++的头文件以及导出的函数接口。但是在这之前，我们要先准备用于测试的C代码，这里我们编写了一个“回文”测试程序，即字符串针对中心呈轴对称，下面是代码：
test.c文件代码



    #include <string.h>

    int is_padstring(char *text)
    {
        int i;
        int n = strlen(text);
        for (i = 0; i <= n/2; i++)
          {
              if (text != text[n - i - 1]) return 0;  //比较对称位置的字符
          }
        return 1;
    }

   接下来我们要编写 *.i的SWIG接口文件，这里主要要声明模块名称、包含的C/C++头文件以及导出的函数，代码如下：
padstring.i文件内容



    %module padstring

    %{
    #include <string.h>
    %}

    extern int is_padstring(char *text);

   其中%module用来说明生成的Python扩展模块名称，而%{与%}则用来包含其中的头文件，如这里的include <string.h>；最后通过extern导出函数接口；

二、运行SWIG
   这一步主要用于根据我们的原始C代码，生成用于模块使用的包装代码，运行命令：swig -python is_padstring.i，可以得到is_padstring_wrap.c与padstring.py，当针对C++代码时，要添加-C++选项，-python表示要以Python需要的方式来生成包装代码：


三、编译连接
   这一步的主要工作是将原来的C语言代码和产生的包装代码来编译产生共享库*.so，这里需要首先确定pyconfig.h和Python.h两个头文件的位置，一般在Ubuntu中会放置于默认的/usr/include/python2.7下（自己的版本是Python2.7），但是有可能只有pyconfig.h而没有Python.h，莫慌，此时只需要apt-get install python-dev即可在同样的目录中获得Python.h，然后开始运行命令：
-1. 编译但是不连接我们的C代码：gcc -c test.c得到test.o文件；
-2. 编译但是不连接SWIG的包装代码：gcc -I /usr/include/python2.7 -c is_padstring_wrap.c得到is_padstring_wrap.o文件；
-3. 连接原始C代码的.o文件和包装代码的.o文件：gcc -shared test.o is_padstring_wrap.o -o _padstring.so得到_padstring.so共享库文件；

四、测试
   写一个简单的test.py，



    import _padstring
    x = _padstring.is_padstring("afggfa")
    print "afggfa"+' ', x

    y = _padstring.is_padstring("Hello")
    print "Hello"+' ', y

    然后运行，注意里面调用了C模块的函数，结果可以正确运行：

    末了，最后来说说如何设置PYTHONPATH，因为PYTHONPATH是Python默认寻找导入模块位置的变量，可以使用SHELL命令：
export PYTHONPATH = $PYTHONPATH:YOURPATH
   或者运行Python命令：
   import sys
   sys.path.append("YOURPATH")
   print sys.path  #可以打印出当前的PYTHONPATH查看是否修改添加成功。小结一下步骤，其实就是编写SWIG接口文件-->运行SWIG生成包装文件-->编译不连接源代码和包装代码，分别得到各自的.o文件-->编译链接两个.o文件得到共享库文件。