如何在Python中用functools.wraps保留被装饰函数的元信息?

阿辰酱_3571

阿辰酱_3571

2026-09-28

137人浏览

原创

不加functools.wraps时,装饰器用wrapper函数替换原函数,导致__name__、__doc__等属性被覆盖为wrapper的值;加上后,wraps通过update_wrapper将原函数的__name__、__doc__、__module__等7个关键属性复制到wrapper,并设置__wrapped__指向原函数,从而透传元信息。

如何在python中用functools.wraps保留被装饰函数的元信息?

不加 functools.wraps,被装饰函数的 __name__、__doc__、__module__ 等全会变成装饰器内部函数的——这不是 bug,是默认行为;加了它,才能“透传”原函数的元信息。

为什么直接写装饰器会丢掉 __doc__ 和 __name__

Python 装饰器本质是用新函数替换了原函数对象。如果你没手动复制元信息,Python 就只认新函数的属性:

  • 调用 help(my_func) 显示的是装饰器里 wrapper 的 docstring,不是 my_func 自己写的
  • my_func.__name__ 变成 'wrapper',而不是 'my_func'
  • 某些依赖函数名的框架(如 Flask 路由注册、pytest 参数化)可能出错

怎么正确用 functools.wraps

它是个装饰器工厂,接收原函数作为参数,返回一个用于修饰 wrapper 的装饰器:

from functools import wraps
<p>def my_decorator(func):
@wraps(func)  # ← 关键:套在 wrapper 上
def wrapper(*args, *<em>kwargs):
print("before")
result = func(</em>args, **kwargs)
print("after")
return result
return wrapper</p>

这样 wrapper 就会自动继承 func 的 __name__、__doc__、__module__、__annotations__、__dict__ 等关键属性。

提示词大师-python版
提示词大师-python版

图片提示词生成器?不止如此。 马甲系统 —— 把脑海中的画面,翻译成AI能理解的专业表达。 用得越多,它越懂你:首次需要多问几句确认方向,用久了几乎一说就懂。 用得越多,它越快:缓存机制让后续对话越来越省。 RAG进化:成功案例持续入库,越跑越聪明。 输入「新手指南」查看完整功能介绍

下载

@wraps(func) 复制了哪些属性?哪些没复制?

它复制的是标准库定义的「可安全继承」的元信息,包括:

  • __name__、__qualname__
  • __doc__(即 docstring)
  • __module__、__annotations__
  • __dict__ 中的非私有项(但注意:不会覆盖已存在的同名 key)

它**不复制**:

  • __closure__(闭包变量)——这是函数执行时动态生成的,没法也不该继承
  • __code__(字节码)——wrapper 必须有自己的逻辑
  • 自定义的特殊属性(比如你手动加的 func.version = '1.2'),得自己赋值

常见踩坑点:@wraps 放错位置或漏掉括号

错误写法会导致 TypeError: 'function' object is not callable 或完全没效果:

  • ❌ 写成 @wraps(没传 func):装饰器没拿到目标函数,无法初始化
  • ❌ 把 @wraps(func) 放在 def wrapper 外面(比如放在 def my_decorator 上):作用对象错了
  • ❌ 在类方法装饰器里传错参数:要传 func,不是 self 或 cls
  • ❌ 多层装饰器时,只在最内层用 @wraps:外层装饰器仍会覆盖元信息,每层 wrapper 都得各自 @wraps

真正容易被忽略的是:当装饰器本身带参数(比如 @retry(times=3)),@wraps 必须落在最内层的 wrapper 上,且传入的是最终要包装的那个函数——这需要三层嵌套,稍不注意就漏掉。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1611

4

python能做什么
python能做什么

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

2023.07.25

3864

7

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

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

2023.07.31

1609

3

python教程
python教程

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

2023.08.03

22277

23

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

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

2023.08.04

2747

5

python eval
python eval

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

2023.08.04

2787

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2163

5

热门下载

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

精品课程

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