Python装饰器丢失原函数信息怎么办_使用functools.wraps保留元数据

胖墨君_7933

胖墨君_7933

2026-04-14

816人浏览

原创

应使用functools.wraps(func)装饰内层wrapper函数,它自动同步__name__、__doc__等元数据并设置__wrapped__属性,避免help()显示错误、文档生成失败等问题。

python装饰器丢失原函数信息怎么办_使用functools.wraps保留元数据

装饰器导致help()和__name__失效怎么办

不加处理的装饰器会让被装饰函数的元数据(比如__name__、__doc__、__module__)变成内层闭包函数的信息,help(func)会显示错误签名,func.__name__变成'wrapper',调试和自动文档生成直接出问题。

根本原因是装饰器返回的是新函数(通常是闭包里的wrapper),它和原函数完全无关。解决方式不是重写装饰器逻辑,而是用functools.wraps做元数据同步:

from functools import wraps
<p>def my_decorator(func):
@wraps(func)  # ← 关键:把func的元数据复制给wrapper
def wrapper(*args, *<em>kwargs):
print("before")
result = func(</em>args, **kwargs)
print("after")
return result
return wrapper</p>

@wraps(func)本质是调用update_wrapper(wrapper, func),把func的__name__、__doc__、__module__、__annotations__等拷贝到wrapper上。

哪些元数据会被functools.wraps保留

functools.wraps默认只同步一组常用字段,不是全部。它实际等价于:update_wrapper(wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)。

  • WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__', '__annotations__')
  • WRAPPER_UPDATES = ('__dict__',)

也就是说:__defaults__、__kwdefaults__、__closure__这些不会被复制——它们属于函数运行时属性,不是“元数据”。如果你依赖inspect.signature()获取参数信息,它仍然能正确解析原函数,因为signature()读的是函数对象本身的__code__,不受wraps影响。

没加@wraps时的典型报错现象

常见于框架集成场景,比如 FastAPI 要求路由函数有明确__name__和__doc__来生成 OpenAPI 文档,或 pytest 依赖__name__识别测试函数名。

Secure Python Code Sandbox
Secure Python Code Sandbox

安全 Python 代码沙箱:在隔离的沙箱中执行任意 Python 代码,预装 requests、NumPy、pandas 库。返回 stdout、stderr。

下载

典型表现包括:

  • help(my_decorated_func) 显示 wrapper(*args, **kwargs) 而非原始签名
  • my_decorated_func.__name__ 返回 'wrapper',而非真实函数名
  • my_decorated_func.__doc__ 为 None,即使原函数写了 docstring
  • 使用 inspect.getfullargspec(my_decorated_func) 可能抛 ValueError: Function has no argument info(极少见,但发生在某些自定义装饰器未正确传递__wrapped__时)

为什么不能手动赋值__name__和__doc__

可以,但不推荐。手动同步容易遗漏字段,比如忘了__qualname__或__annotations__,而这些在 Python 3.10+ 的类型检查、IDE 补全中很关键。

更严重的问题是:functools.wraps还会设置__wrapped__属性,指向原始函数——这是很多工具(如inspect.unwrap()、debugpy断点跳转)依赖的约定。手动赋值做不到这点。

所以哪怕只差一行@wraps(func),也别省。

真正容易被忽略的是:如果装饰器本身带参数(即三层嵌套),@wraps必须放在最内层wrapper上,而不是中间的decorator_factory里。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1811

4

python能做什么
python能做什么

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

2023.07.25

4744

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

28277

23

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

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

2023.08.04

3407

5

python eval
python eval

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

2023.08.04

3407

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2643

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习