C++如何与Python交互_C++使用pybind11库进行混合编程

pybind11是一个轻量级C++库,用于将C++代码无缝导出到Python。它基于C++11,语法简洁,支持函数、类、STL容器的绑定,仅需包含头文件并链接Python库。通过CMake构建后,生成的模块可在Python中直接调用,实现高效混合编程。

在现代软件开发中,C++ 和 Python 经常需要协同工作。C++ 适合高性能计算和底层操作,而 Python 擅长快速开发、数据处理和机器学习。pybind11 是一个轻量级但功能强大的库,能够将 C++ 代码暴露给 Python 使用,实现高效混合编程。

什么是 pybind11

pybind11 是一个开源的头文件库,允许 C++ 代码与 Python 无缝交互。它使用现代 C++(C++11 及以上)特性,通过简洁的语法将 C++ 类、函数、变量等导出到 Python 中。相比传统的 Boost.Python,pybind11 更轻便、编译更快,且依赖极少。

只需要包含 pybind11 的头文件,并链接 Python 库,就能编写绑定代码。

环境准备与安装

开始前需确保系统中已安装:

  • Python(建议 3.6+)
  • CMake(用于构建项目)
  • 支持 C++11 的编译器(如 g++、clang 或 MSVC)

安装 pybind11 的推荐方式:

可通过 pip 安装:

pip install pybind11

或使用 CMake 直接引入(推荐项目集成):

find_package(pybind11 REQUIRED)

如果你通过 vcpkg 或 conda 安装,也能轻松集成。

编写简单的 C++ 函数并导出

以下是一个将 C++ 函数绑定到 Python 的例子:

example.cpp

#include 

int add(int a, int b) { return a + b; }

namespace py = pybind11; PYBIND11_MODULE(example, m) { m.doc() = "pybind11 example plugin"; m.def("add", &add, "A function that adds two numbers"); }

这个模块定义了一个名为 example 的 Python 模块,其中包含一个函数 add

编译生成 Python 扩展模块

使用 CMake 编译上述代码为 Python 可导入的模块。

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(example)

find_package(pybind11 REQUIRED)

pybind11_add_module(example example.cpp)

构建步骤:

mkdir build
cd build
cmake ..
make

成功后会生成 example.cpython-xxx.so(Linux/Mac)或 example.pyd(Windows)。

在 Python 中使用:

import example
print(example.add(3, 4))  # 输出: 7

导出 C++ 类到 Python

pybind11 支持完整地将 C++ 类暴露给 Python,包括构造函数、成员函数、属性等。

#include 

class MyClass { public: MyClass(const std::string &name) : name(name) {} void set_name(const std::string &n) { name = n; } std::string get_name() const { return name; } private: std::string name; };

namespace py = pybind11; PYBIND11_MODULE(exampleclass, m) { py::class(m, "MyClass") .def(py::init()) .def("set_name", &MyClass::set_name) .def("get_name", &MyClass::get_name); }

Python 中使用:

from example_class import MyClass
obj = MyClass("Alice")
print(obj.get_name())  # 输出: Alice
obj.set_name("Bob")
print(obj.get_name())  # 输出: Bob

处理复杂类型与 STL 容器

pybind11 支持自动转换常见 STL 类型,如 vector、map 等。

只需包含额外头文件:

#include 

之后 C++ 函数中使用 std::vectorstd::map<:string int> 时,pybind11 会自动将其映射为 Python 的 list 或 dict。

示例:

std::vector get_numbers() {
    return {1, 2, 3, 4, 5};
}

PYBIND11_MODULE(example_stl, m) { m.def("get_numbers", &get_numbers); }

Python 调用返回的就是标准 list。

基本上就这些。pybind11 让 C++ 与 Python 的互操作变得直观又高效,适合性能敏感场景下的混合开发。只要写好绑定代码,Python 就能像调用原生函数一样使用 C++ 功能。不复杂但容易忽略的是编译配置和类型转换细节,建议结合官方文档逐步调试。