Python装饰器保留函数名和文档说明方法
文章不知道大家是否熟悉?今天我将给大家介绍《Python装饰器保留函数名和文档字符串的方法》,这篇文章主要会讲到等等知识点,如果你在看完本篇文章后,有更好的建议或者发现哪里有问题,希望大家都能积极评论指出,谢谢!希望我们能一起加油进步!
被装饰函数的__name__和__doc__丢失是因为装饰器用新函数替换了原函数,而wrapper默认携带自身元数据;functools.wraps可自动同步__name__、__doc__等属性,避免手动赋值遗漏,类装饰器及嵌套装饰器中同样必须使用。

为什么被装饰函数的 __name__ 和 __doc__ 会丢失
Python 装饰器本质是用新函数替换了原函数对象。如果装饰器内部直接返回一个普通闭包(比如 def wrapper(*args, **kwargs): ...),那么这个 wrapper 的 __name__ 就是 "wrapper",__doc__ 也来自它自身,和原函数无关。常见现象包括:help(my_decorated_func) 显示的是装饰器里的文档,而不是原函数的;my_decorated_func.__name__ 返回 "wrapper" 而非预期名称。
用 functools.wraps 一键同步元数据
functools.wraps 是标准解法,它本身是个装饰器,作用是把被装饰函数的 __module__、__name__、__qualname__、__doc__、__annotations__ 等属性复制到包装函数上。
使用方式很简单:
from functools import wrapsdef my_decorator(func): @wraps(func) # ← 关键:加在这儿 def wrapper(*args, *kwargs): print("Before") result = func(args, **kwargs) print("After") return result return wrapper
@my_decorator def say_hello(): """Say hello to the world.""" return "Hello!"
此时 say_hello.__name__ 是 "say_hello",say_hello.__doc__ 也是 "Say hello to the world."。
不使用 @wraps 时手动同步的隐患
有人尝试手动赋值,比如在 wrapper 内部写 wrapper.__name__ = func.__name__,但这只解决表面问题:
__doc__、__module__、__annotations__、__dict__等都得逐个处理,容易遗漏__wrapped__属性不会自动建立,导致无法通过inspect.unwrap()反向获取原始函数- 某些框架(如 Flask、Click)依赖完整的元数据,手动同步可能引发兼容性问题
- Python 3.12+ 对
__qualname__和嵌套函数名更敏感,漏掉会导致调试困难
装饰器类里也要用 wraps 吗
要。即使你写的是类装饰器,只要返回的是可调用对象(比如实现了 __call__),且希望保留原函数元数据,就必须在 __call__ 内部或返回的包装函数上应用 @wraps。
例如:
from functools import wrapsclass CountCalls: def init(self, func): self.func = func self.count = 0
注意:这里不能直接 wraps(self),因为 self 不是函数
def __call__(self, *args, **kwargs): self.count += 1 @wraps(self.func) # ← 必须在这里 wrap 包装逻辑 def wrapped(*a, **kw): return self.func(*a, **kw) return wrapped(*args, **kwargs)
不过更常见的写法是把 @wraps 放在 __call__ 返回的闭包上,或者直接在 __init__ 中用 wraps 处理 self 的属性 —— 但最稳妥、最符合直觉的方式仍是:**只要你在返回一个新函数,且它替代了原函数,就对那个新函数用 @wraps(func)**。
真正容易被忽略的,是装饰器嵌套场景:比如 @retry @cache @log,每一层都必须正确使用 wraps,否则最外层拿到的就不是原始函数的 __doc__,而是中间某层包装函数的。
文中关于的知识介绍,希望对你的学习有所帮助!若是受益匪浅,那就动动鼠标收藏这篇《Python装饰器保留函数名和文档说明方法》文章吧,也可关注golang学习网公众号了解相关技术文章。
新手学PHP架构必看:基础概念全解析
- 上一篇
- 新手学PHP架构必看:基础概念全解析
- 下一篇
- Python变量作用域LEGB解析指南
-
- 文章 · python教程 | 1小时前 | 并发编程 · 工程实践 · Python教程 · 多进程日志 QueueListener multiprocessing.Queue RotatingFileHandler Python QueueHandler
- Python 日志 QueueHandler 解决多进程写入争用
- 186浏览 收藏
-
- 文章 · python教程 | 4小时前 | 数据校验 · python · Pydantic 部分更新 exclude_unset model_fields_set 显式空值 model_dump
- Pydantic 模型更新时区分未提供字段与显式空值
- 399浏览 收藏
-
- 文章 · python教程 | 6小时前 |
- pytest Fixture 作用域如何影响测试隔离与速度
- 341浏览 收藏
-
- 文章 · python教程 | 8小时前 | Python教程 · pathlib · 路径安全 Python pathlib Path.resolve 目录穿越 relative_to
- Pathlib 安全拼接用户路径:解析后再验证根目录
- 463浏览 收藏
-
- 文章 · python教程 | 10小时前 | 性能优化 · Python教程 · Python 进程间通信 pickle multiprocessing SharedMemory
- multiprocessing 传输大对象为何变慢,如何减少序列化
- 478浏览 收藏
-
- 文章 · python教程 | 1天前 | python · Python import很慢 -X importtime 模块级副作用 延迟导入 Python启动优化
- Python import 很慢怎么分析:模块级副作用与延迟导入
- 292浏览 收藏
-
- 文章 · python教程 | 1天前 | python · 异步编程 · Python asyncio contextvars request_id
- contextvars 在异步请求链中传递追踪信息
- 393浏览 收藏
-
- 文章 · python教程 | 1天前 | 并发 · 异常处理 · python · asyncio · CancelledError 结构化并发 ExceptionGroup Python asyncio TaskGroup asyncio gather
- asyncio TaskGroup 让并发任务在首错时一起收敛
- 246浏览 收藏
-
- 文章 · python教程 | 1天前 |
- Python 3.14 自由线程程序怎样显式保护共享状态
- 337浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 380次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 450次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 461次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 403次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 232次使用
-
- Python sqlite3 Connection serialize 怎么导出数据库快照:备份窗口、内存占用与恢复校验
- 2026-08-26 501浏览
-
- Python监控网页状态:requests异常处理实战
- 2026-05-29 501浏览
-
- TensorFlow模型部署为API的TF Serving方法
- 2026-05-26 501浏览
-
- Python字符串编码转换:encode与decode详解
- 2026-05-16 501浏览
-
- TensorFlow裁剪无用算子方法详解
- 2026-05-15 501浏览

