当前位置:首页 > 文章列表 > 文章 > python教程 > Python装饰器保留函数名和文档说明方法

Python装饰器保留函数名和文档说明方法

2026-01-24 19:45:41 0浏览 收藏

文章不知道大家是否熟悉?今天我将给大家介绍《Python装饰器保留函数名和文档字符串的方法》,这篇文章主要会讲到等等知识点,如果你在看完本篇文章后,有更好的建议或者发现哪里有问题,希望大家都能积极评论指出,谢谢!希望我们能一起加油进步!

被装饰函数的__name__和__doc__丢失是因为装饰器用新函数替换了原函数,而wrapper默认携带自身元数据;functools.wraps可自动同步__name__、__doc__等属性,避免手动赋值遗漏,类装饰器及嵌套装饰器中同样必须使用。

Python 装饰器如何保留被装饰函数的 name 和 docstring

为什么被装饰函数的 __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 wraps

def 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 wraps

class 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架构必看:基础概念全解析
上一篇
新手学PHP架构必看:基础概念全解析
Python变量作用域LEGB解析指南
下一篇
Python变量作用域LEGB解析指南
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ljg-skills -
    ljg-skills
    ljg-skills 是李继刚开源的 AI 技能与提示词集合,面向大模型使用者整理了一批可复用的 prompt、角色设定和任务技能模板,适合用于学习提示词设计、搭建个人 AI 工作流和沉淀团队常用智能体能力。
    104次使用
  • MELO音乐 - AI 音乐生成平台,支持多模态创作能力
    MELO音乐
    MELO音乐是一站式AI视频与音乐制作助手,对标suno, udio的高品质体验。提供伴奏生成、原创写词、无损导出、哼唱识曲、混音变声等全套音频与短视频编辑工具。无论是流行Kpop、电音说唱、民谣古风、摇滚儿歌还是商用轻音乐,MELO为你免费谱曲,轻松做同款!
    124次使用
  • UniScribe - AI 免费在线音视频转文字平台
    UniScribe
    UniScribe 是一款 AI 音视频转文字与内容整理工具,支持上传音频、视频文件或粘贴 YouTube 链接,自动生成转写文本、摘要、思维导图和关键问题,并支持多格式导出,适合会议记录、课程学习、访谈整理和内容创作复盘。
    112次使用
  • 剧云 - 免费 AI 智能中文剧本创作平台
    剧云
    剧云是专业中文剧本创作平台,安全稳定运行十余年,集成AI编剧、剧本医生审核、人物小传、剧情关系图、大纲编写、多人协作、Word导入导出、版权管控功能,数据安全防护,轻松高效创作剧本。
    262次使用
  • 万象有声 - AI 一站式有声内容创作平台
    万象有声
    万象有声,一个专为有声创作者打造的新一代智能有声内容创作平台。平台提供专业的智能拆章、智能画本编辑、AI配音、AI生成音效、后期制作、智能对轨、智能审听等有声创作全流程工具,可以帮助创作者高效、低成本创作出引人入胜的有声作品。立即体验,让有声书制作更简单!
    260次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码