0

0

Python functools.wraps 的作用与必要性

冰川箭仙

冰川箭仙

发布时间:2026-01-28 18:21:56

|

417人浏览过

|

来源于php中文网

原创

functools.wraps 不可省略,否则被装饰函数的 name__、__doc__、__module__、__qualname__、__annotations 等元信息会丢失,导致调试、文档生成、类型检查等失败。

python functools.wraps 的作用与必要性

为什么 functools.wraps 不能省?

不加 functools.wraps 的装饰器,会让被装饰函数的元信息(__name____doc____module__ 等)变成内层包装函数的信息,导致调试、文档生成、反射等场景出错。这不是风格问题,是实际功能断裂。

functools.wraps 到底复制了哪些属性?

它本质是调用 update_wrapper,默认同步以下关键属性:
- __module__:确保 help() 和日志里显示正确的模块路径
- __name__:让断点调试、性能分析工具(如 cProfile)能识别原函数名
- __qualname__:支持嵌套函数和类方法的正确路径表示
- __doc__:保证 help() 和 IDE 悬停提示显示原始 docstring
- __annotations__:类型提示不会丢失,对 mypy、pylance 等工具至关重要

不加 @wraps(func) 的典型错误现象

常见于日志、测试、框架集成等依赖函数元信息的场景:
- help(my_decorated_func) 显示的是 wrapper 的空 docstring,而非原函数说明
- 单元测试中用 self.assertEqual(my_func.__name__, "expected_name") 直接失败
- FastAPI 或 Flask 路由函数丢失 __name__ 后,自动文档(Swagger)无法正确归类接口
- 使用 inspect.signature() 获取参数时,返回的是包装函数的签名,不是原始函数的

一个最小可验证示例

对比加与不加 @wraps 的行为差异:

from functools import wraps

def log_calls(func): def wrapper(*args, *kwargs): print(f"Calling {func.name}") return func(args, **kwargs)

缺少 @wraps(func) → 元信息丢失

return wrapper

def log_calls_fixed(func): @wraps(func) def wrapper(*args, *kwargs): print(f"Calling {func.name}") return func(args, **kwargs) return wrapper

@log_calls def add(a, b): """Return sum of a and b.""" return a + b

@log_calls_fixed def multiply(a, b): """Return product of a and b.""" return a * b

执行 print(add.__name__, add.__doc__) 输出 wrapper None;而 multiply.__name__multiplymultiply.__doc__ 正确为 "Return product of a and b."

开源电子商务系统(网店) iWebShop
开源电子商务系统(网店) iWebShop

iWebShop基于iWebSI框架开发,在获得iWebSI技术平台库支持的条件下,iWebShop可以轻松满足用户量级百万至千万级的大型电子商务网站的性能要求。站点的集群与分布式技术(分布式计算与存储/高可用性/负载均衡)被屏蔽在SI 平台之内,基于iWebShop并且按照SI平台库扩展规范开发的新增功能模块,也将同时获得这种超级计算与处理的能力。作为开源的LAMP电子商务系统,iWebShop

下载

元信息丢失的问题在简单脚本里可能无感,但一旦进入团队协作、自动化工具链或框架集成环节,就会变成难以定位的隐性故障点。

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

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
Python Flask框架
Python Flask框架

本专题专注于 Python 轻量级 Web 框架 Flask 的学习与实战,内容涵盖路由与视图、模板渲染、表单处理、数据库集成、用户认证以及RESTful API 开发。通过博客系统、任务管理工具与微服务接口等项目实战,帮助学员掌握 Flask 在快速构建小型到中型 Web 应用中的核心技能。

86

2025.08.25

Python Flask Web框架与API开发
Python Flask Web框架与API开发

本专题系统介绍 Python Flask Web框架的基础与进阶应用,包括Flask路由、请求与响应、模板渲染、表单处理、安全性加固、数据库集成(SQLAlchemy)、以及使用Flask构建 RESTful API 服务。通过多个实战项目,帮助学习者掌握使用 Flask 开发高效、可扩展的 Web 应用与 API。

72

2025.12.15

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

27

2025.12.22

python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

186

2023.09.27

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

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

1126

2023.10.19

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

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

192

2025.10.17

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

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

1606

2025.12.29

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

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

20

2026.01.19

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

158

2026.01.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.3万人学习

Django 教程
Django 教程

共28课时 | 3.6万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

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

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