pybind11: C++ 工程提供 Python 接口的实例代码

Pybind11是一个强大的工具，它使得C++代码能够轻松地与Python进行交互，从而将C++的强大性能和Python的易用性结合在一起。本文主要介绍如何使用pybind11来为C++工程构建Python接口。 pybind11是一个header-only库，这意味着你不需要单独编译库文件，只需在C++项目中包含相应的头文件即可开始使用。这大大简化了集成过程。 在CMake中引入pybind11，你需要在`CMakeLists.txt`文件中添加库的路径并调用`pybind11_add_module`来创建模块。例如，如果你将pybind11源码放在`third_party/pybind11-2.5.0`目录下，你可以这样操作： ```cmake cmake_minimum_required(VERSION 3.1) project(start-pybind11 VERSION 0.1.0 LANGUAGES C CXX) set(MY_PYBIND ${MY_CURR}/third_party/pybind11-2.5.0) add_subdirectory(${MY_PYBIND}) pybind11_add_module(example_pb example_pb.cpp) ``` 一旦CMake配置完成，你就可以开始编写Python接口的C++代码了。例如，如果你有一个名为`add`的函数，可以这样绑定： ```cpp #include <pybind11/pybind11.h> int add(int i, int j) { return i + j; } PYBIND11_MODULE(example_pb, m) { m.doc() = "example_pb bindings"; m.def("add", &add, "A function which adds two numbers"); } ``` 这段代码会在Python中提供一个名为`add`的函数，接受两个整数并返回它们的和。 除了函数，你还可以绑定C++类到Python。假设你有一个`Tick`类，用于定时触发事件，可以这样做： ```cpp #include <pybind11/pybind11.h> #include "tick.h" // 定义Tick类 PYBIND11_MODULE(example_pb, m) { m.doc() = "example_pb bindings"; py::class_<Tick>(m, "Tick") .def(py::init<int, int>()) .def("SetTickEvent", &Tick::SetTickEvent) .def("Start", &Tick::Start) .def("Stop", &Tick::Stop) .def("WaitLifeOver", &Tick::WaitLifeOver); } ``` 在这个例子中，`Tick`类的所有成员函数都被暴露给了Python，允许Python代码创建、配置和控制`Tick`对象。 完成这些步骤后，通过CMake构建项目，你会得到一个Python模块，可以在Python环境中导入和使用。例如，对于`example_pb`模块，你可以这样在Python中调用： ```python import example_pb print(example_pb.add(2, 3)) # 输出：5 tick = example_pb.Tick(500, 5000) tick.SetTickEvent(lambda elapsed_ms: print(f"elapsed: {elapsed_ms} ms")) tick.Start() ``` 这样，C++的功能就无缝地融入到了Python环境中，使得C++代码可以作为Python的扩展库使用。 pybind11通过简洁的API和无需额外编译的特性，极大地简化了C++与Python之间的互操作性。无论是为现有的C++库添加Python接口，还是构建新的跨语言项目，pybind11都是一个理想的选择。