Python调用C,python call c,pybind11

---

前言

通过https://github.com/pybind/pybind11项目实现Python调用C/C++代码

---

实现步骤

1.将pybind11 clone至当前项目下的extern目录下

git clone https://github.com/pybind/pybind11.git

2.在CmakeLists.txt中将pybind11项目包含

cmake_minimum_required(VERSION 3.10)

project(python_call_c)

# set(PYTHON_EXECUTABLE "/usr/bin/python3")
# set(PYTHON_INCLUDE_DIRECTORY "/usr/include/python3.10")

add_subdirectory(extern/pybind11)

pybind11_add_module(UserPythonModule test.cpp)

其中pybind11_add_module是由pybind11库提供的cmake宏，必须将pybind11项目包含后才会包含该宏。
UserPythonModule为Python导入模块的名字，test.cpp: 这是包含要绑定到 Python 的 C++ 代码的源文件

3.接口cpp文件格式

#include "extern/pybind11/include/pybind11/pybind11.h"

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

PYBIND11_MODULE(UserPythonModule/* python module name */, m/*variable*/)
{
    m.doc() = "jslkdjf";    // optional module docstring
    // 定义模块内的函数
    m.def("add"/*module function name*/, &add/*bind with c func*/, "Afun"/*fun docstring*/);
}

第一行为导入的pybind11的头文件

• PYBIND11_MODULE：头文件宏
• m：参数，代表这个模块
• m.doc(): 模块的docstring
• m.def: 在模块内定义一个函数
  • “add”：函数名
  • &add：绑定到C的函数指针
  • function的docstring

4.编译

编译项目，在编译时可能会包找不到头文件<Python.h>，意味着编译器无法找到Python开发库的头文件。需要安装Python开发库

apt-get install python3-dev

编译：

mkdir build
cd build
cmake ..
make

编译好后会有一个名为UserPythonModule.cpython-310-x86_64-linux-gnu.so的库文件

5.导入Python使用

import UserPythonModule
UserPythonModule.add(4, 6)

6.性能比较

import UserPythonModule

import time

# 记录开始时间
start_time = time.time()

# 执行你的代码段
# 例如：
sum = 0
for i in range(10000000):
    sum += i

# 记录结束时间
end_time = time.time()

# 计算执行时间
execution_time = end_time - start_time

print("python 执行结果为：", sum, " 代码执行时间为：", execution_time, "秒")
print("-----------------")

start_time = time.time()
sum = UserPythonModule.add(10000000-1)
end_time = time.time()
execution_time = end_time - start_time
print("call C 执行结果为：", sum, " 代码执行时间为：", execution_time, "秒")

out:

python 执行结果为： 49999995000000  代码执行时间为： 0.4630615711212158 秒
-----------------
call C 执行结果为： 49999995000000  代码执行时间为： 0.006102561950683594 秒

pybind11项目地址

https://github.com/pybind/pybind11