Python如何创建装饰器时保留函数元信息
更新时间：2020年08月07日 16:00:04 作者：D
这篇文章主要介绍了Python如何创建装饰器时保留函数元信息，文中讲解非常细致，帮助大家更好的理解和学习，感兴趣的朋友可以了解下
问题
你写了一个装饰器作用在某个函数上，但是这个函数的重要的元信息比如名字、文档字符串、注解和参数签名都丢失了。
解决方案
任何时候你定义装饰器的时候，都应该使用 functools 库中的 @wraps 装饰器来注解底层包装函数。例如：
import time
from functools import wraps
def timethis(func):
'''
Decorator that reports the execution time.
'''
@wraps(func)
def wrapper(*args, **kwargs):
start = time.time()
result = func(*args, **kwargs)
end = time.time()
print(func.__name__, end-start)
return result
return wrapper
下面我们使用这个被包装后的函数并检查它的元信息：
>>> @timethis
... def countdown(n):
... '''
... Counts down
... '''
... while n > 0:
... n -= 1
...
>>> countdown(100000)
countdown 0.008917808532714844
>>> countdown.__name__
'countdown'
>>> countdown.__doc__
'\n\tCounts down\n\t'
>>> countdown.__annotations__
{'n': <class 'int'>}
>>>
讨论
在编写装饰器的时候复制元信息是一个非常重要的部分。如果你忘记了使用 @wraps ， 那么你会发现被装饰函数丢失了所有有用的信息。比如如果忽略 @wraps 后的效果是下面这样的：
>>> countdown.__name__
'wrapper'
>>> countdown.__doc__
>>> countdown.__annotations__
{}
>>>
@wraps 有一个重要特征是它能让你通过属性 __wrapped__ 直接访问被包装函数。例如:
>>> countdown.__wrapped__(100000) >>>
__wrapped__ 属性还能让被装饰函数正确暴露底层的参数签名信息。例如：
>>> from inspect import signature >>> print(signature(countdown)) (n:int) >>>
一个很普遍的问题是怎样让装饰器去直接复制原始函数的参数签名信息， 如果想自己手动实现的话需要做大量的工作，最好就简单的使用 @wraps 装饰器。 通过底层的 __wrapped__ 属性访问到函数签名信息。
以上就是Python如何创建装饰器时保留函数元信息的详细内容，更多关于Python保留函数元信息的资料请关注脚本之家其它相关文章！
相关文章
下面小编就为大家分享一篇JavaScript实现一维数组转化为二维数组，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2018-04-04
这篇文章主要为大家介绍了Python并发编程之线程消息通信机制的示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步2021-10-10
这篇文章主要介绍了Django静态资源部署404问题解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-05-05
今天小编就为大家分享一篇Python使用正则表达式分割字符串的实现方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2019-07-07
这篇文章主要介绍了python采用django框架实现支付宝即时到帐接口的相关资料,需要的朋友可以参考下2016-05-05
这篇文章主要介绍了python通过ftplib登录到ftp服务器的方法,涉及Python使用ftplib模块的相关技巧,需要的朋友可以参考下2015-05-05
Python脚本,标识符,变量使用,脚本语句,注释,模块引用详解
这篇文章主要为大家详细介绍了Python脚本,标识符,变量使用,脚本语句,注释,模块引用，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-02-02
在元组和列表中，都是通过编号进行元素的访问，但有的时候我们按名字进行数据甚至数据结构的访问，在python中也提供了内置的映射类型--字典。映射其实就是一组key和value以及之间的映射函数，其特点是：key的唯一性、key与value的一对多的映射。2014-10-10
这篇文章主要介绍了PyTorch-GPU加速实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-06-06
在学习Python的过程中我们会发现有一个类 Object类 ,它是所有类的父类,Object类规定了python用于类的内置函数,今天我们就来看看几个常用的特殊方法吧2023-03-03
最新评论