0

0

Python 如何让一个函数在被装饰多次后还能正确显示帮助信息

舞夢輝影

舞夢輝影

发布时间:2026-01-17 22:05:22

|

291人浏览过

|

来源于php中文网

原创

Python函数多次装饰后帮助信息丢失,是因为装饰器用新函数替换原函数导致元数据被覆盖;解决方法是每层装饰器内部包装函数均使用@functools.wraps(func)自动复制__name__、__doc__等属性。

python 如何让一个函数在被装饰多次后还能正确显示帮助信息

Python 中函数被多次装饰后帮助信息丢失,是因为装饰器通常会用新函数替换原函数,导致 help()docstring、函数名等元数据被覆盖。解决方法是让装饰器**保留原始函数的元数据**,核心是使用 functools.wraps

@functools.wraps 保留元数据

这是最标准、最推荐的做法。每次写装饰器时,在内层包装函数上加上 @wraps(func),它会自动复制 __name____doc____module____annotations__ 等关键属性。

示例:

from functools import wraps

def log_calls(func): @wraps(func) # ← 关键:保留原函数元数据 def wrapper(*args, *kwargs): print(f"Calling {func.name}") return func(args, **kwargs) return wrapper

def add_one(func): @wraps(func) def wrapper(*args, *kwargs): result = func(args, **kwargs) return result + 1 return wrapper

@log_calls @add_one def square(x): """Return the square of x.""" return x * x

此时 help(square) 正确显示:
Help on function square in module __main__:
square(x)
Return the square of x.

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

Mistral AI
Mistral AI

Mistral AI被称为“欧洲版的OpenAI”,也是目前欧洲最强的 LLM 大模型平台

下载

多层装饰时,每层都要用 @wraps

如果装饰器嵌套三层(比如 @A@B@C → 函数),那么 A、B、C 三个装饰器内部的包装函数都必须各自调用 @wraps。漏掉任意一层,元数据就会在那一层中断。

  • 装饰器本身不加 @wraps → 元数据丢失
  • 只在最外层加,中间层没加 → 中间层已覆盖,外层补救无效
  • 每一层都加 → 原始函数的 __doc__ 和名字能穿透所有层级

检查是否生效的小技巧

调试时可快速验证:

  • print(square.__name__) → 应输出 'square',不是 'wrapper'
  • print(square.__doc__) → 应输出 "Return the square of x."
  • help(square) → 显示内容应和原始函数一致

不推荐的手动复制(仅作了解)

理论上可以手动赋值:

def bad_decorator(func):
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    wrapper.__name__ = func.__name__
    wrapper.__doc__ = func.__doc__
    wrapper.__module__ = func.__module__
    return wrapper

但容易遗漏属性(如 __annotations____dict__),且不可靠。务必优先使用 @functools.wraps

相关专题

更多
python开发工具
python开发工具

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

758

2023.06.15

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

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

639

2023.07.20

python能做什么
python能做什么

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

761

2023.07.25

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

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

618

2023.07.31

python教程
python教程

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

1265

2023.08.03

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

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

548

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相关的文章、下载、课程内容,供大家免费下载体验。

708

2023.08.11

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

42

2026.01.16

热门下载

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

精品课程

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

共4课时 | 2.9万人学习

Django 教程
Django 教程

共28课时 | 3.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

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

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