Pybind11 实战：让 Python 无缝调用 C++ 函数

这里的关键点：

• #include <pybind11/pybind11.h>：引入核心头文件。
• PYBIND11_MODULE(example, m)：定义一个名为 example 的 Python 模块，m 是模块对象。
• m.def：将 C++ 的 add 函数绑定到 Python，指定名称、参数名及描述信息。

编译成模块

创建 setup.py 文件来配置构建过程：

from setuptools import setup
from pybind11.setup_helpers import Pybind11Extension

ext_modules = [
    Pybind11Extension(
        "example",
        ["example.cpp"],
    ),
]

setup(
    name="example",
    ext_modules=ext_modules,
)

在命令行执行以下命令进行编译：

python setup.py build_ext --inplace

成功后会在当前目录生成 example.xxx.pyd（Windows）或 example.xxx.so（Linux/Mac）文件。

在 Python 中测试

现在可以像导入普通库一样使用它：

import example
print(example.add(3, 4))      # 输出 7
print(example.__doc__)        # 输出 '一个简单的加法模块'

Pybind11 将 C++ 代码编译成了 Python 的扩展模块，就像把 C++ 的'快车'装进 Python 的'车库'，随时开出来用。

进阶玩法：玩转数据和功能

1. 绑定带默认参数的函数

C++ 中的默认参数可以直接传递给 Python：

#include <pybind11/pybind11.h>

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

PYBIND11_MODULE(example, m) {
    m.def("add", &add, "加两个数", pybind11::arg("a"), pybind11::arg("b") = 10);
}

重新编译后，Python 端调用如下：

import example
print(example.add(5))         # 输出 15 (5 + 10)
print(example.add(5, 3))      # 输出 8 (5 + 3)

2. 处理 Python 列表

C++ 可以接收并处理 Python 传入的列表：

#include <pybind11/pybind11.h>
#include <vector>

std::vector<int> double_list(std::vector<int> lst) {
    for (int& x : lst) x *= 2;
    return lst;
}

PYBIND11_MODULE(example, m) {
    m.def("double_list", &double_list, "把列表每个数翻倍");
}

编译后的效果：

import example
print(example.double_list([1, 2, 3]))  # 输出 [2, 4, 6]

3. 绑定类

定义一个 C++ 类供 Python 实例化：

#include <pybind11/pybind11.h>

class Pet {
public:
    Pet(const std::string& name) : name(name) {}
    void setName(const std::string& new_name) { name = new_name; }
    std::string getName() const { return name; }
private:
    std::string name;
};

PYBIND11_MODULE(example, m) {
    pybind11::class_<Pet>(m, "Pet")
        .def(pybind11::init<const std::string&>())  // 构造函数
        .def("setName", &Pet::setName)              // 方法
        .def("getName", &Pet::getName);             // 方法
}

Python 调用示例：

import example
p = example.Pet("小狗")
print(p.getName())       # 输出 '小狗'
p.setName("小猫")
print(p.getName())       # 输出 '小猫'

优化与调试

提速

Pybind11 默认性能已经不错，但可以通过 C++ 优化编译选项进一步提升：

python setup.py build_ext --inplace -DCMAKE_CXX_FLAGS="-O3"

调试

遇到编译错误时，添加 --verbose 查看详细日志：

python setup.py build_ext --inplace --verbose

实战练习

尝试完成以下任务：

1. 新建 math_ops.cpp：

#include <pybind11/pybind11.h>

int multiply(int a, int b = 2) {
    return a * b;
}

PYBIND11_MODULE(math_ops, m) {
    m.def("multiply", &multiply, "乘法", pybind11::arg("a"), pybind11::arg("b") = 2);
}

2. 使用 Pybind11 编译成模块。
3. 在 Python 中测试：

import math_ops
print(math_ops.multiply(5))     # 输出 10
print(math_ops.multiply(5, 3))  # 输出 15

注意事项

• 编译环境：确保 C++ 编译器版本匹配（如 MSVC 2019+）。
• 依赖问题：如果使用了其他 C++ 库，需在 setup.py 中添加 libraries=["库名"]。
• 跨平台：编译出的模块只能在同系统使用，更换操作系统需重新编译。

总结

• 基础绑定：用 m.def 将 C++ 函数暴露给 Python。
• 高级用法：支持类绑定（pybind11::class_）、容器处理（std::vector）。
• 优化调试：调整编译选项提速，利用 --verbose 排查问题。
• 打包发布：配合 setup.py 生成标准模块，导入即用。

通过这个流程，你应该能轻松用 Pybind11 把 C++ 的'超能力'带到 Python 里，像搭积木一样简单。