0

0

Python functools.wraps 的必要性解析

舞夢輝影

舞夢輝影

发布时间:2026-02-11 21:17:31

|

442人浏览过

|

来源于php中文网

原创

不加 @functools.wraps 会导致被装饰函数的 name__、__doc__、__module__、__annotations 等元信息丢失,变为包装函数的值,影响调试、文档生成、类型检查和框架路由注册。

python functools.wraps 的必要性解析

装饰器里不加 @functools.wraps 会丢掉什么

函数的 __name____doc____module____annotations__ 这些元信息全都会变成内层包装函数的,而不是原始函数的。调试、文档生成(比如 Sphinx)、类型检查(mypy)、甚至某些框架的路由注册(如 FastAPI)都依赖这些字段。

常见错误现象:help(my_decorated_func) 显示的是包装函数的空文档;用 inspect.signature() 拿到的是包装函数的签名,不是原函数的;日志里打出来的函数名是 wrapper 而不是你写的 fetch_user

  • 所有被装饰函数的 __name__ 默认变成 'wrapper'
  • __doc__ 变成 None 或包装函数自己的字符串
  • IDE 自动补全和跳转可能失效(尤其依赖 __qualname__ 的场景)

@functools.wraps(func) 到底做了哪些事

它不是魔法,只是把 func 的关键属性批量复制到包装函数上。底层调用的是 functools.WRAPPER_ASSIGNMENTSfunctools.WRAPPER_UPDATES 定义的字段列表。

实际等价于手动写:

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

def wrapper(*args, **kwargs):
    ...
wrapper.__name__ = func.__name__
wrapper.__doc__ = func.__doc__
wrapper.__module__ = func.__module__
wrapper.__annotations__ = func.__annotations__
wrapper.__dict__.update(func.__dict__)

但别手写——漏掉 __dict__ 更新会导致自定义属性丢失;漏掉 __annotations__ 会让类型提示失效;而 @wraps 一行就覆盖全部。

云点滴客户关系管理CRM OA系统
云点滴客户关系管理CRM OA系统

云点滴客户解决方案是针对中小企业量身制定的具有简单易用、功能强大、永久免费使用、终身升级维护的智能化客户解决方案。依托功能强大、安全稳定的阿里云平 台,性价比高、扩展性好、安全性高、稳定性好。高内聚低耦合的模块化设计,使得每个模块最大限度的满足需求,相关模块的组合能满足用户的一系列要求。简单 易用的云备份使得用户随时随地简单、安全、可靠的备份客户信息。功能强大的报表统计使得用户大数据分析变的简单,

下载
  • 它只复制明确列出的属性,不碰 __code____defaults__(那些属于行为,不是元数据)
  • 不影响函数执行逻辑,纯粹是“让外人认得出来这是谁”
  • Python 3.5+ 后还顺带处理了 __wrapped__ 属性(指向原函数),方便解包

不加 @wraps 在真实项目里踩过哪些坑

不是“看起来不太好看”,而是直接导致工具链断裂。比如:

  • FastAPI 把装饰后函数的 __name__ 当作路由 endpoint 名,结果 OpenAPI 文档里全是 wrapper
  • mypy 报错 Argument 1 has incompatible type "Callable[..., Any]",因为签名丢失后类型推导失败
  • pytest 收集测试时,test_foo.py::wrapper 出现在报告里,根本找不到对应源码位置
  • logging.getLogger(__name__) 的模块名变成 functools,日志全串了

这些都不是报错,而是静默错位——问题往往在集成阶段才暴露,查起来绕一大圈。

什么时候可以不用 @functools.wraps

极少。只有两种情况:你明确认为「这个装饰器就是故意要隐藏原函数身份」,或者「这个函数压根不会被反射、调试、文档化、类型检查」。

  • 写一次性脚本里的私有装饰器,且全程不用 help()inspect、IDE 补全
  • 做 AOP 式日志埋点,且日志里只记时间戳和参数,不记函数名

但只要涉及协作、维护、或任何自动化工具链,就默认加上。它成本为零,收益确定——漏掉一次,排查半天。

最常被忽略的其实是 __annotations____wrapped__:前者影响类型安全,后者是调试时唯一能快速回溯到原始函数的线索。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

27

2025.12.22

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

92

2026.02.06

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

488

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

214

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1547

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

637

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

841

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

813

2024.04.29

2026春节习俗大全
2026春节习俗大全

本专题整合了2026春节习俗大全,阅读专题下面的文章了解更多详细内容。

68

2026.02.11

热门下载

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

精品课程

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

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.5万人学习

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

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