0

0

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

冷漠man

冷漠man

发布时间:2026-01-25 19:23:30

|

486人浏览过

|

来源于php中文网

原创

被装饰函数的__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."

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

不使用 @wraps 时手动同步的隐患

有人尝试手动赋值,比如在 wrapper 内部写 wrapper.__name__ = func.__name__,但这只解决表面问题:

Mulan AI
Mulan AI

画布式AI视频创作平台,轻松制作爆款视频

下载
  • __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开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

775

2023.06.15

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

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

684

2023.07.20

python能做什么
python能做什么

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

768

2023.07.25

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

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

719

2023.07.31

python教程
python教程

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

1445

2023.08.03

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

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

571

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

751

2023.08.11

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

58

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 20万人学习

Django 教程
Django 教程

共28课时 | 3.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号