0

0

Python中functools中wraps_Python装饰器中functools.wraps的作用

月夜之吻

月夜之吻

发布时间:2026-01-09 03:15:23

|

165人浏览过

|

来源于php中文网

原创

functools.wraps用于修复装饰后函数的元信息,避免__name__、__doc__等属性丢失;不加会导致help()显示wrapper、函数名变为'wrapper'、签名获取失败及框架注册异常。

python中functools中wraps_python装饰器中functools.wraps的作用

functools.wraps 用来修复被装饰函数的元信息

不加 functools.wraps,装饰器会“吃掉”原函数的 __name____doc____module__ 等属性,导致调试、文档生成、IDE跳转等功能异常。它不是让装饰器“生效”,而是让装饰后的函数看起来还是原来的函数。

不加 wraps 会发生什么

典型表现是:help() 显示的是内层闭包函数(比如 wrapper)的信息,而不是被装饰的函数;func.__name__ 变成 'wrapper';用 inspect.signature() 获取参数签名失败;某些框架(如 Flask、Click)依赖函数名做路由或命令注册,会出错。

  • 错误现象示例:
    def my_decorator(func):
        def wrapper(*args, **kwargs):
            return func(*args, **kwargs)
        return wrapper
    

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

    print(say_hello.name) # 输出:wrapper(不是 say_hello) print(say_hello.doc) # 输出:None(不是 "Say hello to someone.")

加 wraps 的标准写法

functools.wraps 接收原始函数作为参数,返回一个修饰器,用于装饰内部的 wrapper 函数。它本质是批量复制 __name____doc____annotations____module__ 等关键属性。

  • 必须用在 wrapper 函数定义上方,不能漏掉括号:@functools.wraps(func)
  • 不能写成 @functools.wraps(不带括号),否则报 TypeError: wraps() missing 1 required argument
  • 如果装饰器本身带参数(即三层嵌套),wraps 仍作用于最内层的 wrapper
import functools

def my_decorator(func): @functools.wraps(func) # ← 关键一行 def wrapper(*args, *kwargs): print("Before call") result = func(args, **kwargs) print("After call") return result return wrapper

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

print(say_hello.name) # 输出:say_hello print(say_hello.doc) # 输出:"Say hello to someone." print(say_hello.annotations) # 输出:{'name': , 'return': }

为什么 wraps 不是自动做的

Python 装饰器机制本身只是语法糖(@dec 等价于 f = dec(f)),语言不干涉你返回什么对象。functools.wraps 是一种约定俗成的“礼貌行为”,但不是强制规范。有些场景反而要故意隐藏原函数信息(比如权限拦截器不想暴露真实接口名),这时候就不该用 wraps

赣极购物商城网店建站软件系统
赣极购物商城网店建站软件系统

大小仅1兆左右 ,足够轻便的商城系统; 易部署,上传空间即可用,安全,稳定; 容易操作,登陆后台就可设置装饰网站; 并且使用异步技术处理网站数据,表现更具美感。 前台呈现页面,兼容主流浏览器,DIV+CSS页面设计; 如果您有一定的网页设计基础,还可以进行简易的样式修改,二次开发, 发布新样式,调整网站结构,只需修改css目录中的css.css文件即可。 商城网站完全独立,网站源码随时可供您下载

下载

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

容易忽略的一点:如果装饰器中修改了 __annotations__ 或动态加了 __dict__ 属性,wraps 不会同步这些改动——它只复制默认的可读元信息。需要额外处理时得手动赋值。

相关专题

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

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

738

2023.06.15

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

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

634

2023.07.20

python能做什么
python能做什么

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

755

2023.07.25

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

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

617

2023.07.31

python教程
python教程

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

1259

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

577

2023.08.04

scratch和python区别
scratch和python区别

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

705

2023.08.11

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

2

2026.01.09

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.1万人学习

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

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