Python中Decorator的作用是什么
导读:本文共2656.5字符,通常情况下阅读需要9分钟。同时您也可以点击右侧朗读,来听本文内容。按键盘←(左) →(右) 方向键可以翻页。
摘要: 首先来看一个简单的例子:#-*-coding:utf-8-*-deflog_cost_time(func):defwrapped(*args,**kwargs):importtimebegin=time.time()try:returnfunc(*args,**kwargs)finally:print'func%scost%s'%(func.__... ...
目录
(为您整理了一些要点),点击可以直达。首先来看一个简单的例子:
#-*-coding:utf-8-*-deflog_cost_time(func):defwrapped(*args,**kwargs):importtimebegin=time.time()try:returnfunc(*args,**kwargs)finally:print'func%scost%s'%(func.__name__,time.time()-begin)returnwrapped@log_cost_timedefcomplex_func(num):ret=0foriinxrange(num):ret+=i*ireturnret#complex_func=log_cost_time(complex_func)if__name__=='__main__':printcomplex_func(100000)codesnippet0
代码中,函数log_cost_time就是一个装饰器,其作用也很简单,打印被装饰函数运行时间。
装饰器的语法如下:
@decdeffunc():pass
本质上等同于: func = dec(func)。
在上面的代码(code snippet 0)中,把line12注释掉,然后把line18的注释去掉,是一样的效果。另外staticmethod和classmethod是两个我们经常在代码中用到的装饰器,如果对pyc反编译,得到的代码一般也都是 func = staticmthod(func)这种模式。当然,@符号的形式更受欢迎些,至少可以少拼写一次函数名。
装饰器是可以嵌套的,如
@dec0@dec1deffunc():pass
等将于 func = dec0(dec1(fun))。
装饰器也有“副作用“”,对于被log_cost_time装饰的complex_calc, 我们查看一下complex_func.__name__,输出是:”wrapped“”。额,这个是log_cost_time里面inner function(wrapped)的名字,调用者当然希望输出是”complex_func”,为了解决这个问题,python提供了两个函数。
functools.update_wrapper
原型: functools.update_wrapper(wrapper, wrapped[, assigned][, updated])
第三个参数,将wrapped的值直接复制给wrapper,默认为(__doc__, __name__, __module__)
第四个参数,update,默认为(__dict__)
unctools.wraps: update_wrapper的封装
This is a convenience function for invoking partial(update_wrapper,wrapped=wrapped,assigned=assigned,updated=updated) as a function decorator when defining a wrapper function.
简单改改代码:
importfunctoolsdeflog_cost_time(func):@functools.wraps(func)defwrapped(*args,**kwargs):importtimebegin=time.time()try:returnfunc(*args,**kwargs)finally:print'func%scost%s'%(func.__name__,time.time()-begin)returnwrapped
再查看complex_func.__name__ 输出就是 “complex_func”
装饰器也是可以带参数的。我们将上面的代码略微修改一下:
deflog_cost_time(stream):definner_dec(func):defwrapped(*args,**kwargs):importtimebegin=time.time()try:returnfunc(*args,**kwargs)finally:stream.write('func%scost%s\n'%(func.__name__,time.time()-begin))returnwrappedreturninner_decimportsys@log_cost_time(sys.stdout)defcomplex_func(num):ret=0foriinxrange(num):ret+=i*ireturnretif__name__=='__main__':printcomplex_func(100000)codesnippet1
log_cost_time函数也接受一个参数,该参数用来指定信息的输出流,对于带参数的decorator
@dec(dec_args)deffunc(*args,**kwargs):pass
等价于 func = dec(dec_args)(*args, **kwargs)。
装饰器对类的修饰也是很简单的,只不过平时用得不是很多。举个例子,我们需要给修改类的__str__方法,代码很简单。
defHaha(clz):clz.__str__=lambdas:"Haha"returnclz@HahaclassWidget(object):'''classWidget'''if__name__=='__main__':w=Widget()printw
那什么场景下有必要使用decorator呢,设计模式中有一个模式也叫装饰器。我们先简单回顾一下设计模式中的装饰器模式,简单的一句话概述
动态地为某个对象增加额外的责任
由于装饰器模式仅从外部改变组件,因此组件无需对它的装饰有任何了解;也就是说,这些装饰对该组件是透明的。
下图来自《设计模式Java手册》或者GOF的《设计模式》
回到Python中来,用decorator语法实现装饰器模式是很自然的,比如文中的示例代码,在不改变被装饰对象的同时增加了记录函数执行时间的额外功能。当然,由于Python语言的灵活性,decorator是可以修改被装饰的对象的(比如装饰类的例子)。decorator在python中用途非常广泛,下面列举几个方面:
(1)修改被装饰对象的属性或者行为
(2)处理被函数对象执行的上下文,比如设置环境变量,加log之类
(3)处理重复的逻辑,比如有N个函数都可能跑出异常,但是我们不关心这些异常,只要不向调用者传递异常就行了,这个时候可以写一个catchall的decorator,作用于所用可能跑出异常的函数
defcatchall(func):@functools.wraps(func)defwrapped(*args,**kwargs):try:returnfunc(*args,**kwargs)except:passreturnwrapped
</div> <div class="zixun-tj-product adv-bottom"></div> </div> </div> <div class="prve-next-news">
Python中Decorator的作用是什么的详细内容,希望对您有所帮助,信息来源于网络。