为什么在Python中使用functools.wraps可以保留原始装饰器的元数据?

浅强君_9302

浅强君_9302

2026-07-19

609人浏览

原创

装饰器替换函数后元数据丢失是因为新函数对象覆盖了原函数的__name__、__doc__等属性;functools.wraps通过update_wrapper复制7个关键属性并设置__wrapped__,必须直接作用于最内层wrapper函数才能生效。

为什么在python中使用functools.wraps可以保留原始装饰器的元数据?

装饰器替换函数后元数据为什么丢失

装饰器本质是用新函数(比如 wrapper)替代原函数对象。Python 中函数的 __name__、__doc__、__annotations__ 等属性都绑定在函数对象上,一旦被替换,这些属性自然就变成新函数的——不是“丢了”,而是被覆盖了。

常见错误现象包括:help(my_func) 显示的是 wrapper 的文档,inspect.signature(my_func) 返回的参数签名和原函数不一致,Flask 路由调试时看到函数名是 wrapper 而不是真实视图名。

functools.wraps 实际做了什么

functools.wraps 不是魔法,它只是调用 functools.update_wrapper,把原函数的 7 个关键属性批量复制到 wrapper 上:

  • __module__、__name__、__qualname__、__doc__、__annotations__ 直接赋值
  • __dict__ 合并更新(保留 wrapper 自身属性,同时注入原函数的动态属性)
  • __wrapped__ 指向原始函数,供 inspect 等工具穿透多层装饰器

它必须作用于最内层的 wrapper 函数,否则复制动作就落空了。比如带参数的装饰器里,@wraps(func) 得写在最终执行逻辑的那个 def wrapper(...) 上,而不是外层闭包函数里。

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载

不加 wraps 会直接影响哪些场景

很多框架和工具依赖函数元数据工作,不是“看起来丑”,而是直接出错:

  • FastAPI 和 Pydantic 基于 __annotations__ 和 inspect.signature() 做参数校验和序列化,元数据错 → 请求解析失败
  • Flask/Django 的路由注册、调试面板、自动文档(如 Swagger UI)靠 __name__ 和 __doc__ 匹配和展示,错 → 路由不可见或文档空白
  • pytest 发现测试函数时按 __name__ 过滤,错 → 测试被跳过
  • IDE 的跳转、补全、hover 提示依赖 __doc__ 和签名,错 → 开发体验断层

容易踩的坑:wraps 放错位置或漏掉

最常见的实操失误:

  • 把 @wraps(func) 加在外层装饰器工厂函数上,比如 def retry(max_attempts=3): @wraps(...) def decorator(...) —— 这完全无效
  • 在 wrapper 内部手动调用 update_wrapper,但漏掉 __annotations__ 或没处理 __dict__ 合并
  • 用类实现装饰器时,忘记在 __call__ 返回的函数上应用 @wraps
  • 多个装饰器叠加时,只在最外层加 @wraps,而没确保每一层的 wrapper 都被正确包裹

真正起作用的永远是那一行紧贴 def wrapper(...) 的 @wraps(func) —— 它不是可选优化,是让装饰器能被现代 Python 工具链识别的必要条件。

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4604

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

27217

23

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

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

2023.08.04

3287

5

python eval
python eval

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

2023.08.04

3287

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2563

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习