c++通过pybind11制作模型python接口，生成python调用包

全栈工程师开发手册 （作者：栾鹏）
架构系列文章

我是在ubuntu系统进行实验的，所以和window可能会有区别。

python调用C/C++有不少的方法，如boost.python, swig, ctypes, pybind11等，这些方法有繁有简，而pybind11的优点是对C++ 11支持很好，API比较简单，现在我们就简单记下Pybind11的入门操作。

1. pybind11简介与环境安装
   =====
   pybind11是一个轻量级的只包含头文件的库，它主要是用来在已有的 C++代码的基础上做扩展，它的语法和目标非常像Boost.Python，但Boost.Python为了兼容现有的基本所有的C++编译器而变得非常复杂和庞大，而因此付出的代价是很多晦涩的模板技巧以及很多不必要的对旧版编译器的支持。Pybind11摒弃了这些支持，它只支持python2.7以上以及C++ 11以上的编译器，使得它比Boost.Python更加简洁高效。
   为了使用pybind11，我们需要支持C++ 11标准的编译器(GCC 4.8以上，VS 2015 Update 3以上)以及python 2.7以上的版本，还需要下载CMake，有了这些以后,

cmake教程可以参考：https://blog.csdn.net/luanpeng825485697/article/details/81202136

1. 首先，我们从 pybind11 github网址：https://github.com/pybind/pybind11 上下载源码。
2. cmake工程之前，要先安装pytest pip install pytest，否则会出错
3. 用CMake编译并运行测试用例：

进入pybind11的目录，
cd tests
cmake ..
cmake --build . --config Release --target check

如果所有测试用例都通过了，说明安装成功了。

2. python调用C++
   ===
   下载编译好pybind11之后，我们就可以开始对着官方的pybind11 Tutorial进行学习了，详细的入门教程及语法请参考官方文档，这里，我们简单演示下如何编写供python调用的C++模块.
   首先，我们编写一个C++源文件，命名为example.cpp

#include 
namespace py = pybind11;

int add(int i, int j)
{
    return i + j;
}

PYBIND11_MODULE(example, m)
{
    // optional module docstring
    m.doc() = "pybind11 example plugin";
    // expose add function, and add keyword arguments and default arguments
    m.def("add", &add, "A function which adds two numbers", py::arg("i")=1, py::arg("j")=2);

    // exporting variables
    m.attr("the_answer") = 42;
    py::object world = py::cast("World");
    m.attr("what") = world;
}

2.1 使用window编译

我没有实验，所以可以参考别的教程

2.2 CMake的编译方法

当然，我们也可以使用CMake进行编译。首先写一个CMakeLists.txt

cmake_minimum_required(VERSION 2.8.12)
project(example)   

add_subdirectory(pybind11)
pybind11_add_module(example example.cpp)

这里要求example.cpp放在和pybind11同一级的目录下，因为我们在CMakeLists.txt中调用了同目录pybind11和同目录的example.cpp文件。在当前目录下执行

cmake .
make

会生成example.cpython-36m-x86_64-linux-gnu.so文件。这个文件就是python可以调用的文件。还是在相同目录下运行python，进入python命令行

import example
example.add(3, 4)

[out]: 7

3、中级调用

上面是一个简单的例子，有时我们需要的功能可能很复杂。

生成模型设计库调用问题。

比如你的cpp文件中引用了其他的第三方库，这个时候我们生成的so文件，可能是需要依赖第三方库的。

本地myopencv.cpp文件

#include 
#include 
#include 
#include 
#include 

namespace py = pybind11;

void read_img(std::string img_path)
{
    cv::Mat image = cv::imread(img_path, CV_LOAD_IMAGE_COLOR);
}

PYBIND11_MODULE(myopencv, m)
{
    m.def("read_img", &read_img, "get image size");
}

CMakeLists.txt可以写成下面这样

cmake_minimum_required(VERSION 2.8.12)
project(myopencv)

add_subdirectory(pybind11)
pybind11_add_module(myopencv myopencv.cpp)

通过cmkae编译通过

cmake .
make

产生myopencv.cpython-36m-x86_64-linux-gnu.so文件
在python中调用

import myopencv

目前这里发现有问题，还没有调通。。。。。

数据类型不匹配的问题

比如opencv在python中是numpy的类型，但是在c++中cv.Mat的类型

对于opencv的类型不匹配问题，github上已经给出了解决方法，

cpp和h文件下载地址 https://github.com/edmBernard/pybind11_opencv_numpy

如何你需要什么可以去github上搜索，或者自己去实现。