Python 调用 C++ 之 pybind11入门（macOS）

发表于 | 分类于 | 阅读次数：

pybind11 简介与环境安装

pybind11 是一个轻量级的只包含头文件的库，它主要是用来在已有的 C++ 代码的基础上做扩展，它的语法和目标非常像 Boost.Python，但 Boost.Python 为了兼容现有的基本所有的 C++ 编译器而变得非常复杂和庞大，而因此付出的代价是很多晦涩的模板技巧以及很多不必要的对旧版编译器的支持。Pybind11 摒弃了这些支持，它只支持 python 2.7 以上以及 C++ 11 以上的编译器，使得它比 Boost.Python 更加简洁高效。

为了使用pybind11，我们需要支持 C++ 11 标准的编译器（GCC 4.8以上）以及 python 2.7 以上的版本，还需要下载 CMake (macOS中只需要 brew install cmake )，有了这些以后：

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

最后一行命令会编译并且运行 tests，如果所有测试用例都通过了，说明安装成功了。

Python 调用C++

下载编译好 pybind11 之后，我们就可以开始对着官方的pybind11 Tutorial进行学习了，详细的入门教程及语法请参考官方文档，这里，我们简单演示下如何编写供python调用的C++模块。

首先，我们编写一个 C++ 源文件，命名为example.cpp 。

1
2
3
4
5
6
7
8
9
10
11
#include <pybind11/pybind11.h>

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

PYBIND11_MODULE(example, m) {
    m.doc() = "pybind11 example plugin"; // optional module docstring

    m.def("add", &add, "A function which adds two numbers");
}

编译

macOS下运行：

1
$ c++ -O3 -Wall -shared -std=c++11 -undefined dynamic_lookup `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix`

Linux下运行：

1
$ c++ -O3 -Wall -shared -std=c++11 -fPIC `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix`

之后会在同目录下生成 example.cpython-36m-darwin.so 文件。

当前路径下运行 python ：

1
2
3
4
5
6
7
8
$ python
Python 3.6.6 |Anaconda custom (64-bit)| (default, Jun 28 2018, 11:07:29)
[GCC 4.2.1 Compatible Clang 4.0.1 (tags/RELEASE_401/final)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import example
>>> example.add(3, 4)
7
>>>

总结

本文中我们简单介绍了怎么使用 pybind11 进行 python 对 C++ 的调用，这只是入门级别的例子，但是可以 work了，这很重要。这是研究近似最近邻算法 HNSW 源码的第一步，加油！

0%