pybind11: C++ 工程提供 Python 接口的实例代码

2023-07-17 06:27:03 78

C/C++工程提供Python接口，有利于融合进Python的生态。现在Python在应用层，有其得天独厚的优势。尤其因为人工智能和大数据的推波助澜，Python现在以及未来，将长期是最流行的语言之一。

那C/C++怎么提供Python接口呢？

ctypes:C与Python绑定，Python内建模块
Boost.Python:C++与Python绑定，Boost模块
pybind11:C++11与Python绑定，减去了旧C++支持，更轻量化

本文将介绍pybind11的环境准备与入门使用。

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

环境准备

pybind11是一个header-only的库，换句话说，只需要C++项目里直接includepybind11的头文件就能使用。

这里则介绍如何于CMake里引入pybind11。而更多编译系统的介绍，可见官方文档Buildsystems。

获取pybind11

可以gitsubmodule添加子模块，最好固定为某个版本：

gitsubmoduleaddhttps://github.com/pybind/pybind11.gitthird_party/pybind11-2.5.0
cdthird_party/pybind11-2.5.0/
gitcheckouttags/v2.5.0

或者，直接获取源码，放进相应子目录即可。

添加进CMake

CMakeLists.txt里add_subdirectorypybind11的路径，再用其提供的pybind11_add_module就能创建pybind11的模块了。

cmake_minimum_required(VERSION3.1)
project(start-pybind11VERSION0.1.0LANGUAGESCCXX)

set(MY_PYBIND${MY_CURR}/third_party/pybind11-2.5.0)

add_subdirectory(${MY_PYBIND})
pybind11_add_module(example_pbexample_pb.cpp)

如果想在已有C++动态库上扩展pybind11绑定，那么target_link_libraries链接该动态库就可以了。

target_link_libraries(example_pbPUBLICexample)

绑定一个函数

我们先实现一个add函数，

intadd(inti,intj){
returni+j;
}

为了简化工程，可以直接实现在example_pb.cpp里，

#include

namespacepy=pybind11;

intadd(inti,intj){
returni+j;
}

PYBIND11_MODULE(example_pb,m){
m.doc()="example_pbbindings";

m.def("add",&add,"Afunctionwhichaddstwonumbers");
}

之后，于CMakeLists.txt所在目录，执行cmake编译就完成了。

示例代码

first_steps.h
first_steps.cc
first_steps_pb.cc

绑定一个类

我们先实现一个定时触发器的类。使用如下：

#include

#include"tick.h"

intmain(intargc,charconst*argv[]){
(void)argc;
(void)argv;

Ticktick(500,5000);

tick.SetTickEvent([&tick](std::int64_telapsed_ms){
std::cout<<"elapsed:"<=2000){
tick.Stop();
}
});

tick.Start();
tick.WaitLifeOver();
return0;
}

运行结果：

$./_output/bin/cpp_thread_callback/tick_test
elapsed:0ms
elapsed:500ms
elapsed:1000ms
elapsed:1500ms
elapsed:2000ms

该类的声明如下：

usingTickEvent=std::function;
usingTickRunCallback=std::function;

classTick{
public:
usingclock=std::chrono::high_resolution_clock;

Tick(std::int64_ttick_ms,
std::int64_tlife_ms=std::numeric_limits::max());
Tick(TickEventtick_event,std::int64_ttick_ms,
std::int64_tlife_ms=std::numeric_limits::max(),
TickRunCallbackrun_beg=nullptr,
TickRunCallbackrun_end=nullptr);
virtual~Tick();

boolIsRunning()const;

voidStart();
voidStop(boolwait_life_over=false);

conststd::chrono::time_point&GetTimeStart()const;

voidSetTickEvent(TickEvent&&tick_event);
voidSetTickEvent(constTickEvent&tick_event);

voidSetRunBegCallback(TickRunCallback&&run_beg);
voidSetRunBegCallback(constTickRunCallback&run_beg);

voidSetRunEndCallback(TickRunCallback&&run_end);
voidSetRunEndCallback(constTickRunCallback&run_end);

voidWaitLifeOver();

protected:
//...
};

然后，pybind11绑定实现如下：

#include
#include
#include

#include

#include"cpp/cpp_thread_callback/tick.h"

namespacepy=pybind11;
usingnamespacepybind11::literals;//NOLINT

PYBIND11_MODULE(tick_pb,m){
m.doc()="tick_pbbindings";

py::class_>(m,"Tick")
.def(py::init())
.def(py::init())
.def_property_readonly("is_running",&Tick::IsRunning)
.def("start",&Tick::Start)
.def("stop",&Tick::Stop,"wait_life_over"_a=false)
.def("get_time_start",&Tick::GetTimeStart)
.def("set_tick_event",[](Tick&self,constTickEvent&tick_event){
self.SetTickEvent(tick_event);
})
.def("set_run_beg_callback",[](Tick&self,
constTickRunCallback&run_beg){
self.SetRunBegCallback(run_beg);
})
.def("set_run_end_callback",[](Tick&self,
constTickRunCallback&run_end){
self.SetRunEndCallback(run_end);
})
.def("wait_life_over",&Tick::WaitLifeOver,
py::call_guard());
}

编译出动态库后，把路径添加进PYTHONPATH：

exportPYTHONPATH=:$PYTHONPATH

#依赖其他动态库的话，把路径添加进LIBRARY_PATH
#Linux
exportLD_LIBRARY_PATH=:$LD_LIBRARY_PATH
#macOS
exportDYLD_LIBRARY_PATH=:$DYLD_LIBRARY_PATH

之后，就可以于Python里调用了：

#!/usr/bin/envpython
#-*-coding:utf-8-*-
#pylint:disable=missing-docstring,import-error
importtick_pbastick

def_main():
t=tick.Tick(lambdaelapsed_ms:print(f"elapsed:{elapsed_ms}ms"),
500,1000,
lambda:print("runbeg"),lambda:print("runend"))
t.start()
t.wait_life_over()

if__name__=="__main__":
_main()

运行结果：

$pythonsrc/pybind/cpp_thread_callback/tick_test.py
runbeg
elapsed:0ms
elapsed:500ms
elapsed:1000ms
runend

示例代码

tick.h
tick.cc
tick_test.cc
tick_pb.cc
tick_test.py

运行示例代码

获取代码，

gitclonehttps://github.com/ikuokuo/start-pybind11.git

#获取子模块
cdstart-pybind11/
gitsubmoduleupdate--init

编译安装，

#依赖cmake

cdstart-pybind11/
makeinstall

编译结果，

$tree_install
_install
├──bin
│└──cpp_thread_callback
│└──tick_test
└──lib
├──cpp_thread_callback
│├──libtick.0.1.0.dylib
│├──libtick.0.1.dylib->libtick.0.1.0.dylib
│├──libtick.dylib->libtick.0.1.dylib
│├──tick_pb.0.1.0.cpython-37m-darwin.so
│├──tick_pb.0.1.cpython-37m-darwin.so->tick_pb.0.1.0.cpython-37m-darwin.so
│└──tick_pb.cpython-37m-darwin.so->tick_pb.0.1.cpython-37m-darwin.so
└──first_steps
├──first_steps_pb.0.1.0.cpython-37m-darwin.so
├──first_steps_pb.0.1.cpython-37m-darwin.so->first_steps_pb.0.1.0.cpython-37m-darwin.so
├──first_steps_pb.cpython-37m-darwin.so->first_steps_pb.0.1.cpython-37m-darwin.so
├──libfirst_steps.0.1.0.dylib
├──libfirst_steps.0.1.dylib->libfirst_steps.0.1.0.dylib
└──libfirst_steps.dylib->libfirst_steps.0.1.dylib

5directories,13files

添加路径，

$sourcesetup.bashfirst_stepscpp_thread_callback
DYLD_LIBRARY_PATH,PYTHONPATH
+/Users/John/Workspace/Self/ikuokuo/start-pybind11/_install/lib/first_steps
+/Users/John/Workspace/Self/ikuokuo/start-pybind11/_install/lib/cpp_thread_callback

运行示例，

$pythonsrc/pybind/cpp_thread_callback/tick_test.py
runbeg
elapsed:0ms
elapsed:500ms
elapsed:1000ms
runend

结语

Gocoding!

总结

到此这篇关于pybind11:C++工程提供Python接口的文章就介绍到这了,更多相关pybind11:C++工程如何提供Python接口内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

pybind11: C++ 工程提供 Python 接口的实例代码

热门推荐

随机推荐