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 克隆并手动引入头文件目录

安装后,在项目中包含 即可开始使用。

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

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

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

Axiom
Axiom

Axiom是一个浏览器扩展,用于自动化重复任务和web抓取。

下载
#include 

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

PYBIND11_MODULE(example, m) { m.doc() = "pybind11 example plugin"; // 模块文档 m.def("add", &add, "A function that adds two numbers"); }

说明:

  • 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

ext_modules = [ Pybind11Extension( "example", ["example.cpp"], ), ]

setup( name="example", ext_modules=ext_modules, cmdclass={"build_ext": build_ext}, zip_safe=False, )

然后运行:

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 
#include 

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; }

private: std::string name; int age; };

PYBIND11MODULE(example, m) { pybind11::class(m, "Person") .def(pybind11::init()) .def("setName", &Person::setName) .def("getName", &Person::getName) .def("setAge", &Person::setAge) .def("getAge", &Person::getAge); }

在 Python 中使用:

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

5. 高级功能简要介绍

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

6. 最佳实践建议

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

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

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

772

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

661

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

764

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

679

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1385

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

570

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

730

2023.08.11

C++ 高级模板编程与元编程
C++ 高级模板编程与元编程

本专题深入讲解 C++ 中的高级模板编程与元编程技术,涵盖模板特化、SFINAE、模板递归、类型萃取、编译时常量与计算、C++17 的折叠表达式与变长模板参数等。通过多个实际示例,帮助开发者掌握 如何利用 C++ 模板机制编写高效、可扩展的通用代码,并提升代码的灵活性与性能。

8

2026.01.23

热门下载

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

精品课程

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

共48课时 | 7.6万人学习

Git 教程
Git 教程

共21课时 | 2.9万人学习

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

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