首页
/ pybind11 使用教程

pybind11 使用教程

2024-08-10 20:59:31作者:劳婵绚Shirley

项目介绍

pybind11 是一个轻量级的头文件库,旨在实现 C++ 和 Python 之间的无缝操作。它主要用于创建现有 C++ 代码的 Python 绑定。pybind11 的目标和语法与 Boost.Python 库类似,但它的实现更为简洁,不需要链接复杂的 Boost 库。pybind11 支持 Python 3.8+ 和 PyPy3.7+,并且可以绑定带有捕获变量的 C++11 lambda 函数。

项目快速启动

安装

首先,确保你已经安装了 pybind11。你可以通过以下命令安装:

pip install pybind11

编写绑定代码

以下是一个简单的示例,展示如何将一个 C++ 函数绑定到 Python:

#include <pybind11/pybind11.h>

int add(int i, int j) {
    return i + j;
}

PYBIND11_MODULE(example, m) {
    m.def("add", &add, "A function that adds two numbers");
}

编译

使用以下命令编译你的 C++ 代码:

c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) example.cpp -o example$(python3-config --extension-suffix)

在 Python 中使用

编译完成后,你可以在 Python 中导入并使用这个模块:

import example
print(example.add(1, 2))  # 输出: 3

应用案例和最佳实践

案例一:绑定 C++ 类

你可以绑定 C++ 类,使其在 Python 中可用。以下是一个示例:

#include <pybind11/pybind11.h>

class Pet {
public:
    Pet(const std::string &name) : name(name) {}
    void setName(const std::string &name_) { name = name_; }
    const std::string &getName() const { return name; }
private:
    std::string name;
};

PYBIND11_MODULE(pet, m) {
    pybind11::class_<Pet>(m, "Pet")
        .def(pybind11::init<const std::string &>())
        .def("setName", &Pet::setName)
        .def("getName", &Pet::getName);
}

在 Python 中使用:

import pet

my_pet = pet.Pet("Molly")
print(my_pet.getName())  # 输出: Molly
my_pet.setName("Bobby")
print(my_pet.getName())  # 输出: Bobby

最佳实践

  • 模块化设计:将不同的功能模块化,便于管理和维护。
  • 文档注释:在绑定代码中添加详细的文档注释,方便其他开发者理解和使用。
  • 错误处理:在 C++ 代码中添加适当的错误处理,确保 Python 代码的稳定性。

典型生态项目

pybind11_json

pybind11_json 是一个用于将 nlohmann::json 与 pybind11 结合的项目,使得在 C++ 和 Python 之间传递 JSON 数据更加方便。

pybind11_mkdoc

pybind11_mkdoc 是一个用于从 C++ 注释生成 Python 文档字符串的工具,帮助你自动生成文档。

pybind11_benchmark

pybind11_benchmark 是一个简单的基准测试工具,用于跟踪 pybind11 的性能变化。

通过这些生态项目,你可以更高效地使用 pybind11,并扩展其功能。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
120
207
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
532
405
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
396
37
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
251
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.03 K
arkanalyzerarkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
46
40
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
358
342
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
582
41