为什么Python装饰器会丢失原函数的元数据_使用functools.wraps保留函数签名与文档

梦萱姑娘_9995

梦萱姑娘_9995

2026-05-13

571人浏览

原创

装饰器返回新函数对象,导致原函数元数据丢失;functools.wraps通过复制__module__、__name__等属性并设置__wrapped__解决该问题。

为什么python装饰器会丢失原函数的元数据_使用functools.wraps保留函数签名与文档

装饰器返回的是新函数对象,不是原函数

Python中@decorator语法等价于func = decorator(func)。装饰器必须返回一个可调用对象——通常是内部定义的wrapper函数。这个wrapper是全新创建的函数对象,和原函数在内存中完全无关,它的__name__、__doc__等属性自然来自自身定义,而非被包装的函数。

常见表现包括:

  • help(my_func)显示wrapper(*args, **kwargs)而不是真实签名
  • my_func.__name__返回'wrapper',导致日志或测试框架无法识别函数身份
  • my_func.__doc__为None,即使原函数写了完整 docstring

functools.wraps 本质是批量赋值元数据

@wraps(func)不是魔法,它只是调用update_wrapper(wrapper, func),把func的关键属性拷贝到wrapper上。默认复制的字段有:

  • __module__、__name__、__qualname__、__doc__、__annotations__
  • __dict__(通过updated参数,非赋值而是.update())

注意:__defaults__、__kwdefaults__、__closure__这些运行时属性不会被复制——它们不属于“元数据”范畴,inspect.signature()仍能正确解析原函数,因为它读的是func.__code__,不受wraps影响。

带参数的装饰器也必须在最内层 wrapper 上加 @wraps

参数化装饰器有三层嵌套,容易漏掉@wraps的位置。它必须作用于最终返回的那个wrapper函数,而不是中间的decorator闭包。

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载

错误写法:@wraps(func)放在第二层函数上,实际返回的wrapper没被包裹;

正确写法:

from functools import wraps
<p>def retry(max<em>attempts):
def decorator(func):
@wraps(func)  # ← 必须在这里,作用于真正的 wrapper
def wrapper(*args, **kwargs):
for </em> in range(max_attempts):
try:
return func(*args, **kwargs)
except:
pass
raise RuntimeError("Failed")
return wrapper
return decorator
</p>

漏掉这行,fetch_data.__name__依然会变成'wrapper',哪怕外层结构再复杂。

__wrapped__ 属性是调试和框架集成的关键线索

functools.wraps还会自动设置wrapper.__wrapped__ = func。这个属性不用于日常开发,但在调试或框架底层(如 FastAPI 的路由注册、pytest 的测试发现)中会被主动读取。如果自定义装饰器没设__wrapped__,某些工具可能抛出ValueError: Function has no argument info之类难以定位的错误。

它不是装饰器的“可选功能”,而是生产环境兼容性的事实标准。没有它,inspect.unwrap()也无法逐层剥开多层装饰,容易卡在某一层wrapper上。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1691

4

python能做什么
python能做什么

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

2023.07.25

4244

7

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

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

2023.07.31

1689

3

python教程
python教程

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

2023.08.03

24677

23

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

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

2023.08.04

3007

5

python eval
python eval

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

2023.08.04

3047

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2363

5

热门下载

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

精品课程

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