Ubuntu18.04 下使用 Pybind11实现 C++ 调用 Python 函数和类的示例

news2024/10/2 17:17:07

Pybind11 是一个轻量级的库，它提供了在 C++ 中无缝集成 Python 代码的能力。使用 Pybind11，你可以很容易地从 C++ 调用 Python 代码，反之亦然。下面我将通过一个简单的例子来展示如何在 Ubuntu 系统上使用 Pybind11 从 C++ 调用 Python 接口。

安装 Pybind11

首先，确保你的系统已经安装了 Python 和 C++ 编译器。接下来，你可以通过 pip 安装 Pybind11：

pip3 install pybind11

或者，你可以从源代码安装 Pybind11，如果你需要更高级的自定义选项（推荐）：

git clone https://github.com/pybind/pybind11.git
cd pybind11
mkdir build
cd build
cmake ..
make check -j 4
sudo make install

报错！！！

解决办法：

pip3 install pytest

安装在标准路径：

示例1：C++ 调用 Python 函数

假设我们有一个 Python 脚本 add_numbers.py，它包含一个简单的函数，如下所示：

add_numbers.py

def add_numbers(a, b):
    return a + b

CMakeLists.txt

# 设置 CMake 的最低版本要求和项目名称
cmake_minimum_required(VERSION 3.10)
# 项目名称可以被用作变量等多种用途。
project(test)

# 这行命令让 CMake 寻找 Python 3.6 版本（或更高）的库。REQUIRED 表示这个包是必需的；如果找不到，CMake 会报错。
find_package(PythonLibs 3.6 REQUIRED)
# 这行命令让 CMake 寻找 Pybind11 库。同样地，REQUIRED 表示 Pybind11 是构建此项目所必需的。
find_package(pybind11 REQUIRED )

# 这个命令用于向项目添加头文件搜索路径。
# 这里，${PYTHON_INCLUDE_DIRS} 和 ${pybind11_INCLUDE_DIRS} 是由 find_package 命令找到的 Python 和 Pybind11 的头文件目录。
# 这确保了编译器可以找到所有必需的头文件。
include_directories(${PYTHON_INCLUDE_DIRS})
include_directories(${pybind11_INCLUDE_DIRS})

# 这行命令定义了一个名为 test 的可执行文件，它将从 main.cpp 源文件构建而成。
add_executable(test main.cpp)

# 指定了构建可执行文件 test 时需要链接的库。
# ${PYTHON_LIBRARIES} 是 find_package(PythonLibs) 命令找到的 Python 库，
# 而 pybind11::pybind11 是 Pybind11 提供的目标，用于链接 Pybind11 库。这确保了项目在链接时能找到所有必要的库。
target_link_libraries(test ${PYTHON_LIBRARIES} pybind11::pybind11)

main.cpp

// pybind11/pybind11.h：这是 Pybind11 的主要头文件，提供了大部分 Pybind11 功能。
#include <pybind11/pybind11.h>
// pybind11/embed.h：这个头文件提供了嵌入 Python 解释器到 C++ 应用中所需的功能。这意味着你可以在 C++ 程序中启动和使用 Python 解释器。
#include <pybind11/embed.h>
#include <iostream>

// 创建了一个别名 py，代表 pybind11 命名空间，使得后续可以通过 py 来访问 pybind11 的各种功能。
namespace py = pybind11;
using namespace std;

int main() {

    // 这里创建了一个 scoped_interpreter 实例。这个对象的生命周期控制着 Python 解释器的启动和关闭。
    // 当 guard 被创建时，Python 解释器启动；当 guard 的生命周期结束时（函数返回时），Python 解释器关闭。
    py::scoped_interpreter guard{};

    // 这几行代码导入了 Python 的 sys 模块，并使用 sys.path.append 方法添加了一个目录到 Python 的模块搜索路径中。
    // 这样，Pybind11 就可以找到并导入位于 /home/fairlee/Programs 目录下的 Python 脚本。
    py::module_ sys = py::module_::import("sys");
    sys.attr("path").attr("append")("/home/fairlee/Programs");

    // 上面的代码导入了名为 hello 的 Python 模块（假设这个模块位于之前添加到 sys.path 的目录中）。
    // 然后，它调用了 hello 模块中的 add_numbers 函数，传入两个参数（9 和 3.14），并将返回的结果转换为 double 类型。
    // 这里使用了 Pybind11 的 attr 方法来访问和调用 Python 中的属性和方法。
    py::module_ calc = py::module_::import("hello");
    auto result = calc.attr("add_numbers")(9, 3.14).cast<double>();

    // 最后，使用标准输出将结果打印到控制台。这里的 result 就是从 Python 函数 add_numbers 返回的结果。
    std::cout << "The result is: " << result << std::endl;

    return 0;
}

编译成功后，你可以运行生成的可执行文件。C++ 程序将调用 Python 脚本中定义的加法函数，计算并打印出 9 + 3.14 的结果。