讲师中心 微信公众号
AI工具推荐 视频效率加速

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

风枫小哥_2194

风枫小哥_2194

发布时间:2026-10-18 09:26:21

|

460人浏览过

|

来源于php中文网

原创

不加 @functools.wraps 会丢失原函数的 name__、__doc__、__annotations 等元信息,因装饰器默认返回 wrapper 函数而非原函数,导致 help()、类型检查、框架反射等失效。

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

为什么 @functools.wraps 不加就丢元信息?

不加 @functools.wraps 时,装饰器返回的是内部包装函数(比如 wrapper),它的 __name__、__doc__、__annotations__ 全都来自这个包装函数,而不是原函数。调试、文档生成(如 help())、类型检查工具(如 mypy)甚至某些框架(如 FastAPI 的路由反射)都会因此失效。

根本原因是:Python 装饰器本质是函数替换,而默认不会自动复制原函数的属性。

@wraps(func) 怎么用才生效?

必须把被装饰的函数名传给 @wraps,且该调用要写在包装函数定义前;否则它不知道该“仿照”谁。

  • ✅ 正确:
    from functools import wraps
    <p>def my_decorator(func):
    @wraps(func)  # ← 这里传入 func,不是字符串,也不是 self
    def wrapper(*args, *<em>kwargs):
    return func(</em>args, **kwargs)
    return wrapper
  • ❌ 错误:@wraps(wrapper)、@wraps('func')、漏掉 @wraps 行、或把它放在 def wrapper 之后
  • ⚠️ 注意:@wraps 只复制 __module__、__name__、__qualname__、__doc__、__annotations__ 这几个关键属性,不复制 __dict__ 或自定义属性

不加 @wraps 会触发哪些具体问题?

常见报错或异常行为往往不直接提示“缺 wraps”,得靠现象反推:

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载

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

  • help(my_decorated_func) 显示的是 wrapper 的 docstring,甚至为空
  • 单元测试里用 assert my_func.__name__ == 'my_func' 失败,实际值是 'wrapper'
  • 使用 inspect.signature(my_decorated_func) 拿到的是包装函数的签名,而非原函数参数(除非你在 wrapper 里手动处理 *args, **kwargs 并调用 inspect.signature(func))
  • FastAPI 或 Flask 中,带类型注解的路由函数若没 @wraps,依赖注入可能失败或参数解析错乱

替代方案和边界情况

@wraps 是标准解法,但有几点容易忽略:

  • 如果装饰器本身带参数(即三层嵌套),@wraps 仍要作用在最内层的 wrapper 上,且传入原始 func(不是中间闭包里的变量名)
  • functools.wraps 本身返回一个装饰器函数,所以它必须被调用(带括号),写成 @wraps 等价于 @wraps(func) —— 少了括号就是语法错误
  • 极少数场景需要额外复制属性(比如 __version__),就得手动赋值:wrapper.__version__ = func.__version__

真正麻烦的不是怎么写,而是忘了写,或者写在了错误的位置——一旦出问题,往往要倒查好几层装饰器链。

热门AI工具

更多
Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

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

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

1751

2023.07.20

python能做什么
python能做什么

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

4504

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

26537

2023.08.03

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

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

3207

2023.08.04

python eval
python eval

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

3227

2023.08.04

scratch和python区别
scratch和python区别

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

1183

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn