讲师中心 微信公众号
AI工具推荐 视频效率加速

Python中使用装饰器处理函数异常时如何保留原始函数的元数据?

老浩君_5000

老浩君_5000

发布时间:2026-07-20 06:32:26

|

775人浏览过

|

来源于php中文网

原创

@functools.wraps是必须的,因为它将原函数的__module__、__name__、__doc__、__annotations__等元数据复制到包装函数,避免help()、inspect.signature()等返回装饰器内部信息而丢失原始函数文档和类型提示。

python中使用装饰器处理函数异常时如何保留原始函数的元数据?

为什么@functools.wraps是必须的?

直接用装饰器包裹函数后,help()、inspect.signature()、__name__、__doc__这些都会变成装饰器内部函数的信息,不是原始函数的。比如你写了个retry_on_failure装饰器,但调用help(my_func)却显示“这是重试装饰器”,这就没法调试、IDE 也无法正确补全参数。

根本原因是 Python 默认不自动复制元数据,装饰器本质是把新函数赋值给原名,覆盖了原始对象的属性。

  • @functools.wraps(func)会把func的__module__、__name__、__qualname__、__doc__、__annotations__等全部拷贝到包装函数上
  • 它底层调用的是functools.update_wrapper(),但@wraps更简洁、更常用
  • 不加它,my_func.__name__会变成'wrapper',而不是你定义的函数名

异常处理装饰器里怎么正确用@wraps?

常见错误是把@wraps放在错的位置——它必须作用在内层包装函数上,不是外层装饰器工厂函数。

比如你要写一个捕获ValueError并返回默认值的装饰器:

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载

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

from functools import wraps
<p>def catch_value_error(default=None):
def decorator(func):
@wraps(func)  # ← 这里!不是放在 catch_value_error 上
def wrapper(*args, *<em>kwargs):
try:
return func(</em>args, **kwargs)
except ValueError:
return default
return wrapper
return decorator

如果漏掉@wraps(func),哪怕只装饰一个函数,my_func.__doc__也会丢失;如果用了typing.get_type_hints(my_func),还会因__annotations__为空而报错。

  • 装饰器带参数(如catch_value_error(default=...))时,@wraps一定在最内层wrapper定义前
  • 不带参数的装饰器(直接@catch_exc),也一样:在def wrapper之前加@wraps(func)
  • 别试图手动赋值wrapper.__name__ = func.__name__——漏掉__annotations__或__dict__可能引发后续问题

保留元数据后还可能出什么问题?

@wraps能解决大部分元数据丢失问题,但有些场景它帮不上忙:

  • inspect.signature()在某些动态生成函数(如用exec()或types.FunctionType构造)上仍可能失效,因为签名信息没被写入__signature__
  • 如果你在wrapper里修改了**kwargs或重写了参数逻辑,inspect.signature(wrapper)显示的仍是原始函数签名,和实际行为不一致——这是设计使然,不是 bug
  • Pydantic 或 FastAPI 这类依赖函数签名做校验的框架,会读__signature__,所以即使@wraps生效,也要确保wrapper的调用协议和原函数兼容

简单说:@wraps让元数据“看起来对”,但不保证运行时行为完全透明。异常处理装饰器若改变了参数传递方式(比如强制注入retry_times),就得额外处理签名。

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

1751

2023.07.20

python能做什么
python能做什么

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

4504

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

26537

2023.08.03

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

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

3207

2023.08.04

python eval
python eval

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

3227

2023.08.04

scratch和python区别
scratch和python区别

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

1183

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn