0

0

c++如何为Python编写C++扩展_c++ Pybind11使用指南

尼克

尼克

发布时间:2025-12-07 13:43:02

|

554人浏览过

|

来源于php中文网

原创

Pybind11可高效将C++代码暴露给Python,提升性能。1. 通过pip或conda安装后包含头文件即可使用;2. 编写C++函数并用PYBIND11_MODULE和m.def导出;3. 用setuptools编译为共享库,Python可直接导入调用;4. 支持类绑定,如封装Person类并暴露构造函数与成员方法;5. 提供默认参数、STL容器转换、异常处理和NumPy支持等高级功能;6. 建议简化接口、明确返回值策略、拆分模块文件并生成类型提示。

c++如何为python编写c++扩展_c++ pybind11使用指南

用C++为Python编写扩展能显著提升性能关键部分的运行速度。Pybind11 是目前最流行、最简洁的工具之一,它允许你用极少量的 C++ 代码将 C++ 类和函数暴露给 Python。相比传统的 Python/C API 或 Boost.Python,Pybind11 更轻量、易用且功能强大。

1. 安装 Pybind11

Pybind11 是一个头文件库,不需要编译,只需包含即可使用。推荐通过包管理器安装:

  • pip 安装(推荐): pip install pybind11
  • conda 安装: conda install pybind11 -c conda-forge
  • 从源码编译: 从 GitHub 克隆并手动引入头文件目录

安装后,在项目中包含 <pybind11/pybind11.h> 即可开始使用。

2. 编写第一个 C++ 扩展模块

创建一个简单的 C++ 文件(例如 example.cpp),导出一个加法函数:

立即学习Python免费学习笔记(深入)”;

GentleAI
GentleAI

GentleAI是一个高效的AI工作平台,为普通人提供智能计算、简单易用的界面和专业技术支持。让人工智能服务每一个人。

下载
#include <pybind11/pybind11.h>
<p>int add(int a, int b) {
return a + b;
}</p><p>PYBIND11_MODULE(example, m) {
m.doc() = "pybind11 example plugin"; // 模块文档
m.def("add", &add, "A function that adds two numbers");
}</p>

说明:

  • PYBIND11_MODULE 定义一个 Python 可导入的模块,第一个参数是模块名(与编译后的文件名一致),第二个是模块对象 m
  • m.def() 将 C++ 函数绑定为 Python 函数。

3. 编译生成 Python 模块

需要将 C++ 代码编译为 Python 可加载的共享库(如 .so.pyd)。推荐使用 setuptools 构建。

创建 setup.py

from setuptools import setup, Extension
from pybind11.setup_helpers import Pybind11Extension, build_ext
from pybind11 import get_cmake_dir
import pybind11
<p>ext_modules = [
Pybind11Extension(
"example",
["example.cpp"],
),
]</p><p>setup(
name="example",
ext_modules=ext_modules,
cmdclass={"build_ext": build_ext},
zip_safe=False,
)</p>

然后运行:

python setup.py build_ext --inplace

成功后会生成 example.cpython-xxx.so(Linux/macOS)或 example.pyd(Windows),可直接在 Python 中导入:

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

4. 绑定 C++ 类到 Python

Pybind11 支持完整封装 C++ 类。例如定义一个 Person 类:

#include <pybind11/pybind11.h>
#include <string>
<p>class Person {
public:
Person(const std::string &name, int age) : name(name), age(age) {}
void setName(const std::string &name) { this->name = name; }
const std::string &getName() const { return name; }
void setAge(int age) { this->age = age; }
int getAge() const { return age; }</p><p>private:
std::string name;
int age;
};</p><p>PYBIND11<em>MODULE(example, m) {
pybind11::class</em><Person>(m, "Person")
.def(pybind11::init<const std::string&, int>())
.def("setName", &Person::setName)
.def("getName", &Person::getName)
.def("setAge", &Person::setAge)
.def("getAge", &Person::getAge);
}</p>

在 Python 中使用:

p = example.Person("Alice", 30)
print(p.getName())  # Alice
p.setAge(31)
print(p.getAge())   # 31

5. 高级功能简要介绍

  • 默认参数: 直接支持 C++ 函数的默认参数,自动映射到 Python。
  • STL 容器转换: 包含 <pybind11/stl.h> 后,std::vectorstd::map 等可自动转为 Python list/dict。
  • 异常处理: 使用 m.attr("builtins").attr("ValueError") 抛出 Python 异常,或用 py::wrap_exception 包装 C++ 异常。
  • NumPy 支持: 包含 <pybind11/numpy.h> 可传递 NumPy 数组,实现高效数据共享。

6. 最佳实践建议

  • 保持接口简单,避免暴露复杂的 C++ 特性(如模板、多重继承)给 Python。
  • 使用 pybind11::return_value_policy 明确控制对象生命周期(如 reference_internal 避免拷贝)。
  • 模块组织清晰,按功能拆分多个 .cpp 文件并在 setup.py 中统一编译。
  • 添加类型提示支持:使用 pybind11-stubgen 生成 .pyi 文件,提升 IDE 体验。

基本上就这些。Pybind11 让 C++ 和 Python 的交互变得直观高效,适合科学计算、高性能算法、已有 C++ 库封装等场景。掌握基础绑定方法后,查阅官方文档即可应对大多数需求。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

373

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

437

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

803

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

371

2025.07.23

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1958

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

658

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2401

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

47

2026.01.19

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 10.6万人学习

Git 教程
Git 教程

共21课时 | 4.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号