用swig 封装C++ 动态库的实践

python 调用C++ 有很多方案。 swig 还是比较好用的。

需求： 假设有一个现成的C++ 库 a.so 和 头文件 a.h 如何通过python 来调用 a.so 里面的功能接口。

最开始我误认为必须有 a.so 的源代码cpp和a.h 才行。实践过发现，不需要源代码，swig可以根据头文件就自动生成一个可以供python调用的桥接so库的代码，在编译这个代码的时候，只要把a.so链接进去，就万事大吉了。

具体实现过程如下：

1，创建一个swig的 xxx.i 配置文件，如： mod_a.i ,  

/* File: mod_a.i */
%module mod_a

%{
#include "../a/include/a.h"
%}

%include "../include/a.h"

这个文件中，有两个include，第一个#include是最终集成到wrap代码里面的。 第二个是swig 的输入。这两个路径可以不同，主要取决于 swig输出的目标cxx文件 和 mod_a.i 所在目录。

2，用swig 生成 桥接用的代码。可以执行命令：

swig -c++ -python mod_a.i

这个命令执行后，就会在mod_a.i 所在的目录下生成两个文件：mod_a.py 和 mod_a_wrap.cxx

mod_a.py 是供python调用的接口，在python import的时候自动会调用，不需要关注。 mod_a_wrap.cxx这个文件就是桥接库的c++代码，需要将这个代码编译成名为"_mod_a.so" 的so库, 注意名称前面必须有下划线，而在python import 的是mod_a。

3， 编译 桥接so库。这里我们采用g++ 命令来编译：
 

   g++ -fPIC -shared mod_a_wrap.cxx -o _mod_a.so -I/usr/include/python2.7/ -lpython2.7 -la -L./lib

 也可以通过cmake 来配置：

cmake_minimum_required(VERSION 2.8.3)
project(a)

set(CMAKE_CXX_FLAGS "-std=c++11 ")
set(DEPEND_LIB_DIR ../dep_lib)
link_directories(    
    ./
    ${DEPEND_LIB_DIR}   
)
include_directories(
    ${DEPEND_LIB_DIR}/include    
    ./include
    /usr/include/python2.7/
)

add_library(a SHARED
   ./src/a.cpp
)

target_link_libraries(a 
    dl
    rt
    pthread
 )

EXECUTE_PROCESS( COMMAND swig -c++ -python -outdir ${PROJECT_BINARY_DIR} -o ${PROJECT_BINARY_DIR}/mod_a_wrap.cxx   ${PROJECT_SOURCE_DIR}/src/mod_a.i  
COMMAND cp  ./src/test_main.py   ${CMAKE_BINARY_DIR}/a/ 
)
message( "output swig py  files to ${PROJECT_BINARY_DIR} ")
message( "output swig cxx files to ${PROJECT_BINARY_DIR}/mod_a_wrap.cxx  ")

add_library(mod_a SHARED
   ${PROJECT_BINARY_DIR}/mod_a_wrap.cxx
)

target_link_libraries(mod_a
    a
    python2.7
 )
 
# OUTPUT_NAME "_mod_a.so"
 set_target_properties(mod_a PROPERTIES PREFIX "_")

这里为了剥离build和src 目录，用到swig的两个参数  -outdir 制定.py 文件的输出目录，-o 指定 wrap.cxx文件的输出路径+名称。

4，最后就是在python 里面 调用接口。

如：import mod_a 

具体测试用例可以放在   ./src/test_main.py中去。