Python装饰器中的@wraps的作用和使用

本文介绍Python装饰器@wraps的用法及其如何保持被装饰函数的元信息不变,避免因装饰器使用不当导致的错误。通过具体示例展示如何创建一个带有用户登录验证的装饰器。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Python 装饰器中的@wraps的作用:

  •     装饰器的作用:    在不改变原有功能代码的基础上,添加额外的功能,如用户验证等
  •     @wraps(view_func)的作用:     不改变使用装饰器原有函数的结构(如__name__, __doc__)
  •     不使用wraps可能出现的ERROR:   view_func...endpoint...map...

 

使用方法:

# 创建验证用户登陆功能装饰器
from functools import wraps

def user_login_confirm(view_func):
    @wraps(view_func)
    def wrapper(*args, **kwargs):

        # 验证用户是否登陆 --从session中获取user_id
        user_id = session.get('user_id')

        user = None
        if user_id:
            try:
                from info.models import User
                user = User.query.get(user_id)
            except Exception as e:
                current_app.logger.error(e)
                return jsonify(errno=RET.DBERR, errmsg='查询用户失败')

        # 将user对象保存到给g变量(g对象的值在本次的请求中有效)
        g.user = user

        return view_func(*args, **kwargs)

    return wrapper

 

 

参考文章:https://www.liaoxuefeng.com/wiki/1016959663602400/1017451662295584

-----END-----

 

 

<think>好的,我现在需要帮助用户理解Python中的@wraps装饰器作用。首先,我应该回顾一下装饰器的基本概念,因为@wraps装饰器密切相关。装饰器允许我们扩展函数的功能,但可能会覆盖原函数的元数据,比如__name____doc__。这时候@wraps作用就体现出来了,它能够保留这些元数据。 接下来,我要确保自己正确理解@wraps的功能。根据提供的引用资料,特别是引用[1]到[4],@wraps来自functools模块,用于装饰器内部定义的包装函数。它的主要目的是将原函数的元数据复制到包装函数上,这样在查看函数名或文档字符串时,显示的是原函数的信息,而不是包装函数的。 用户的问题集中在@wraps的功能作用上,所以需要明确回答这点。我需要分步骤解释,首先说明装饰器带来的元数据问题,然后引入@wraps如何解决这个问题。可能还需要通过示例代码对比使用使用@wraps的情况,让用户更直观地看到差异。 同时,用户提供的示例代码中,比如引用[3]中的例子,展示了使用@wraps后,函数a的__name____doc__仍然保持原样,而如果不使用的话,这些属性会指向包装函数b。这可以作为有力的例证来说明@wraps的重要性。 另外,需要指出@wraps的实际应用场景,比如在编写装饰器时,保持被装饰函数的元信息对于调试文档生成非常重要。这能帮助用户理解为什么需要使用这个装饰器,而不仅仅是知道怎么用。 最后,生成相关问题时要考虑用户可能进一步想知道的内容,比如如何正确使用@wraps,或者在不同场景下的应用案例。这样可以帮助用户深入学习解决可能遇到的问题。</think>### Python @wraps 装饰器的功能与作用 #### 1. 装饰器的元数据问题 当使用装饰器包装函数时,原始函数的元数据(如函数名 `__name__`、文档字符串 `__doc__`)会被包装函数的元数据覆盖。例如: ```python def decorator(func): def wrapper(): """包装函数文档""" return func() return wrapper @decorator def original(): """原始函数文档""" pass print(original.__name__) # 输出:wrapper print(original.__doc__) # 输出:包装函数文档 ``` 此时,被装饰的函数 `original` 的元信息丢失,影响调试文档生成[^4]。 #### 2. @wraps 的核心作用 `@wraps` 装饰器通过**复制原函数的元数据到包装函数**,解决上述问题。使用方式如下: ```python from functools import wraps def decorator(func): @wraps(func) # 关键步骤:保留原函数元数据 def wrapper(): """包装函数文档""" return func() return wrapper @decorator def original(): """原始函数文档""" pass print(original.__name__) # 输出:original print(original.__doc__) # 输出:原始函数文档 ``` 此时,被装饰的函数仍保留原始元数据[^2][^3]。 #### 3. 技术实现原理 `@wraps(func)` 实际执行了以下操作: - 将 `func` 的 `__name__`、`__doc__`、`__module__` 等属性复制到包装函数 - 使 `help()` IDE 提示显示原始函数信息 - 支持序列化(如 `pickle`)时识别原始函数[^1] #### 4. 典型应用场景 - 需要保留函数签名的装饰器(如日志记录、性能分析) - 生成API文档时保留函数说明 - 调试时准确定位原始函数位置 ```python from functools import wraps import time def timing_decorator(func): @wraps(func) def wrapper(*args, **kwargs): start = time.time() result = func(*args, **kwargs) end = time.time() print(f"{func.__name__} 耗时: {end-start:.2f}秒") return result return wrapper ``` #### 5. 注意事项 - 必须从 `functools` 导入 `wraps` - 应装饰在包装函数(如 `wrapper`)上,而非装饰器函数本身 - 对类方法装饰时同样有效
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值