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

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 pybind11conda 安装: conda install pybind11 -c conda-forge从源码编译: 从 GitHub 克隆并手动引入头文件目录

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

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

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

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

#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 可导入的模块,第一个参数是模块名(与编译后的文件名一致),第二个是模块对象 mm.def() 将 C++ 函数绑定为 Python 函数。

3. 编译生成 Python 模块

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

创建 setup.py

from setuptools import setup, Extensionfrom pybind11.setup_helpers import Pybind11Extension, build_extfrom pybind11 import get_cmake_dirimport 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 exampleprint(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())  # Alicep.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++ 库封装等场景。掌握基础绑定方法后,查阅官方文档即可应对大多数需求。

以上就是c++++如何为Python编写C++扩展_c++ Pybind11使用指南的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1488226.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月19日 11:22:44
下一篇 2025年12月19日 11:23:02

相关推荐

发表回复

登录后才能评论
关注微信