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保留函数元信息的资料请关注脚本之家其它相关文章！
相关文章
这篇文章主要介绍了Python脚本实现网卡流量监控,本文直接给出实现代码,需要的朋友可以参考下2015-02-02
这篇文章主要介绍了Python操作MongoDB增删改查代码示例,需要的朋友可以参考下2022-12-12
下面小编就为大家分享一篇Python 实现一行输入多个值的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2018-04-04
这篇文章主要为大家详细介绍了python递归函数绘制分形树的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2018-06-06
这篇文章主要给大家介绍了关于Django中cookie的基本使用的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧。2018-02-02
python email smtplib模块发送邮件代码实例
本篇文章给大家分享了python email smtplib模块发送邮件的相关代码分享，有需要的朋友参考学习下。2018-04-04
今天小编就为大家分享一篇python查看列的唯一值方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2018-07-07
这篇文章主要介绍了Python实现按特定格式对文件进行读写的方法,可实现文件按原有格式读取与写入的功能,涉及文件的读取、遍历、转换、写入等相关操作技巧,需要的朋友可以参考下2017-11-11
这篇文章主要介绍了python实现随机密码字典生成器示例,需要的朋友可以参考下2014-04-04
Detours是微软发布的一个API hook框架，同时支持x86和x64，看文档说也支持ARM和ARM64的Windows，这篇文章主要介绍了封装Detours用于Python中x64函数hook,需要的朋友可以参考下2023-12-12
最新评论