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

怎样在Python中通过functools.wraps保留被装饰函数元数据?

秋芳同学_4160

秋芳同学_4160

发布时间:2026-10-09 06:43:37

|

999人浏览过

|

来源于php中文网

原创

被装饰函数的__name__和__doc__丢失,是因为装饰器用wrapper新函数对象替换了原函数,而wrapper自带独立元数据;functools.wraps通过在wrapper上加@wraps(func)装饰,自动复制__module__、__name__、__qualname__、__doc__、__annotations__等关键属性,修复元信息。

怎样在python中通过functools.wraps保留被装饰函数元数据?

为什么被装饰函数的 __name__ 和 __doc__ 会丢失?

Python 装饰器本质是用新函数替换了原函数对象,而新函数(闭包内部的 wrapper)有自己的 __name__、__doc__ 等属性,和原函数完全无关。不加处理时,调用 help(my_func) 或检查 my_func.__name__ 得到的都是 wrapper 的信息,不是你写的那个函数。

怎样用 functools.wraps 正确复制元数据?

functools.wraps 是个工厂函数,它接收原函数作为参数,返回一个修饰 wrapper 的装饰器,自动把原函数的关键属性复制过去。关键点在于:必须把它用作装饰器作用于内部的 wrapper 函数,而不是直接套在最外层装饰器上。

常见错误写法:@wraps(func) 错误地加在了装饰器定义上;正确位置是在闭包里、wrapper 函数定义前:

from functools import wraps
<p>def my_decorator(func):
@wraps(func)  # ✅ 这里才对
def wrapper(*args, *<em>kwargs):
print("before")
result = func(</em>args, **kwargs)
print("after")
return result
return wrapper

这样之后:my_decorated_func.__name__ 就等于原函数名,my_decorated_func.__doc__ 也能正常显示文档字符串。

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

testing-python
testing-python

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

下载

functools.wraps 默认复制哪些属性?

它默认同步以下 5 个属性:__module__、__name__、__qualname__、__doc__、__annotations__。这些覆盖了绝大多数调试、IDE 提示、反射(如 inspect.signature)所需的信息。

如果你还依赖其他属性(比如自定义的 __version__ 或 __author__),wraps 不会自动处理,需要手动赋值:

@wraps(func)
def wrapper(*args, **kwargs):
    ...
wrapper.__version__ = func.__version__

不加 @wraps 会导致什么实际问题?

除了 help() 显示错乱,还会直接影响依赖函数签名的工具:

  • Flask / FastAPI 路由注册可能失败(它们靠 __name__ 去重或生成 endpoint 名)
  • inspect.signature(func) 返回的是 wrapper 的签名,不是原函数的,导致类型检查或自动文档生成出错
  • 单元测试中用 mock.patch 时,如果 patch 目标是被装饰函数,没 @wraps 可能导致 mock 失效(因为名字对不上)
  • 某些序列化框架(如 Pydantic 的 validate_arguments)会因元数据缺失抛 ValueError: no signature found

真正麻烦的不是“看起来不对”,而是下游工具链静默失效——等你发现时,往往已经绕了很大一圈。

热门AI工具

更多
二狗PPT
二狗PPT Hot

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

DeepSeek

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

WorkBuddy

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

超级简历WonderCV

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

1691

2023.07.20

python能做什么
python能做什么

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

4244

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24657

2023.08.03

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

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

3007

2023.08.04

python eval
python eval

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

3047

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

C++运算符基础入门
C++运算符基础入门

本专题详细讲解了C++运算符的类型、语法与使用方法,涵盖算术运算符、关系运算符、逻辑运算符、位运算符、赋值运算符、条件运算符及其他特殊运算符,并通过代码示例解析优先级与结合性。

0

2026.10.09

热门下载

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

精品课程

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

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