利用swig实现python调用C/C++的方法

 利用swig实现python调用C/C++的方法

 Python是一门语法简单而且清晰的脚本语言，不过执行效率比较低。简单的说就是开发相对C/C++容易，但是执行效率不如C/C++，甚至有人称之为执行效率最低的鱼眼。如果可以将最重要的而且变化一般不大的运算逻辑用 C/C++实现，其他用python书写，那就最好不过了。据说python底层就是用C实现的，因此这一想法也是可行的。目前来说，python调用C/C++有以下几种方法：

1）  利用python提供的API调用C。主要方法是在c++文件中借助Python提供的头文件python.h，对C/Cpp函数进行封装。然后将它编译为一个动态链接库（一个Module）。最后在Python文件中将这个module 加载进去，就可以调用了。具体例子请见http://blog.csdn.net/marising/article/details/2845339

2）  利用boost工具进行封装。相对1）来说更为方便，但是和1）一样都需要对原C代码进行破坏。具体例子请见http://blog.csdn.net/marising/article/details/2917827

3）  利用ctypes。ctypes是Python标准库提供的调用动态链接库的模块，相对1）2）来说不需要对源代码进行破坏，只需要对相应的c++数据类型进行python的转换。但是据说对C/C++的支持不一定完整.

4）  利用Swig工具。Swig和boost一样是一个对C进行封装的工具，但是和boost不一样，它不需要对源代码进行破坏，只需要新增一个接口文件对需要封装的函数和类进行描述，swig会自动对c代码封装成一个能被调用的module供Python调用。

        下面具体介绍一下Swig的使用方法。刚才说了，swig和boost不一样，它不用对源代码进行破坏，只需要在外面多写一个接口文件。假设有如下的cpp文件需要封装：

#include <time.h>
 double My_variable = 3.0;
 
 int fact(int n) {
     if (n <= 1) return 1;
     else return n*fact(n-1);
 }
 
 int my_mod(int x, int y) {
     return (x%y);
 }
     
 char *get_time()
 {
     time_t ltime;
     time(<ime);
     return ctime(<ime);
 }

       那么我们需要写如下接口文件（example.i）：

 %module example
 %{
 /* Put header files here or function declarations like below */
#define SWIG_FILE_WITH_INIT
 extern double My_variable;
 extern int fact(int n);
 extern int my_mod(int x, int y);
 extern char *get_time();
 %}
 
 extern double My_variable;
 extern int fact(int n);
 extern int my_mod(int x, int y);
 extern char *get_time();


      这是Python tutorial中的一个例子。下面将具体介绍一下example.i这个文件。

      %module 后面的名字是被封装的模块名称。封装口，python通过这个名称加载程序。

     %{  %}之间所添加的内容，一般包含此文件需要的一些函数声明和头文件。

      最后一部分，声明了要封装的函数和变量。

      比较建议的写法是，把要封装的函数声明部分写成头文件，假如为example.h，这样接口文件就非常简单了：

 %module example
 %{
 /* Put header files here or function declarations like below */
#define SWIG_FILE_WITH_INIT
#include"example.h"
 %}
 
%include"example.h"

     为了编译出一个封装的动态库，依次执行：

 $ swig -python -c++ example.i
会生成 .cxx   .py文件
 $ g++ -c -fPIC example_wrap.cxx -I/usr/local/include/python2.6
会生成 两个.o 文件
 $ g++ -shared example_wrap.o -o _example.so
------如果生成的_example.so依赖其他的.SO，编译时需添加  -L..... -lxxx,例如

g++ -L../generateFingerPrint/ -lgenerateFingerPrintdll64 -L/usr/local/lib -lpython2.7 -shared sp_fingerprint_swig_wrap.o sp_fingerprint_swig.o -o _FingerPrintLocal.so

       第一步的过程会生成example_wrap.cxx的文件。因为现在是cpp文件，所以编译出来是个.cxx文件和一个example_wrap.py。如果是c的文件，编译后会出现一个.c的文件。这个文件相当于将原cpp文件进行了封装，wrap了一层。后面两步就是标准的生成动态链接库的步骤了。这样得到的动态链接库就可以直接被python import了。

 >>> import example
 >>> example.fact(5)
 120
 >>> example.my_mod(7,3)
 1
 >>> example.get_time()
 'Tue Dec 11 23:01:07 2012'
 >>>