初探pybind11——Python调用C++函数

本文使用Anaconda环境进行演示,python版本为3.8,若读者不使用Anaconda,需自行配置环境。

Pybind11是一个纯头文件库,用于将C++函数封装出Python接口。该库可以很方便地使用conda进行安装,执行命令conda install pybind11 pytest。完成安装后,我们开始编写第一个程序,命名为hello.cpp

// hello.cpp
#include <pybind11/pybind11.h>
#include <iostream>
namespace py = pybind11;
using namespace std;

void say_hello(const char* name)
{
    cout << "Hello, " << name << "! This is a message from C++ library!" << endl;
}

PYBIND11_MODULE(hello, m)
{
    m.def("say_hello", &say_hello, "Print hello to the name.");
}

上面的cpp文件中,say_hello为程序函数,PYBIND11_MODULE为包装函数,此二者在实际应用中一般会分别存放在不同的文件中,但在本例中为演示需要,我将他们放在了同一个文件中。

PYBIND11_MODULE是一个宏定义,其功能是创建一个函数,这个函数会在Python执行import语句时被调用,其接受两个参数,第一个参数为模块名称,这里我们直接将hello填入,稍候可以在Python中使用import hello导入该模块;第二个参数m是创建Python关联代码的主接口,其类型为py::module_module_::def()用于生成能够将say_hello函数暴露给Python的代码,其第一个参数为字符串,将会成为Python中调用的函数名;第二个参数是C++函数的引用;第三个参数是说明字符串,在Python中可以使用help(say_hello)查看。

现在,我们可以着手编译这个库了,这里我使用g++进行编译,通过-shared参数将其编译为共享库,在Linux和MacOS上的编译命令稍有不同:

  • Linux
g++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) hello.cpp -o hello$(python3-config --extension-suffix)
  • MacOS
g++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) hello.cpp -o hello$(python3-config --extension-suffix) -undefined dynamic_lookup

在我的系统中,会生成一个名为hello.cpython-38-darwin.so的文件,这就是编译产生的共享库文件。现在,在当前目录进入python解释器,即可导入包并运行函数:

$ python
Python 3.8.12 (default, Oct 12 2021, 06:23:56) 
[Clang 10.0.0 ] :: Anaconda, Inc. on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import hello
>>> hello.say_hello("Tom")
Hello, Tom! This is a message from C++ library!

除了手动编译外,还可以使用cmake工具进行跨平台编译配置,在当前目录下新建一个CMakeLists.txt文件,然后写入下面的命令:

cmake_minimum_required(VERSION 3.4...3.18)
project(hello)
find_package(Python COMPONENTS Interpreter Development REQUIRED)
find_package(pybind11 REQUIRED)
pybind11_add_module(hello hello.cpp)

其中,find_package函数会自动找到正确的依赖包,pybind11_add_module函数添加了一个名为hello的模块。

保存退出后,执行cmake . && make命令,即可看到编译产生的共享库文件。


使用py::arg参数可以将变量名也暴露给python,同时,若有需要,还可以设置参数默认值:

PYBIND11_MODULE(hello, m)
{
    m.def("say_hello", &say_hello, "Print hello to the name.", py::arg("name")="Jack");
}

Python运行效果:

>>> import hello
>>> hello.say_hello()
Hello, Jack! This is a message from C++ library!
>>> hello.say_hello("Nic")
Hello, Nic! This is a message from C++ library!
>>> hello.say_hello(name="George")
Hello, George! This is a message from C++ library!
>>> help(hello.say_hello)
Help on built-in function say_hello in module hello:

say_hello(...) method of builtins.PyCapsule instance
    say_hello(name: str = 'Jack') -> None
    
    Print hello to the name.
(END)

py::arg参数还有一种简化写法,通过引入名称空间pybind11::literals,可以使用_a后缀来替代py::arg,例如,上面的一条m.def函数可以写成:

using namespace pybind11::literals;
PYBIND11_MODULE(hello, m)
{
    m.def("say_hello", &say_hello, "name"_a="Jack");
}

除了包装函数外,通过使用module_::attr函数可以将C++中的变量暴露给Python,例如下面的C++程序:

// hello.cpp
#include <pybind11/pybind11.h>
#include <iostream>
namespace py = pybind11;
using namespace std;
using namespace pybind11::literals;

const char* where = "This is a message from C++ library!";
const char* cst = "This is an auto cast string by pybind11.";

void say_hello(const char* name)
{
    cout << "Hello, " << name << "!" << endl;
}

PYBIND11_MODULE(hello, m)
{
    m.def("say_hello", &say_hello, "name"_a="Jack");
    m.attr("where") = where;
    m.attr("cast") = py::cast(cst);
}

Python中运行效果:

>>> import hello
>>> hello.say_hello("Tom")
Hello, Tom!
>>> print(hello.where)
This is a message from C++ library!
>>> print(hello.cast)
This is an auto cast string by pybind11.
>>> type(hello.cast)
<class 'str'>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容