swig與python

　　當你覺得python慢的時候，當你的c/c++代碼難以用在python上的時候，你可能會注意這篇文章。swig是一個可以把c/c++代碼封裝為python庫的工具。（本文封裝為python3的庫）

文章結構

• 整體看封裝
• 只使用python提供的c語言接口（Python.h）封裝一個簡單的c函數
• 使用swig封裝一個簡單的c函數
• 使用swig封裝一個簡單的c++類

整體看封裝

c/c++實現功能 ==> c/c++封裝c/c++函數 ==> 將前兩者編譯生成動態庫 ==> python進一步封裝；

手動封裝c函數

我把實現和封裝放在一個文件中(add.c)。

//add.c
#include <Python.h>

//定義一個C函數
int add(int a,int b){
    return a+b;
}

//包裝c函數
static PyObject* _add_add(PyObject *self,PyObject *args){
    int a,b;
    PyArg_ParseTuple(args,"ii",&a,&b);            //把python參數轉換為c函數
    return (PyObject*)Py_BuildValue("i",add(a,b));    //返回python對象的指針
}

//方法結構數組
static PyMethodDef _addMethods[]={        //
    { "add",_add_add,METH_VARARGS},
    {NULL,NULL}
};

//模塊結構
static struct PyModuleDef _addModule={
    PyModuleDef_HEAD_INIT,        
    "_add",        //模塊名
    "ADD",    //文檔
    -1,            
    _addMethods        //PyMethodsDef實例 
};

//初始化函數
PyMODINIT_FUNC PyInit__add(){
    PyModule_Create(&_addModule);    //參數為PyModuleDef*
}

/*************************************************
 * (1)定義一個C函數，如add()。
 *
 * (2)包裝c函數，如_add_add()。
 *
 * (3)方法結構數組，如_addMethods[]。
 *
 * (4)模塊結構，如_addModule。
 *
 * (5)初始化函數PyInit_<module_name>(),如PyInit__add(),"_add"是模塊名。
 *
 * 聯系：
 * import ==> PyInit_<...>() ==> PyModule_Create() ==> PyModuleDef ==> PyMethodsDef ==> 包裝函數 ==> c函數
 * ************************************************/

把add.c編譯成動態庫(_add.so)。

#Makefile
_add.so : add.c
    gcc -o _add.so add.c -fPIC -shared
clean :
    rm _add.so

_add.so已經是一個可用的python模塊了，模塊名為_add。

通過python進一步封裝。這個庫很簡單，會感覺這一步行是多余的，但用swig都有這一步。

#add.py
from _add import *

自己創建add.c、Makefile和add.py，編譯生成_add.so。

swig封裝c函數

首先實現功能（add.c、add.h）。

//add.h
#ifndef ADD_H
#define ADD_H

int add(int,int);

#endif

//------------------------------------------------------------------------

//add.c
#include "add.h"
int add(int a,int b)
{ 
    return a+b;
}
swig需要一個輸入文件（add.i)。
/* add.i */
%module add   /*模塊名*/

%{
#include "add.h"
%}

int add(int,int);   /*add.h中的內容*/

又是Makefile。

#Makefile
_add.so : add.c add.h add_wrap.c
    gcc -shared -fPIC -o _add.so add.c add_wrap.c
add_wrap.c : add.i
    swig -python -py3 add.i
clean :
    rm _add.so add_wrap.c add.py

自己創建add.c、add.h、Makefile和add.i，編譯生成add.py和_add.so。swig生成add.py和add_wrap.c,gcc將add.c和add_wrap.c編譯成_add.so。在add_wrap.c搜索手動封裝c函數的add.c文件中的相關結構便知其實質。

swig封裝c++類

用c++實現一個向量類（Vector），兩個文件——vector.hpp和vector.cpp。

//vector.hpp
#ifndef VECTOR_HPP
#define VECTOR_HPP

class Vector{
public:
    Vector(int,int);
    double abs();
    void display();
private:
    int x;
    int y;
};

#endif

//vector.cpp
#include "vector.hpp"
#include <iostream>
#include <cmath>
using namespace std;

Vector::Vector(int a,int b){  x=a;  y=b;  }
void Vector::display(){  cout << "(" << x << ',' << y << ')' << endl; }
double Vector::abs(){    return sqrt(x*x+y*y);  }

swig輸入文件（vector.i)。

/* vector.i */
%module vector
%{
#include "vector.hpp"
%}

class Vector{
public:
    Vector(int,int);
    double abs();
    void display();
private:
    int x;
    int y;
};

還是Makefile。

#Makefile
_vector.so : vector.cpp vector.hpp vector_wrap.cxx
    g++ -shared -fPIC -I/usr/include/python3.4m -lpython3.4m -o _vector.so vector.cpp vector_wrap.cxx
vector_wrap.cxx : vector.i
    swig -c++ -python -py3 vector.i
clean :
    rm _vector.so vector_wrap.cxx vector.py

自己創建vector.cpp、vector.hpp、Makefile和vector.i，編譯生成vector.py和_vector.so。