怎样在Python中使用functools.wraps保留函数元信息

轻杰酱_3077

轻杰酱_3077

2026-09-30

363人浏览

原创

不加 functools.wraps 会导致被装饰函数的 name__、__doc 等元信息丢失,因其被 wrapper 函数对象替代;@wraps(func) 必须作用于内部 wrapper 函数,才能正确复制原函数元数据。

怎样在python中使用functools.wraps保留函数元信息

为什么直接写装饰器会导致函数名和文档丢失

不加 functools.wraps 的装饰器,本质是用新函数替换了原函数对象。调用 help()、inspect.getdoc() 或访问 __name__ 时,拿到的都是内层闭包函数的信息,不是被装饰函数的。比如原函数叫 fetch_data,装饰后 fetch_data.__name__ 变成 wrapper,文档字符串也为空。

functools.wraps(func) 的正确用法

functools.wraps 是个工厂函数,它返回一个装饰器,用来修饰你写的包装函数(即 wrapper)。关键点在于:必须把它用在 def wrapper(...): 上面,而不是最外层的装饰器函数上。

常见错误写法:@wraps 加在最外层函数(接收 func 的那个)上——这没意义,因为那不是被调用的函数。

正确结构如下:

Python Use Agent
Python Use Agent

智能执行Python任务,自动生成、执行代码并反馈结果,无需额外配置,兼容旧命令。

下载
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__(部分)等属性。

不加 wraps 会出什么具体问题

这些现象在调试、测试和工具链中很常见:

  • help(my_decorated_func) 显示的是 wrapper 的空帮助,而非原函数文档
  • 单元测试中用 self.assertEqual(func.__name__, "expected_name") 会失败
  • FastAPI / Flask 等框架依赖 __name__ 和 __doc__ 生成 API 文档,缺失会导致文档为空或路由名异常
  • inspect.signature(my_decorated_func) 可能返回 (*args, **kwargs) 而非真实参数签名(wraps 不自动复制 signature,需额外处理)

进阶注意:wraps 不解决所有元信息问题

functools.wraps 复制的是标准元数据,但有些信息它不管:

  • __signature__ 不会被自动更新 —— 如果需要保留原始签名(比如类型检查或 IDE 提示),得手动设:wrapper.__signature__ = inspect.signature(func)
  • 自定义属性如 func.version = "1.2" 不会被复制,除非显式赋值:wrapper.version = func.version
  • 如果原函数有 __wrapped__ 属性(比如已被其他装饰器包装过),wraps 不会链式展开,只取传入的 func

真正容易被忽略的是:哪怕加了 @wraps(func),如果忘了 return wrapper,或者在 wrapper 里没调用 func,元信息“保留”了,功能却丢了——元信息只是让函数看起来像原来那样,不等于行为也一样。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1631

4

python能做什么
python能做什么

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

2023.07.25

3944

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

22657

23

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

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

2023.08.04

2787

5

python eval
python eval

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

2023.08.04

2827

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

2183

5

热门下载

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

精品课程

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