0

0

Python functools.wraps 的重要性

冰川箭仙

冰川箭仙

发布时间:2026-01-26 18:15:23

|

912人浏览过

|

来源于php中文网

原创

不加 @functools.wraps(func) 会导致被装饰函数的 name__、__doc__、__module__、__qualname__、__annotations 等元信息丢失,变为 wrapper 函数的信息,引发调试、文档生成、类型检查及框架反射(如 FastAPI、pytest)异常。

python functools.wraps 的重要性

为什么 functools.wraps 不能省略

直接说结论:不加 @functools.wraps(func) 的装饰器,会让被装饰函数的元信息(__name____doc____module__ 等)全部丢失,变成内层包装函数的信息。这在调试、文档生成、类型检查、框架反射(如 FastAPI 路由注册、pytest 参数发现)中会出问题。

functools.wraps 修复哪些具体字段

它本质是调用 update_wrapper,把原函数的关键属性复制给包装函数。默认同步以下字段:

  • __module__:避免显示为 functools 或装饰器所在模块
  • __name__:否则 my_func.__name__ 变成 wrapper
  • __qualname__:影响嵌套函数和类方法的路径表示
  • __doc__:否则 help(my_func) 或 Sphinx 文档抓不到说明
  • __annotations__:类型提示丢失,mypy 和 IDE 自动补全失效

不加 @wraps 的典型报错场景

这些不是语法错误,但会让工具链“认不出”你的函数:

西安网上购物网店系统
西安网上购物网店系统

西安网上购物网店系统的主要亮点:(1)商品的分类更加细化和明朗,可以三级分类,价格可以多层次\多级别,按照后台设置的,吸引会员加入。(2)会员和非会员购物并存,订单直接支付和会员帐户支付并存,电话支付与网上支付多种支付方式。(3)自定义商品扩展属性,多种扩展属性定义模式,强大的商品管理功能,多重分类功能(4)灵活的会员积分系统,灵活的会员权限控制,模版丰富多彩,模版代码分离,方便修改模版(5)支付

下载
  • FastAPI 报 TypeError: Unable to extract signature for ... —— 因为 inspect.signature() 拿不到原函数签名
  • pytest 发现不了测试函数:若用 @pytest.mark.parametrize 套在没 @wraps 的装饰器上,可能跳过执行
  • help(my_decorated_func) 显示空文档或 Help on function wrapper in module ...
  • 日志里记录函数名变成 wrapper,排查时无法定位真实逻辑

一个最小可验证示例

from functools import wraps

def my_decorator(func): def wrapper(*args, *kwargs): print("before") result = func(args, **kwargs) print("after") return result

忘记加 @wraps(func) → 元信息全丢

return wrapper

@my_decorator def greet(name: str) -> str: """Say hello to someone.""" return f"Hello, {name}!"

print(greet.name) # 输出 'wrapper',不是 'greet' print(greet.doc) # 输出 None print(greet.annotations) # 输出 {},不是 {'name': , 'return': }

只需在 def wrapper 后加一行 @wraps(func),所有字段立刻恢复。这个细节小,但一旦漏掉,在协作或集成时容易卡住别人——尤其是当函数要被其他库自动扫描时,它不会报错,只会静默失效。

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

778

2023.06.15

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

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

685

2023.07.20

python能做什么
python能做什么

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

769

2023.07.25

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

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

739

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中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

580

2023.08.04

scratch和python区别
scratch和python区别

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

752

2023.08.11

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

23

2026.01.26

热门下载

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

精品课程

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

共4课时 | 21.8万人学习

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号