python decorator 基础

  一般来说,装饰器是一个函数,接受一个函数(或者类)作为参数,返回值也是也是一个函数(或者类)。首先来看一个简单的例子:
  
 1 # -*- coding: utf-8 -*-
 2 def log_cost_time(func):
 3     def wrapped(*args, **kwargs):
 4         import time
 5         begin = time.time()
 6         try:
 7             return func(*args, **kwargs)
 8         finally:
 9             print 'func %s cost %s' % (func.__name__, time.time() - begin)
10     return wrapped
11 
12 @log_cost_time
13 def complex_func(num):
14     ret = 0
15     for i in xrange(num):
16         ret += i * i
17     return ret
18 #complex_func = log_cost_time(complex_func)
19 
20 if __name__ == '__main__':
21     print complex_func(100000)
code snippet 0

 

  代码中,函数log_cost_time就是一个装饰器,其作用也很简单,打印被装饰函数运行时间。
  装饰器的语法如下:
  @dec
      def func():pass
  本质上等同于: func = dec(func)。
  在上面的代码(code snippet 0)中,把line12注释掉,然后把line18的注释去掉,是一样的效果。另外staticmethod和classmethod是两个我们经常在代码中用到的装饰器,如果对pyc反编译,得到的代码一般也都是 func = staticmthod(func)这种模式。当然,@符号的形式更受欢迎些,至少可以少拼写一次函数名。
    
  装饰器是可以嵌套的,如
    @dec0
    @dec1
    def func():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__)
  • functools.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.

  简单改改代码:
 1 import functools
 2 def log_cost_time(func):
 3     @functools.wraps(func)
 4     def wrapped(*args, **kwargs):
 5         import time
 6         begin = time.time()
 7         try:
 8             return func(*args, **kwargs)
 9         finally:
10             print 'func %s cost %s' % (func.__name__, time.time() - begin)
11     return wrapped

 

  再查看complex_func.__name__ 输出就是 “complex_func”
 
 
  装饰器也是可以带参数的。我们将上面的代码略微修改一下:
   
 1 def log_cost_time(stream):
 2     def inner_dec(func):
 3         def wrapped(*args, **kwargs):
 4             import time
 5             begin = time.time()
 6             try:
 7                 return func(*args, **kwargs)
 8             finally:
 9                 stream.write('func %s cost %s \n' % (func.__name__, time.time() - begin))
10         return wrapped
11     return inner_dec
12 
13 import sys
14 @log_cost_time(sys.stdout)
15 def complex_func(num):
16     ret = 0
17     for i in xrange(num):
18         ret += i * i
19     return ret
20 
21 if __name__ == '__main__':
22     print complex_func(100000)
code snippet 1

 

  log_cost_time函数也接受一个参数,该参数用来指定信息的输出流,对于带参数的decorator
  @dec(dec_args)
  def func(*args, **kwargs):pass
  等价于 func = dec(dec_args)(*args, **kwargs)。
    
  装饰器对类的修饰也是很简单的,只不过平时用得不是很多。举个例子,我们需要给修改类的__str__方法,代码很简单。
   
 1 def Haha(clz):
 2     clz.__str__ = lambda s: "Haha"
 3     return clz
 4 
 5 @Haha
 6 class Widget(object):
 7     ''' class Widget '''
 8 
 9 if __name__ == '__main__':
10     w = Widget()
11     print w

 

  那什么场景下有必要使用decorator呢,设计模式中有一个模式也叫装饰器。我们先简单回顾一下设计模式中的装饰器模式,简单的一句话概述
  动态地为某个对象增加额外的责任
  由于装饰器模式仅从外部改变组件,因此组件无需对它的装饰有任何了解;也就是说,这些装饰对该组件是透明的。
  下图来自《设计模式Java手册》或者GOF的《设计模式》
  
 
  回到Python中来,用decorator语法实现装饰器模式是很自然的,比如文中的示例代码,在不改变被装饰对象的同时增加了记录函数执行时间的额外功能。当然,由于Python语言的灵活性,decorator是可以修改被装饰的对象的(比如装饰类的例子)。decorator在python中用途非常广泛,下面列举几个方面:
  (1)修改被装饰对象的属性或者行为
  (2)处理被函数对象执行的上下文,比如设置环境变量,加log之类
  (3)处理重复的逻辑,比如有N个函数都可能跑出异常,但是我们不关心这些异常,只要不向调用者传递异常就行了,这个时候可以写一个catchall的decorator,作用于所用可能跑出异常的函数
1 def catchall(func):
2     @functools.wraps(func)
3     def wrapped(*args, **kwargs):
4         try:
5             return func(*args, **kwargs)
6         except:
7             pass
8     return wrapped
  (4)框架代码,如flask, bottle等等,让使用者很方便就能使用框架,本质上也避免了重复代码。
 
  decorator的奇妙应用往往超出相应,经常在各种源码中看到各种神奇的用法,酷壳这篇文章举的例子也不错。
 
references
PYTHON修饰器的函数式编程:http://coolshell.cn/articles/11265.html
 
posted @ 2017-01-11 21:24  xybaby  阅读(1913)  评论(0编辑  收藏  举报