C++漫谈：为C++实现的功能提供Python API接口-Pybind11

Cpp

兴趣与业余时间开发的CVTK项目，除了继续完善和添加算法到CVTK外，还计划提供Python API，便于Python调用。在为CVTK添加Python API支持的过程中，调研了下C++/Python绑定库的情况。目前支持C++/Python绑定库，比较主流的有四大流行库，分别是：

关于Pybind11、Boost.Python、Cython、SWIG（Faiss的Python接口，是用SWIG桥接的）这4个库对Cpp的支持与对比情况，可以详阅如何选择 Python与C++ 之间的胶水。这里主要记录下自己在用Pybind11为CVTK桥接Python API的过程。如果工作中碰到类似需求，可以考虑用PyBind11或者上面提到的其他三个库。

效果

在pypi.org上发布CVTK Python包，可以通过项目主页cvtk-release的说明进行安装，目前完成CVTK Cpp与Python之间的桥接，Cpp实现的功能会逐步提供对应的Python接口。

CVTK提供Python API的开发功能，会先发布在cvtk-pypi进行测试，如果测试没问题了，最终会同步到CVTK上。

drawing

Pybind11桥接Cpp与Python

假设在CVTK中实现了某一个功能，举个简单的例子，比如实现了一个相加的功能，那通过Pybind11为这个函数提供Python接口时，可以这样：

#include <pybind11/pybind11.h>

#define STRINGIFY(x) #x
#define MACRO_STRINGIFY(x) STRINGIFY(x)

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

namespace py = pybind11;

PYBIND11_MODULE(cvtk, m) {
    m.doc() = R"pbdoc(
        Pybind11 example plugin
        -----------------------
        .. currentmodule:: cmake_example
        .. autosummary::
           :toctree: _generate
           add
           subtract
    )pbdoc";

    m.def("add", &add, R"pbdoc(
        Add two numbers
        Some other explanation about the add function.
    )pbdoc");

    m.def("subtract", [](int i, int j) { return i - j; }, R"pbdoc(
        Subtract two numbers
        Some other explanation about the subtract function.
    )pbdoc");

#ifdef VERSION_INFO
    m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO);
#else
    m.attr("__version__") = "dev";
#endif
}