2017-09-25

玩转Python装饰器

搞定头疼的Python装饰器

1.定义

装饰器模式是面向对象语言中经典的设计模式之一，它的出现是为了解决在多个函数中添加某一统一的功能，从而减少代码的重用。例如常应用的场景：插入日志，计算性能，缓存运算结果，事务处理等。这里就来了解python中的装饰器。

2.实例分析

首先看个经典的算法题：一个共有10个台阶的楼梯，从下面走到上面，一次只能迈1-3个台阶，并且不能后退，走完这个楼梯有多少种走法？
首先这个题目就是斐波那契数列的一个延伸，无非就是一个递归问题,当然，这里重点是装饰器
这里我们来看看代码：

def climbfloor(n,steps):
   count=0
    if n == 0:
        count=1
    elif n > 0:
        for step in steps:
            count+=climbfloor(n-step,steps)
    return count
    print(climbfloor(10,(1,2,3))

运行后我们很快就能得出结果，但是如果是爬上100、200层楼得出来的运算
这里写图片描述
结果就非常大了，那是不是每次都要重新计算？当然，现在的机器计算速度的很快了，但是如果在多任务处理的情况下，每次重新计算就大大的浪费了资源，影响用户的体验。于是我们可以考虑将运算结果加入缓存，这样下次运算就能直接使用已经计算的结果，所以我们来定义另一个函数，

def memo(func):
    cache = {}
    def wrap(*args):
        if args not in cache:
            cache[args] = func(*args)
        return cache[args]
    return wrap

这个函数传入一个func(函数)参数，加入一个包裹函数wrap()，在包裹函数里面添加缓存功能，并调用func函数。这样就达到了缓存计算结果的效果，然后在打印结果前把需要进行计算的函数传入memo()函数:
climbfloor = memo(climbfloor)
或者直接在原函数上面加入@memo关键字，这实际上是上面那句代码的语法糖，二者是等价的。
这里写图片描述
这样就把需要装饰的函数当作参数传入了装饰器函数，以后只要用到此类计算都可以直接传入装饰器，就可以为函数自动写入缓存功能。

3.定义带参数的装饰器

这里我们实现一个装饰器，用来检查被装饰函数的参数类型，装饰器可以通过参数指明函数参数的类型，并且调用时如果检测出类型不匹配就抛出一个异常，直接看截图，重要注释都标明了。
这里写图片描述
这样再随便写段测试代码

@typeassert(int,str,list)
def f(a,b,c):
    print(a,b,c)
    
f(1,'abc',[1,2,3])
f(1,2,[1,2,3])

点击运行
这里写图片描述
可以看到成功的进行了参数类型的检查这样函数带参数的函数装饰器就完成了

4.实现属性可修改的函数装饰器

现在需要用装饰器计算一个函数的运行时间，设置一个timeout值，如果函数运行时间超过timeout，就在控制台打印出相关信息。这里我们来看看具体代码

def warn(timeout):
    def decorator(func):
        def wrapper(*args,**kargs):
            start = time.time()
            # 传入函数参数
            res = func(*args,**kargs)
            # 计算函数运行所需的时间
            used = time.time() - start
            if used > timeout:
                msg = '"%s": %s > %s'%(func.__name__,used,timeout)
                # 打印msg信息
                logging.warning(msg)
            return res
        return wrapper
    return decorator

这样就可以直接在对任意的函数使用了，现在有一个问题，如果希望在函数运行时动态改变timeout的值，应该怎样做？很简单，只要在装饰器里面再定义一个函数setTimeout(),就可以解决问题了。但是可以看到，运行时间的判断是在wrapper()中的，是一个闭包，我们修改timeout的值应该怎样传递到闭包当中？这里就需要用到nonlocal关键字，用它来声明变量，不是只在当前函数中有效，而是能作用到整个装饰器函数中。这样就直接在decorator()中直接定义一个setTimeout()函数

def setTimeout(k):
    nonlocal timeout
    timeout = k
wrapper.setTimeout = setTimeout

注意这个函数是放在wrapper返回之前的，不然就起不到作用了。
最后进行装饰器的测试


@warn(1.5)
def test():
    print("In sert")
    while randint(0,1):
        time.sleep(0.5)
for _ in range(30):
    test()
test.setTimeout(1)
for _ in range(30):
    test()