Python 在函数上添加包装器
问题
你想在函数上添加一个包装器,增加额外的操作处理(比如日志、计时等)。
解决方案
如果你想使用额外的代码包装一个函数,可以定义一个装饰器函数,例如:
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(10000000) countdown 0.87188299392912 >>>
讨论
一个装饰器就是一个函数,它接受一个函数作为参数并返回一个新的函数。当你像下面这样写:
@timethis def countdown(n): pass
跟像下面这样写其实效果是一样的:
def countdown(n): pass countdown = timethis(countdown)
顺便说一下,内置的装饰器比如 @staticmethod, @classmethod,@property 原理也是一样的。例如,下面这两个代码片段是等价的:
class A: @classmethod def method(cls): pass class B: # Equivalent definition of a class method def method(cls): pass method = classmethod(method)
在上面的 wrapper() 函数中,装饰器内部定义了一个使用 *args 和 **kwargs 来接受任意参数的函数。在这个函数里面调用了原始函数并将其结果返回,不过你还可以添加其他额外的代码(比如计时)。然后这个新的函数包装器被作为结果返回来代替原始函数。
需要强调的是装饰器并不会修改原始函数的参数签名以及返回值。使用 *args 和 **kwargs 目的就是确保任何参数都能适用。而返回结果值基本都是调用原始函数 func(*args, **kwargs) 的返回结果,其中func就是原始函数。
刚开始学习装饰器的时候,会使用一些简单的例子来说明,比如上面演示的这个。不过实际场景使用时,还是有一些细节问题要注意的。比如上面使用 @wraps(func) 注解是很重要的,它能保留原始函数的元数据(下一小节会讲到),新手经常会忽略这个细节。接下来的几个小节我们会更加深入的讲解装饰器函数的细节问题,如果你想构造你自己的装饰器函数,需要认真看一下。
以上就是Python 在函数上添加包装器的详细内容,更多关于Python 添加包装器的资料请关注脚本之家其它相关文章!
相关文章
mac PyCharm添加Python解释器及添加package路径的方法
今天小编就为大家分享一篇mac PyCharm添加Python解释器及添加package路径的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧2018-10-10python多项式拟合之np.polyfit 和 np.polyld详解
这篇文章主要介绍了python多项式拟合之np.polyfit 和 np.polyld的实例代码,python数据拟合主要可采用numpy库,库的安装可直接用pip install numpy等,需要的朋友跟随小编一起学习吧2020-02-02python绕过图片滑动验证码实现爬取PTA所有题目功能 附源码
这篇文章主要介绍了python绕过图片滑动验证码实现爬取PTA所有题目 附源码,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2021-01-01Python OS系统解决路径中空格原因导致文件打不开的问题
这篇文章主要介绍了Python OS系统解决路径中空格原因导致文件打不开的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-02-02
最新评论