Python怎么将C++代码封装为Python模块_使用pybind11实战演示

夜强君_6023

夜强君_6023

2026-05-21

1039人浏览

原创

PyBind11更适合封装C++,因其能直接暴露C++类、重载函数、STL容器和智能指针;而ctypes仅支持C风格函数,CPython C API则冗长易错、需手动管理引用计数。

python怎么将c++代码封装为python模块_使用pybind11实战演示

pybind11 为什么比 ctypes 和 CPython C API 更适合封装 C++

因为 pybind11 能直接暴露 C++ 类、重载函数、STL 容器(如 std::vector)、智能指针(std::shared_ptr),而 ctypes 只能调用 C 风格函数,且需手动管理内存和类型转换;CPython C API 写法冗长,容易因引用计数出错。pybind11 的绑定代码几乎就是 C++ 的“镜像描述”,维护成本低。

典型误判是:以为“能编译通过就等于能用”。实际常见问题包括:

  • 未启用 C++11 或更高标准(pybind11 最低要求 C++11)
  • 链接时漏掉 -lpython3.x(Linux/macOS)或未正确设置 PYTHON_LIBRARY(Windows)
  • 模块名与 PYBIND11_MODULE 第一个参数不一致,导致 ImportError: No module named 'xxx'

最小可运行的 C++ 函数封装示例

假设你有一个计算两个整数之和的 C++ 函数:

// add.cpp
#include <pybind11>

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

PYBIND11_MODULE(add_module, m) {
    m.doc() = "pybind11 example plugin";
    m.def("add", &add, "A function that adds two integers");
}</pybind11>

编译命令(Linux/macOS):

c++ -O3 -Wall -shared -std=c++11 -fPIC `python3 -m pybind11 --includes` add.cpp -o add_module`python3-config --extension-suffix`

注意点:

  • PYBIND11_MODULE 的第一个参数(add_module)必须与输出文件名前缀完全一致
  • python3-config --extension-suffix 输出类似 .cpython-310-x86_64-linux-gnu.so,不可硬写成 .so
  • Windows 用户请改用 pybind11::module_::import("sys").attr("platform") 查路径,或用 setuptools 避免手写链接命令

如何暴露 C++ 类并支持 Python 的 __str__ 和属性访问

pybind11 对类的支持非常自然,但几个关键操作不能省略:

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载
  • 用 .def(pybind11::init()) 显式声明构造函数,否则 Python 中无法实例化
  • 用 .def_readwrite 暴露 public 成员变量;用 .def_property 暴露 getter/setter
  • 重载 __str__ 需绑定 __repr__ 或 __str__ 方法,推荐用 .def("__repr__", [](const MyClass &a) { return "MyClass(" + std::to_string(a.value) + ")"; })

例如暴露一个带状态的计数器:

class Counter {
public:
    Counter(int start = 0) : value(start) {}
    int value;
    void increment() { ++value; }
};

PYBIND11_MODULE(counter, m) {
    pybind11::class_<counter>(m, "Counter")
        .def(pybind11::init<int>())
        .def_readwrite("value", &Counter::value)
        .def("increment", &Counter::increment)
        .def("__repr__", [](const Counter &c) {
            return "Counter(value=" + std::to_string(c.value) + ")";
        });
}</int></counter>

构建时遇到 undefined symbol: PyUnicodeUCS2_* 怎么办

这是典型的 Python Unicode 编译配置不匹配:你的 Python 是用 UCS4 构建的(默认),但 C++ 编译时未定义 PY_UNICODE_TYPE 或链接了错误的 Python 库版本。

解决方式分三步:

  • 确认 Python 的 Unicode 宽度:python3 -c "import sys; print(sys.maxunicode)" —— 输出 1114111 表示 UCS4,输出 65535 表示 UCS2(极罕见)
  • 确保编译时使用的 python3-config --includes 和 python3-config --ldflags 来自同一个 Python 安装路径
  • 在 C++ 文件顶部添加(仅当明确需要兼容旧环境时):#define PYBIND11_DETAILED_ERROR_MESSAGES,它能暴露更具体的符号缺失信息

最稳妥的做法是全程使用 setuptools + pybind11.setuptools,避免手动拼接编译命令 —— 手动编译在跨平台或虚拟环境里极易出符号/路径错位。

真正麻烦的从来不是“怎么写绑定”,而是“怎么让不同机器上的 Python 环境、编译器、C++ 标准库版本协同工作”。哪怕只改一行 std::string → std::u8string,都可能触发 ABI 不兼容。别跳过 pip install pybind11 后验证 python3 -m pybind11 --includes 的输出路径是否真实存在。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python c++

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1891

4

python能做什么
python能做什么

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

2023.07.25

5164

7

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

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

2023.07.31

1829

3

python教程
python教程

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

2023.08.03

31177

23

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

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

2023.08.04

3687

5

python eval
python eval

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

2023.08.04

3707

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2863

5

热门下载

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

精品课程

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