如何实现 C/C++ 与 Python 的通信

Posted 2023-05-01

属于混合编程的问题。较全面的介绍一下，不仅限于题主提出的问题。
以下讨论中，Python指它的标准实现，即CPython（虽然不是很严格）

本文分4个部分

C/C++ 调用 Python （基础篇）— 仅讨论Python官方提供的实现方式
Python 调用 C/C++ （基础篇）— 仅讨论Python官方提供的实现方式
C/C++ 调用 Python （高级篇）— 使用 Cython
Python 调用 C/C++ （高级篇）— 使用 SWIG

练习本文中的例子，需要搭建Python扩展开发环境。具体细节见搭建Python扩展开发环境 - 蛇之魅惑 - 知乎专栏

1 C/C++ 调用 Python（基础篇）
Python 本身就是一个C库。你所看到的可执行体python只不过是个stub。真正的python实体在动态链接库里实现，在Windows平台上，这个文件位于 %SystemRoot%\\System32\\python27.dll。

你也可以在自己的程序中调用Python，看起来非常容易：

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

int main(int argc, char *argv[])

Py_SetProgramName(argv[0]);
Py_Initialize();
PyRun_SimpleString("print \'Hello Python!\'\\n");
Py_Finalize();
return 0;


在Windows平台下，打开Visual Studio命令提示符，编译命令为
cl my_python.c -IC:\\Python27\\include C:\\Python27\\libs\\python27.lib

在Linux下编译命令为
gcc my_python.c -o my_python -I/usr/include/python2.7/ -lpython2.7

在Mac OS X 下的编译命令同上

产生可执行文件后，直接运行，结果为输出
Hello Python!

Python库函数PyRun_SimpleString可以执行字符串形式的Python代码。

虽然非常简单，但这段代码除了能用C语言动态生成一些Python代码之外，并没有什么用处。我们需要的是C语言的数据结构能够和Python交互。

下面举个例子，比如说，有一天我们用Python写了一个功能特别强大的函数：

def great_function(a):
return a + 1

接下来要把它包装成C语言的函数。我们期待的C语言的对应函数应该是这样的：

int great_function_from_python(int a)
int res;
// some magic
return res;


首先，复用Python模块得做‘import’，这里也不例外。所以我们把great_function放到一个module里，比如说，这个module名字叫 great_module.py

接下来就要用C来调用Python了，完整的代码如下：
#include <Python.h>

int great_function_from_python(int a)
int res;
PyObject *pModule,*pFunc;
PyObject *pArgs, *pValue;

/* import */
pModule = PyImport_Import(PyString_FromString("great_module"));

/* great_module.great_function */
pFunc = PyObject_GetAttrString(pModule, "great_function");

/* build args */
pArgs = PyTuple_New(1);
PyTuple_SetItem(pArgs,0, PyInt_FromLong(a));

/* call */
pValue = PyObject_CallObject(pFunc, pArgs);

res = PyInt_AsLong(pValue);
return res;


从上述代码可以窥见Python内部运行的方式：

所有Python元素，module、function、tuple、string等等，实际上都是PyObject。C语言里操纵它们，一律使用PyObject *。
Python的类型与C语言类型可以相互转换。Python类型XXX转换为C语言类型YYY要使用PyXXX_AsYYY函数；C类型YYY转换为Python类型XXX要使用PyXXX_FromYYY函数。
也可以创建Python类型的变量，使用PyXXX_New可以创建类型为XXX的变量。
若a是Tuple，则a[i] = b对应于 PyTuple_SetItem(a,i,b)，有理由相信还有一个函数PyTuple_GetItem完成取得某一项的值。
不仅Python语言很优雅，Python的库函数API也非常优雅。

现在我们得到了一个C语言的函数了，可以写一个main测试它
#include <Python.h>

int great_function_from_python(int a);

int main(int argc, char *argv[])
Py_Initialize();
printf("%d",great_function_from_python(2));
Py_Finalize();


编译的方式就用本节开头使用的方法。
在Linux/Mac OSX运行此示例之前，可能先需要设置环境变量：
bash:
export PYTHONPATH=.:$PYTHONPATH

csh:
setenv PYTHONPATH .:$PYTHONPATH

2 Python 调用 C/C++（基础篇）
这种做法称为Python扩展。
比如说，我们有一个功能强大的C函数：
int great_function(int a)
return a + 1;


期望在Python里这样使用：
>>> from great_module import great_function
>>> great_function(2)
3

考虑最简单的情况。我们把功能强大的函数放入C文件 great_module.c 中。
#include <Python.h>

int great_function(int a)
return a + 1;


static PyObject * _great_function(PyObject *self, PyObject *args)

int _a;
int res;

if (!PyArg_ParseTuple(args, "i", &_a))
return NULL;
res = great_function(_a);
return PyLong_FromLong(res);


static PyMethodDef GreateModuleMethods[] =

"great_function",
_great_function,
METH_VARARGS,
""
,
NULL, NULL, 0, NULL
;

PyMODINIT_FUNC initgreat_module(void)
(void) Py_InitModule("great_module", GreateModuleMethods);


除了功能强大的函数great_function外，这个文件中还有以下部分：

包裹函数_great_function。它负责将Python的参数转化为C的参数（PyArg_ParseTuple），调用实际的great_function，并处理great_function的返回值，最终返回给Python环境。
导
出表GreateModuleMethods。它负责告诉Python这个模块里有哪些函数可以被Python调用。导出表的名字可以随便起，每一项有4
个参数：第一个参数是提供给Python环境的函数名称，第二个参数是_great_function，即包裹函数。第三个参数的含义是参数变长，第四个
参数是一个说明性的字符串。导出表总是以NULL, NULL, 0, NULL结束。
导出函数initgreat_module。这个的名字不是任取的，是你的module名称添加前缀init。导出函数中将模块名称与导出表进行连接。

在Windows下面，在Visual Studio命令提示符下编译这个文件的命令是
cl /LD great_module.c /o great_module.pyd -IC:\\Python27\\include C:\\Python27\\libs\\python27.lib

/LD 即生成动态链接库。编译成功后在当前目录可以得到 great_module.pyd（实际上是dll）。这个pyd可以在Python环境下直接当作module使用。

在Linux下面，则用gcc编译：
gcc -fPIC -shared great_module.c -o great_module.so -I/usr/include/python2.7/ -lpython2.7

在当前目录下得到great_module.so，同理可以在Python中直接使用。

本部分参考资料

《Python源码剖析-深度探索动态语言核心技术》是系统介绍CPython实现以及运行原理的优秀教程。
Python 官方文档的这一章详细介绍了C/C++与Python的双向互动Extending and Embedding the Python Interpreter
关于编译环境，本文所述方法仅为出示原理所用。规范的方式如下：3. Building C and C++ Extensions with distutils
作为字典使用的官方参考文档 Python/C API Reference Manual

用以上的方法实现C/C++与Python的混合编程，需要对Python的内部实现有相当的了解。接下来介绍当前较为成熟的技术Cython和SWIG。

3 C/C++ 调用 Python（使用Cython）

在
前面的小节中谈到，Python的数据类型和C的数据类型貌似是有某种“一一对应”的关系的，此外，由于Python（确切的说是CPython）本身是
由C语言实现的，故Python数据类型之间的函数运算也必然与C语言有对应关系。那么，有没有可能“自动”的做替换，把Python代码直接变成C代码
呢？答案是肯定的，这就是Cython主要解决的问题。

安装Cython非常简单。Python 2.7.9以上的版本已经自带easy_install：
easy_install -U cython

在Windows环境下依然需要Visual
Studio，由于安装的过程需要编译Cython的源代码，故上述命令需要在Visual
Studio命令提示符下完成。一会儿使用Cython的时候，也需要在Visual
Studio命令提示符下进行操作，这一点和第一部分的要求是一样的。

继续以例子说明：
#great_module.pyx
cdef public great_function(a,index):
return a[index]

这其中有非Python关键字cdef和public。这些关键字属于Cython。由于我们需要在C语言中使用
“编译好的Python代码”，所以得让great_function从外面变得可见，方法就是以“public”修饰。而cdef类似于Python的
def，只有使用cdef才可以使用Cython的关键字public。

这个函数中其他的部分与正常的Python代码是一样的。

接下来编译 great_module.pyx
cython great_module.pyx

得到great_module.h和great_module.c。打开great_module.h可以找到这样一句声明：
__PYX_EXTERN_C DL_IMPORT(PyObject) *great_function(PyObject *, PyObject *)

写一个main使用great_function。注意great_function并不规定a是何种类型，它的
功能只是提取a的第index的成员而已，故使用great_function的时候，a可以传入Python
String，也可以传入tuple之类的其他可迭代类型。仍然使用之前提到的类型转换函数PyXXX_FromYYY和PyXXX_AsYYY。

//main.c
#include <Python.h>
#include "great_module.h"

int main(int argc, char *argv[])
PyObject *tuple;
Py_Initialize();
initgreat_module();
printf("%s\\n",PyString_AsString(
great_function(
PyString_FromString("hello"),
PyInt_FromLong(1)
)
));
tuple = Py_BuildValue("(iis)", 1, 2, "three");
printf("%d\\n",PyInt_AsLong(
great_function(
tuple,
PyInt_FromLong(1)
)
));
printf("%s\\n",PyString_AsString(
great_function(
tuple,
PyInt_FromLong(2)
)
));
Py_Finalize();


编译命令和第一部分相同：
在Windows下编译命令为
cl main.c great_module.c -IC:\\Python27\\include C:\\Python27\\libs\\python27.lib

在Linux下编译命令为
gcc main.c great_module.c -o main -I/usr/include/python2.7/ -lpython2.7

这个例子中我们使用了Python的动态类型特性。如果你想指定类型，可以利用Cython的静态类型关键字。例子如下：

#great_module.pyx
cdef public char great_function(const char * a,int index):
return a[index]

cython编译后得到的.h里，great_function的声明是这样的：
__PYX_EXTERN_C DL_IMPORT(char) great_function(char const *, int);

很开心对不对！
这样的话，我们的main函数已经几乎看不到Python的痕迹了：
//main.c
#include <Python.h>
#include "great_module.h"

int main(int argc, char *argv[])
Py_Initialize();
initgreat_module();
printf("%c",great_function("Hello",2));
Py_Finalize();


在这一部分的最后我们给一个看似实用的应用（仅限于Windows）：
还是利用刚才的great_module.pyx，准备一个dllmain.c：
#include <Python.h>
#include <Windows.h>
#include "great_module.h"

extern __declspec(dllexport) int __stdcall _great_function(const char * a, int b)
return great_function(a,b);


BOOL WINAPI DllMain(HINSTANCE hinstDLL,DWORD fdwReason,LPVOID lpReserved)
switch( fdwReason )
case DLL_PROCESS_ATTACH:
Py_Initialize();
initgreat_module();
break;
case DLL_PROCESS_DETACH:
Py_Finalize();
break;

return TRUE;


在Visual Studio命令提示符下编译：
cl /LD dllmain.c great_module.c -IC:\\Python27\\include C:\\Python27\\libs\\python27.lib

会得到一个dllmain.dll。我们在Excel里面使用它，没错，传说中的Excel与Python混合编程：

参考资料：Cython的官方文档，质量非常高：
Welcome to Cython’s Documentation

4 Python调用C/C++（使用SWIG）

用
C/C++对脚本语言的功能扩展是非常常见的事情，Python也不例外。除了SWIG，市面上还有若干用于Python扩展的工具包，比较知名的还有
Boost.Python、SIP等，此外，Cython由于可以直接集成C/C++代码，并方便的生成Python模块，故也可以完成扩展Python
的任务。

答主在这里选用SWIG的一个重要原因是，它不仅可以用于Python，也可以用于其他语言。如今SWIG已经支持C/C++的
好基友Java，主流脚本语言Python、Perl、Ruby、php、javascript、tcl、Lua，还有Go、C#，以及R。SWIG是基
于配置的，也就是说，原则上一套配置改变不同的编译方法就能适用各种语言（当然，这是理想情况了……）

SWIG的安装方便，有Windows的预编译包，解压即用，绿色健康。主流Linux通常集成swig的包，也可以下载源代码自己编译，SWIG非常小巧，通常安装不会出什么问题。

用SWIG扩展Python，你需要有一个待扩展的C/C++库。这个库有可能是你自己写的，也有可能是某个项目提供的。这里举一个不浮夸的例子：希望在Python中用到SSE4指令集的CRC32指令。

首先打开指令集的文档：https://software.intel.com/en-us/node/514245
可以看到有6个函数。分析6个函数的原型，其参数和返回值都是简单的整数。于是书写SWIG的配置文件（为了简化起见，未包含2个64位函数）：

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

%
#include "nmmintrin.h"
%

int _mm_popcnt_u32(unsigned int v);
unsigned int _mm_crc32_u8 (unsigned int crc, unsigned char v);
unsigned int _mm_crc32_u16(unsigned int crc, unsigned short v);
unsigned int _mm_crc32_u32(unsigned int crc, unsigned int v);

接下来使用SWIG将这个配置文件编译为所谓Python Module Wrapper

swig -python mymodule.i

得到一个 mymodule_wrap.c和一个mymodule.py。把它编译为Python扩展：

Windows：
cl /LD mymodule_wrap.c /o _mymodule.pyd -IC:\\Python27\\include C:\\Python27\\libs\\python27.lib

Linux：
gcc -fPIC -shared mymodule_wrap.c -o _mymodule.so -I/usr/include/python2.7/ -lpython2.7

注意输出文件名前面要加一个下划线。
现在可以立即在Python下使用这个module了：

>>> import mymodule
>>> mymodule._mm_popcnt_u32(10)
2 参考技术A 如果是要同一个进程
可以用python 调用c/C++的库
否则 就编两个进程
然后用标准进程通信就好。

caffe的python接口封装原理与解析

【说明】：欢迎加入：faster-rcnn 交流群 238138700，caffe提供了灵活的python的接口，那么这些接口是如何实现的，caffe是如何有效的把c++中的方法和类，让我们在python中可以灵活调用的；

【c/c++扩展】：python中调用c/c++称为扩展，扩展的方法有很多；

标准的方法是：通过样板来包装c/c++代码，这种是最原始的方式，具体的实现可以参考《python核心编程》--22章，看这章的好处就是可以理解封装的思路是怎样的，为什么可行；

第二类方法就是借用各种各样的工具来减轻我们的工作量：听得最多的应该是SWIG，应该比较好用；caffe用的不是这个，caffe用的是boost python（能够极大提高c++为python写扩展的效率）

【跟其他工具的比较】：这一段我是借鉴别人的评述：点击打开链接

目前有多个工具可以实现跟 Boost.Python 类似的功能，如 SWIG，SIP等。但是它们有很大的不同。SWIG 和 SIP 都定义了一种接口描述语言。我需要先写一个接口描述文件，用于描述我要导出的 C++ 函数和类。然后通过一个翻译器，将接口描述文件翻译成 C++ 程序。最后编译连接生成的 C++ 程序来生成扩展库。而 Boost.Python 用于导出 C++ 函数和类的时候，我需要添加的也是 C++ 的代码，这是 Boost.Python 的最大特点之一。
SWIG 比较适合用来包装 C 语言程序，最近也开始增强一些对 C++ 的支持，但是到目前还不支持嵌套类等 C++ 特性。SIP 似乎除了用在包装 Qt 库之外，就没几个人用。而 Boost.Python 可能是这三者之间对 C++ 支持最好的一个。不过 Boost.Python 也有缺点，就是它使用了大量模板技巧，因此当要导出的元素比较多时，编译非常慢。不过幸好作为“胶水”，我并不需要经常修改和重编译，而且如果使用预编译头的话可以进一步提高编译速度。
Boost.Python 的另外一个优点是，它的设计目标就是让 C++ 程序库可以透明地导出到 Python 中去。即在完全不修改原来 C++ 程序的情况下，导出给 Python 用。在这种设计理念下设计出来的 Boost.Python 比同类工具支持了给完善的 C++ 特性，能够最大程度地保证不修改原 C++ 程序。要知道贸然修改别人的程序，往往会带来许多难以察觉的错误。
基于以上几点，我推荐大家在需要的时候使用 Boost.Python，而不是其它。这也是我写这篇文章的最大动力 :-)。

【boost python】：

官网的教程是最好的教材，写的也比较简洁：点击打开链接

我决定跟着官网的教程走一遍，把需要记录的写下来，建议大家也可以跟着官网教程走一遍；

【caffe的python接口代码】：caffe的python接口的代码就是在./python/caffe/_caffe.cpp文件中实现的，使用的就是boost python库；

#include <Python.h>  // NOLINT(build/include_alpha)

// Produce deprecation warnings (needs to come before arrayobject.h inclusion).
#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION

#include <boost/make_shared.hpp>
#include <boost/python.hpp>
#include <boost/python/raw_function.hpp>
#include <boost/python/suite/indexing/vector_indexing_suite.hpp>
#include <boost/python/enum.hpp>
#include <numpy/arrayobject.h>

// these need to be included after boost on OS X
#include <string>  // NOLINT(build/include_order)
#include <vector>  // NOLINT(build/include_order)
#include <fstream>  // NOLINT

#include "caffe/caffe.hpp"
#include "caffe/layers/memory_data_layer.hpp"
#include "caffe/layers/python_layer.hpp"
#include "caffe/sgd_solvers.hpp"

// Temporary solution for numpy < 1.7 versions: old macro, no promises.
// You're strongly advised to upgrade to >= 1.7.
#ifndef NPY_ARRAY_C_CONTIGUOUS
#define NPY_ARRAY_C_CONTIGUOUS NPY_C_CONTIGUOUS
#define PyArray_SetBaseObject(arr, x) (PyArray_BASE(arr) = (x))
#endif

namespace bp = boost::python;

namespace caffe 

// For Python, for now, we'll just always use float as the type.
typedef float Dtype;
const int NPY_DTYPE = NPY_FLOAT32;

// Selecting mode.
void set_mode_cpu()  Caffe::set_mode(Caffe::CPU); 
void set_mode_gpu()  Caffe::set_mode(Caffe::GPU); 

// For convenience, check that input files can be opened, and raise an
// exception that boost will send to Python if not (caffe could still crash
// later if the input files are disturbed before they are actually used, but
// this saves frustration in most cases).
static void CheckFile(const string& filename) 
    std::ifstream f(filename.c_str());
    if (!f.good()) 
      f.close();
      throw std::runtime_error("Could not open file " + filename);
    
    f.close();


void CheckContiguousArray(PyArrayObject* arr, string name,
    int channels, int height, int width) 
  if (!(PyArray_FLAGS(arr) & NPY_ARRAY_C_CONTIGUOUS)) 
    throw std::runtime_error(name + " must be C contiguous");
  
  if (PyArray_NDIM(arr) != 4) 
    throw std::runtime_error(name + " must be 4-d");
  
  if (PyArray_TYPE(arr) != NPY_FLOAT32) 
    throw std::runtime_error(name + " must be float32");
  
  if (PyArray_DIMS(arr)[1] != channels) 
    throw std::runtime_error(name + " has wrong number of channels");
  
  if (PyArray_DIMS(arr)[2] != height) 
    throw std::runtime_error(name + " has wrong height");
  
  if (PyArray_DIMS(arr)[3] != width) 
    throw std::runtime_error(name + " has wrong width");
  


// Net constructor for passing phase as int
shared_ptr<Net<Dtype> > Net_Init(
    string param_file, int phase) 
  CheckFile(param_file);

  shared_ptr<Net<Dtype> > net(new Net<Dtype>(param_file,
      static_cast<Phase>(phase)));
  return net;


// Net construct-and-load convenience constructor
shared_ptr<Net<Dtype> > Net_Init_Load(
    string param_file, string pretrained_param_file, int phase) 
  CheckFile(param_file);
  CheckFile(pretrained_param_file);

  shared_ptr<Net<Dtype> > net(new Net<Dtype>(param_file,
      static_cast<Phase>(phase)));
  net->CopyTrainedLayersFrom(pretrained_param_file);
  return net;


void Net_Save(const Net<Dtype>& net, string filename) 
  NetParameter net_param;
  net.ToProto(&net_param, false);
  WriteProtoToBinaryFile(net_param, filename.c_str());


void Net_SetInputArrays(Net<Dtype>* net, bp::object data_obj,
    bp::object labels_obj) 
  // check that this network has an input MemoryDataLayer
  shared_ptr<MemoryDataLayer<Dtype> > md_layer =
    boost::dynamic_pointer_cast<MemoryDataLayer<Dtype> >(net->layers()[0]);
  if (!md_layer) 
    throw std::runtime_error("set_input_arrays may only be called if the"
        " first layer is a MemoryDataLayer");
  

  // check that we were passed appropriately-sized contiguous memory
  PyArrayObject* data_arr =
      reinterpret_cast<PyArrayObject*>(data_obj.ptr());
  PyArrayObject* labels_arr =
      reinterpret_cast<PyArrayObject*>(labels_obj.ptr());
  CheckContiguousArray(data_arr, "data array", md_layer->channels(),
      md_layer->height(), md_layer->width());
  CheckContiguousArray(labels_arr, "labels array", 1, 1, 1);
  if (PyArray_DIMS(data_arr)[0] != PyArray_DIMS(labels_arr)[0]) 
    throw std::runtime_error("data and labels must have the same first"
        " dimension");
  
  if (PyArray_DIMS(data_arr)[0] % md_layer->batch_size() != 0) 
    throw std::runtime_error("first dimensions of input arrays must be a"
        " multiple of batch size");
  

  md_layer->Reset(static_cast<Dtype*>(PyArray_DATA(data_arr)),
      static_cast<Dtype*>(PyArray_DATA(labels_arr)),
      PyArray_DIMS(data_arr)[0]);


Solver<Dtype>* GetSolverFromFile(const string& filename) 
  SolverParameter param;
  ReadSolverParamsFromTextFileOrDie(filename, ¶m);
  return SolverRegistry<Dtype>::CreateSolver(param);


struct NdarrayConverterGenerator 
  template <typename T> struct apply;
;

template <>
struct NdarrayConverterGenerator::apply<Dtype*> 
  struct type 
    PyObject* operator() (Dtype* data) const 
      // Just store the data pointer, and add the shape information in postcall.
      return PyArray_SimpleNewFromData(0, NULL, NPY_DTYPE, data);
    
    const PyTypeObject* get_pytype() 
      return &PyArray_Type;
    
  ;
;

struct NdarrayCallPolicies : public bp::default_call_policies 
  typedef NdarrayConverterGenerator result_converter;
  PyObject* postcall(PyObject* pyargs, PyObject* result) 
    bp::object pyblob = bp::extract<bp::tuple>(pyargs)()[0];
    shared_ptr<Blob<Dtype> > blob =
      bp::extract<shared_ptr<Blob<Dtype> > >(pyblob);
    // Free the temporary pointer-holding array, and construct a new one with
    // the shape information from the blob.
    void* data = PyArray_DATA(reinterpret_cast<PyArrayObject*>(result));
    Py_DECREF(result);
    const int num_axes = blob->num_axes();
    vector<npy_intp> dims(blob->shape().begin(), blob->shape().end());
    PyObject *arr_obj = PyArray_SimpleNewFromData(num_axes, dims.data(),
                                                  NPY_FLOAT32, data);
    // SetBaseObject steals a ref, so we need to INCREF.
    Py_INCREF(pyblob.ptr());
    PyArray_SetBaseObject(reinterpret_cast<PyArrayObject*>(arr_obj),
        pyblob.ptr());
    return arr_obj;
  
;

bp::object Blob_Reshape(bp::tuple args, bp::dict kwargs) 
  if (bp::len(kwargs) > 0) 
    throw std::runtime_error("Blob.reshape takes no kwargs");
  
  Blob<Dtype>* self = bp::extract<Blob<Dtype>*>(args[0]);
  vector<int> shape(bp::len(args) - 1);
  for (int i = 1; i < bp::len(args); ++i) 
    shape[i - 1] = bp::extract<int>(args[i]);
  
  self->Reshape(shape);
  // We need to explicitly return None to use bp::raw_function.
  return bp::object();


bp::object BlobVec_add_blob(bp::tuple args, bp::dict kwargs) 
  if (bp::len(kwargs) > 0) 
    throw std::runtime_error("BlobVec.add_blob takes no kwargs");
  
  typedef vector<shared_ptr<Blob<Dtype> > > BlobVec;
  BlobVec* self = bp::extract<BlobVec*>(args[0]);
  vector<int> shape(bp::len(args) - 1);
  for (int i = 1; i < bp::len(args); ++i) 
    shape[i - 1] = bp::extract<int>(args[i]);
  
  self->push_back(shared_ptr<Blob<Dtype> >(new Blob<Dtype>(shape)));
  // We need to explicitly return None to use bp::raw_function.
  return bp::object();


BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(SolveOverloads, Solve, 0, 1);

BOOST_PYTHON_MODULE(_caffe)  //给封装的C++模块命名，名称就是_caffe，所以后面编译生成的共享库就是_caffe.so
  // below, we prepend an underscore to methods that will be replaced
  // in Python

  bp::scope().attr("__version__") = AS_STRING(CAFFE_VERSION);

  // Caffe utility functions //这里使用def封装python中可以调用的C++函数
  bp::def("set_mode_cpu", &set_mode_cpu);
  bp::def("set_mode_gpu", &set_mode_gpu);
  bp::def("set_device", &Caffe::SetDevice);
  bp::def("set_random_seed", &Caffe::set_random_seed);

  bp::def("layer_type_list", &LayerRegistry<Dtype>::LayerTypeList);

  bp::enum_<Phase>("Phase") //这里封装枚举类型Phase
    .value("TRAIN", caffe::TRAIN)
    .value("TEST", caffe::TEST)
    .export_values();

  //封装类Net，添加了构造函数、成员函数、成员变量
  bp::class_<Net<Dtype>, shared_ptr<Net<Dtype> >, boost::noncopyable >("Net",
    bp::no_init)
    .def("__init__", bp::make_constructor(&Net_Init))
    .def("__init__", bp::make_constructor(&Net_Init_Load))
    .def("_forward", &Net<Dtype>::ForwardFromTo)
    .def("_backward", &Net<Dtype>::BackwardFromTo)
    .def("reshape", &Net<Dtype>::Reshape)
    // The cast is to select a particular overload.
    .def("copy_from", static_cast<void (Net<Dtype>::*)(const string)>(
        &Net<Dtype>::CopyTrainedLayersFrom))
    .def("share_with", &Net<Dtype>::ShareTrainedLayersWith)
    .add_property("_blob_loss_weights", bp::make_function(
        &Net<Dtype>::blob_loss_weights, bp::return_internal_reference<>()))
    .def("_bottom_ids", bp::make_function(&Net<Dtype>::bottom_ids,
        bp::return_value_policy<bp::copy_const_reference>()))
    .def("_top_ids", bp::make_function(&Net<Dtype>::top_ids,
        bp::return_value_policy<bp::copy_const_reference>()))
    .add_property("_blobs", bp::make_function(&Net<Dtype>::blobs,
        bp::return_internal_reference<>()))
    .add_property("layers", bp::make_function(&Net<Dtype>::layers,
        bp::return_internal_reference<>()))
    .add_property("_blob_names", bp::make_function(&Net<Dtype>::blob_names,
        bp::return_value_policy<bp::copy_const_reference>()))
    .add_property("_layer_names", bp::make_function(&Net<Dtype>::layer_names,
        bp::return_value_policy<bp::copy_const_reference>()))
    .add_property("_inputs", bp::make_function(&Net<Dtype>::input_blob_indices,
        bp::return_value_policy<bp::copy_const_reference>()))
    .add_property("_outputs",
        bp::make_function(&Net<Dtype>::output_blob_indices,
        bp::return_value_policy<bp::copy_const_reference>()))
    .def("_set_input_arrays", &Net_SetInputArrays,
        bp::with_custodian_and_ward<1, 2, bp::with_custodian_and_ward<1, 3> >())
    .def("save", &Net_Save);

  //封装类Blob
  bp::class_<Blob<Dtype>, shared_ptr<Blob<Dtype> >, boost::noncopyable>(
    "Blob", bp::no_init)
    .add_property("shape",
        bp::make_function(
            static_cast<const vector<int>& (Blob<Dtype>::*)() const>(
                &Blob<Dtype>::shape),
            bp::return_value_policy<bp::copy_const_reference>()))
    .add_property("num",      &Blob<Dtype>::num)
    .add_property("channels", &Blob<Dtype>::channels)
    .add_property("height",   &Blob<Dtype>::height)
    .add_property("width",    &Blob<Dtype>::width)
    .add_property("count",    static_cast<int (Blob<Dtype>::*)() const>(
        &Blob<Dtype>::count))
    .def("reshape",           bp::raw_function(&Blob_Reshape))
    .add_property("data",     bp::make_function(&Blob<Dtype>::mutable_cpu_data,
          NdarrayCallPolicies()))
    .add_property("diff",     bp::make_function(&Blob<Dtype>::mutable_cpu_diff,
          NdarrayCallPolicies()));

  //封装类：layer
  bp::class_<Layer<Dtype>, shared_ptr<PythonLayer<Dtype> >,
    boost::noncopyable>("Layer", bp::init<const LayerParameter&>())
    .add_property("blobs", bp::make_function(&Layer<Dtype>::blobs,
          bp::return_internal_reference<>()))
    .def("setup", &Layer<Dtype>::LayerSetUp)
    .def("reshape", &Layer<Dtype>::Reshape)
    .add_property("phase", bp::make_function(&Layer<Dtype>::phase))
    .add_property("type", bp::make_function(&Layer<Dtype>::type));
  bp::register_ptr_to_python<shared_ptr<Layer<Dtype> > >();

  bp::class_<LayerParameter>("LayerParameter", bp::no_init);

  //封装类solver
  bp::class_<Solver<Dtype>, shared_ptr<Solver<Dtype> >, boost::noncopyable>(
    "Solver", bp::no_init)
    .add_property("net", &Solver<Dtype>::net)
    .add_property("test_nets", bp::make_function(&Solver<Dtype>::test_nets,
          bp::return_internal_reference<>()))
    .add_property("iter", &Solver<Dtype>::iter)
    .def("solve", static_cast<void (Solver<Dtype>::*)(const char*)>(
          &Solver<Dtype>::Solve), SolveOverloads())
    .def("step", &Solver<Dtype>::Step)
    .def("restore", &Solver<Dtype>::Restore)
    .def("snapshot", &Solver<Dtype>::Snapshot);

  //封装类SGDSolver，并且该类是Solver的派生类,所以上面封装的Solver的函数和property在该类中也可以调用
  bp::class_<SGDSolver<Dtype>, bp::bases<Solver<Dtype> >,
    shared_ptr<SGDSolver<Dtype> >, boost::noncopyable>(
        "SGDSolver", bp::init<string>());
  bp::class_<NesterovSolver<Dtype>, bp::bases<Solver<Dtype> >,
    shared_ptr<NesterovSolver<Dtype> >, boost::noncopyable>(
        "NesterovSolver", bp::init<string>());
  bp::class_<AdaGradSolver<Dtype>, bp::bases<Solver<Dtype> >,
    shared_ptr<AdaGradSolver<Dtype> >, boost::noncopyable>(
        "AdaGradSolver", bp::init<string>());
  bp::class_<RMSPropSolver<Dtype>, bp::bases<Solver<Dtype> >,
    shared_ptr<RMSPropSolver<Dtype> >, boost::noncopyable>(
        "RMSPropSolver", bp::init<string>());
  bp::class_<AdaDeltaSolver<Dtype>, bp::bases<Solver<Dtype> >,
    shared_ptr<AdaDeltaSolver<Dtype> >, boost::noncopyable>(
        "AdaDeltaSolver", bp::init<string>());
  bp::class_<AdamSolver<Dtype>, bp::bases<Solver<Dtype> >,
    shared_ptr<AdamSolver<Dtype> >, boost::noncopyable>(
        "AdamSolver", bp::init<string>());

  bp::def("get_solver", &GetSolverFromFile,
      bp::return_value_policy<bp::manage_new_object>());

  //作者把用到的各种vector类型封装了
  // vector wrappers for all the vector types we use
  bp::class_<vector<shared_ptr<Blob<Dtype> > > >("BlobVec")
    .def(bp::vector_indexing_suite<vector<shared_ptr<Blob<Dtype> > >, true>())
    .def("add_blob", bp::raw_function(&BlobVec_add_blob));
  bp::class_<vector<Blob<Dtype>*> >("RawBlobVec")
    .def(bp::vector_indexing_suite<vector<Blob<Dtype>*>, true>());
  bp::class_<vector<shared_ptr<Layer<Dtype> > > >("LayerVec")
    .def(bp::vector_indexing_suite<vector<shared_ptr<Layer<Dtype> > >, true>());
  bp::class_<vector<string> >("StringVec")
    .def(bp::vector_indexing_suite<vector<string> >());
  bp::class_<vector<int> >("IntVec")
    .def(bp::vector_indexing_suite<vector<int> >());
  bp::class_<vector<Dtype> >("DtypeVec")
    .def(bp::vector_indexing_suite<vector<Dtype> >());
  bp::class_<vector<shared_ptr<Net<Dtype> > > >("NetVec")
    .def(bp::vector_indexing_suite<vector<shared_ptr<Net<Dtype> > >, true>());
  bp::class_<vector<bool> >("BoolVec")
    .def(bp::vector_indexing_suite<vector<bool> >());

  // boost python expects a void (missing) return value, while import_array
  // returns NULL for python3. import_array1() forces a void return value.
  import_array1();


  // namespace caffe