使用Python和Pybind11调用C++程序(CMake编译)

目录

一、前言

跨语言调用能对不同计算机语言进行互补,本博客主要介绍如何实现Python调用C++语言编写的函数。

实验环境:

  • Linux gnu
  • Python==3.10
  • CMake
  • C++11

首先,使用官网提供的说明对pybind11进行基本的介绍,具体内容如下:

pybind11 是一个轻量级的头文件库,用于在 Python 和 C++ 之间互相暴露类型,主要用于为现有的 C++ 代码创建 Python 绑定。它的目标和语法类似于 David Abrahams 开发的出色 Boost.Python 库:通过使用编译时内省来推断类型信息,最小化传统扩展模块中的样板代码。
Boost.Python 的主要问题在于其所属的 Boost 套件。Boost 是一个巨大的、复杂的实用程序库集合,几乎可以与所有现存的 C++ 编译器一起工作。这种兼容性是有代价的:为了支持最古老和最有问题的编译器样本,必须使用神秘的模板技巧和变通方法。现在,由于广泛可用的兼容 C++11 的编译器,这种重型机制已经变成了一个过大且不必要的依赖项。
将这个库视为 Boost.Python 的一个微型自包含版本,其中剥离了与绑定生成无关的所有内容。没有注释的核心头文件只需约 4K 行代码,并依赖于 Python(3.7+ 或 PyPy)和 C++ 标准库。这种紧凑的实现得益于一些 C++11 语言特性(特别是:元组、lambda 函数和可变参数模板)。自从该库创建以来,它在许多方面已经超越了 Boost.Python,导致在许多常见情况下绑定代码大大简化。

本博客主要介绍现在主流的Pybind11实现Python调用C++程序。

二、安装 pybind11

克隆pybind11工程项目文件,在终端输入命令如下:

shell 复制代码
git clone https://github.com/pybind/pybind11.git

安装依赖包pytest,用于pybind11示例测试,在终端输入命令如下:

shell 复制代码
pip install pytest

编译pybind11并进行安装,依次输入命令如下:

shell 复制代码
cd pybind11
mkdir build
cd build
cmake ..
cmake --build . --config Release --target check -j4
make install 

三、编写C++示例代码

编写一个C++示例代码,用于进行简单的除法计算。后续使用python语言进行调用,C++示例代码具体内容如下:

说明:需要在原来编写的C++代码(文件名称为test_strategy.cpp)上增加<pybind11/pybind11.h><pybind11/stl.h>两个库,同时要多定义一个空间变量namespace py = pybind11,最后需要进行pybind11模块的实例化,即用"test"属性调用test函数。

cpp 复制代码
#include <iostream>
#include <stddef.h>
#include <stdio.h>  // This ert_main.c example uses printf/fflush
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
namespace py = pybind11;
using namespace std;


float test(float a, float b);
float test(float a, float b)
{	
	return a / b;
}

// instantiation
PYBIND11_MODULE(test_strategy, m) {
    m.def("test", &test);
}

四、结合Pybind11和CMake编译C++工程

在准备好C++代码后,接下来就需要编写CMakeLists.txt文件,引导CMake编译上一节的C++工程,具体内容如下:

shell 复制代码
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)

# 项目信息 项目名称和使用的C++标准
project (test_strategy)
set(CMAKE_CXX_FLAGS "-std=c++11")

# 执行文件输出路径,这里需要改成调用该函数的python环境
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR})
set(PYTHON EXECUTABLE "~/anaconda3/bin/python")

# 头文件和源文件保存路径
#set(INCLUDE_DIR ./include)
set(SRC_DIR ../)
find_package(pybind11 REQUIRED)
include_directories(${pybind11_INCLUDE_DIRS})

# 链接python的库文件
link_directories(~/anaconda3/lib)  

# 将python头文件包含进来
INCLUDE_DIRECTORIES(~/anaconda3/include/python3.10)

# 链接到python动态库文件
link_libraries(~/anaconda3/pkgs/python-3.10.9-h89984f6_1/lib/libpython3.10.so)

#include_directories(${INCLUDE_DIR})
file(GLOB_RECURSE SOURCES "${SRC_DIR}/test_strategy.cpp")

Pybind11_add_module(${PROJECT_NAME} ${SRC_DIR}/test_strategy.cpp ${SOURCES})

然后,在终端中依次输入如下命令进行CMake编译:

cpp 复制代码
mkdir build 
cd build
cmake ..
make 
cp ../test_strategy.cpython-310-arrach64-linux-gnu.so

最后,得到该python环境下对应的动态库文件,具体文件名如下所示:

五、Python调用动态库

编写一个python脚本文件调用test_strategy动态库,具体内容如下所示:

python 复制代码
from test_strategy import test
res = test(1, 2)
print("1 / 2 =", res)

运行上述代码对应的py脚本,测试结果输出如下所示:

六、参考

[1] https://pybind11.readthedocs.io/en/stable/index.html

[2] https://www.cnblogs.com/lidabo/p/16625524.html

相关推荐
凡解几秒前
[自动化测试:实践01]:2:(4-1 )元素定位(selenium)在实际场景中的应用2
自动化测试·python·selenium·测试工具
wjs20249 分钟前
CentOS Docker 安装
开发语言
深思慎考12 分钟前
计算机操作系统——进程控制(Linux)
linux·服务器·c++·c
卖个几把萌14 分钟前
【04】Selenium+Python 手动添加Cookie免登录(实例)
python·selenium·测试工具
数学人学c语言17 分钟前
yolov11剪枝
pytorch·python·深度学习
今天又是学习20 分钟前
深度学习5
人工智能·深度学习
海阔天空_201320 分钟前
浏览器自动化库playwright简介
网络·python·自动化
兔子的洋葱圈24 分钟前
Python的3D可视化库 - vedo (3)visual子模块 点对象的可视化控制
python·数据可视化
捕鲸叉30 分钟前
C++设计模式之组合模式实践原则
c++·设计模式·组合模式
新加坡内哥谈技术31 分钟前
RAG架构类型
大数据·人工智能·语言模型·chatgpt