Python 中的 @wraps 装饰器使用详解

   


概要

在Python编程中,装饰器(decorators)是一种非常强大的工具,可以在不修改原有函数代码的前提下,扩展函数的功能。而在编写装饰器时,functools模块中的@wraps装饰器是一个不可或缺的工具。本文将详细介绍@wraps的作用和使用方法,并通过示例代码展示其实际应用。


一、什么是装饰器?

在深入了解@wraps之前,我们先简单介绍一下装饰器。装饰器本质上是一个高阶函数,它接受一个函数作为参数,并返回一个新函数。装饰器常用于在函数执行前后添加额外的行为,如日志记录、访问控制、缓存等。

示例代码:

def my_decorator(func):
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper

@my_decorator
def say_hello():
    print("Hello!")

say_hello()

在这个示例中,my_decorator是一个装饰器,它在目标函数say_hello执行前后打印额外的信息。

二、@wraps的作用

当我们使用装饰器时,装饰后的函数实际上是包装器函数(wrapper function),而不是原来的函数。这会导致一些问题,例如:

  1. 原函数的名称和文档字符串(docstring)被包装器函数覆盖。

  2. 原函数的属性(如__name____doc__)丢失。

为了解决

  • 23
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
@wraps是functools模块的一个装饰器函数,它的作用是用来修饰一个装饰器函数,使得被修饰的函数保留原来的函数名和文档字符串。当一个函数被修饰时,它的__name__属性将变成装饰器函数的名字,而不是被修饰函数的名字。同时,它还会将被修饰函数的__doc__属性(即文档字符串)也赋值给修饰后的函数。 在引用的示例使用了@wraps修饰器来装饰my_decorator函数内部的wrapper函数。这样一来,当使用my_decorator装饰test函数时,不仅保留了test函数的名字和文档字符串,还将装饰器函数的名字和文档字符串赋值给了被修饰后的函数。 而在引用的示例,未使用@wraps修饰器,所以被修饰的函数test在被调用后,其__name__属性变成了wrapper,而不是test,同时__doc__属性也变成了装饰器函数的文档字符串,而不是被修饰函数的文档字符串。 通过使用@wraps修饰器,可以解决被修饰函数的一些属性被覆盖的问题,保证被修饰函数在被调用时能够保留原有的属性。这在一些需要对函数进行装饰的场景非常有用。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [Python @wraps的用法](https://blog.csdn.net/weixin_42596275/article/details/125967916)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *3* [python被修饰的函数消失问题解决(基于wraps函数)](https://download.csdn.net/download/weixin_38611812/12858449)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Rocky006

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值