Python进阶之装饰器@decorator

什么是装饰器

本文参照慕课网廖学峰老师的视频教程整理

demo下载地址 ：https://github.com/adamin1990/pydecorator

1. 定义了一个函数
2. 想在运行时动态增加功能
3. 又不想改动函数本身的代码

装饰器的作用

可极大的简化代码，避免每个函数编写重复性代码
1. 打印日志 @log
2. 检测性能 @performance
3. 数据库事务 @transaction
4. URL路由 @post(‘/register’)

Practice

1.编写无参数decorator

Python的 decorator 本质上就是一个高阶函数，它接收一个函数作为参数，然后，返回一个新函数。
使用 decorator 用Python提供的 @ 语法，这样可以避免手动编写 f = decorate(f) 这样的代码。
考察一个@log的定义：

def log(f):    def fn(x):        print 'call ' + f.__name__ + '()...'        return f(x)    return fn

对于阶乘函数，@log工作得很好：

@logdef factorial(n):    return reduce(lambda x,y: x*y, range(1, n+1))print factorial(10)

结果：

call factorial()...3628800

但是，对于参数不是一个的函数，调用将报错：

@logdef add(x, y):    return x + yprint add(1, 2)

结果：

Traceback (most recent call last):  File "test.py", line 15, in <module>    print add(1,2)TypeError: fn() takes exactly 1 argument (2 given)

因为 add() 函数需要传入两个参数，但是 @log 写死了只含一个参数的返回函数。
要让 @log 自适应任何参数定义的函数，可以利用Python的 *args 和 **kw，保证任意个数的参数总是能正常调用：

def log(f):    def fn(*args, **kw):        print 'call ' + f.__name__ + '()...'        return f(*args, **kw)    return fn

另一个例子 编写一个 @performance 他可以打印出函数调用的时间

from functools import reduce__author__ = 'Administrator'import  timedef performance(f):    def fn(*args,**kwargs):        t1=time.time()        r=f(*args,**kwargs)        t2=time.time()        print("call %s() in %fs"%(f.__name__,(t2-t1)))        return r    return fn@performancedef factorial(n):    return reduce(lambda  x,y:x*y,range(1,n+1))print(factorial(10))

再来个例子

__author__ = 'Administrator'def deco(func):    """    对带参数的函数进行装饰    :param func:    :return:    """    def _deco(a,b):        print("调用钱")        ret =func(a,b)        print("调用后")        return ret    return _deco@decodef myfun(a,b):    print("myfun(%s,%s)中"%(a,b))    return a+bmyfun(1,2)myfun(3,4)

2.编写带参数的decorator

考察上一节的 @log 装饰器：

def log(f):    def fn(x):        print 'call ' + f.__name__ + '()...'        return f(x)    return fn

发现对于被装饰的函数，log打印的语句是不能变的（除了函数名）。
如果有的函数非常重要，希望打印出’[INFO] call xxx()…’，有的函数不太重要，希望打印出’[DEBUG] call xxx()…’，这时，log函数本身就需要传入’INFO’或’DEBUG’这样的参数，类似这样：

@log('DEBUG')def my_func():    pass

把上面的定义翻译成高阶函数的调用，就是：

my_func = log('DEBUG')(my_func)

上面的语句看上去还是比较绕，再展开一下：

log_decorator = log('DEBUG')my_func = log_decorator(my_func)

上面的语句又相当于：

log_decorator = log('DEBUG')@log_decoratordef my_func():    pass

所以，带参数的log函数首先返回一个decorator函数，再让这个decorator函数接收my_func并返回新函数：

def log(prefix):    def log_decorator(f):        def wrapper(*args, **kw):            print '[%s] %s()...' % (prefix, f.__name__)            return f(*args, **kw)        return wrapper    return log_decorator@log('DEBUG')def test():    passprint test()

执行结果：

[DEBUG] test()...None

对于这种3层嵌套的decorator定义，你可以先把它拆开：

# 标准decorator:def log_decorator(f):    def wrapper(*args, **kw):        print '[%s] %s()...' % (prefix, f.__name__)        return f(*args, **kw)    return wrapperreturn log_decorator# 返回decorator:def log(prefix):    return log_decorator(f)

拆开以后会发现，调用会失败，因为在3层嵌套的decorator定义中，最内层的wrapper引用了最外层的参数prefix，所以，把一个闭包拆成普通的函数调用会比较困难。不支持闭包的编程语言要实现同样的功能就需要更多的代码。
习题
上一节的@performance只能打印秒，请给 @performace 增加一个参数，允许传入’s’或’ms’：

@performance('ms')def factorial(n):    return reduce(lambda x,y: x*y, range(1, n+1))

代码

from functools import reduceimport time__author__ = 'Administrator'def performance(unit):    def perf_decorator(f):        def wrapper(*args,**kwargs):            t1=time.time();            r=f(*args,**kwargs)            t2=time.time()            t=(t2-t1)*1000 if unit=="ms" else (t2-t1)            print("call %s() in %f %s"%(f.__name__ ,t,unit))            return r        return wrapper    return perf_decorator@performance('ms')def factorial(n):    return reduce(lambda x,y:x*y,range(1,n+1))print(factorial(10))

再来一个例子

__author__ = 'Administrator'def deco(arg):    def _deco(func):        def __deco():            print("%s 调用 [%s]之前" % (func.__name__,arg))            func();            print("%s 调用 [%s]之后" %( func.__name__,arg))        return __deco    return _deco@deco("mymodule")def myfunc():    print("myfunc调用")@deco("module2")def myfunc2():    print("module2调用")myfunc()myfunc2()

3.完善decorator

@decorator可以动态实现函数功能的增加，但是，经过@decorator“改造”后的函数，和原函数相比，除了功能多一点外，有没有其它不同的地方？
在没有decorator的情况下，打印函数名：

def f1(x):    passprint f1.__name__

输入 f1
有decorator的情况下，再打印函数名：

def log(f):    def wrapper(*args, **kw):        print 'call...'        return f(*args, **kw)    return wrapper@logdef f2(x):    passprint f2.__name__

输出 wrapper

可见，由于decorator返回的新函数函数名已经不是‘f2’，而是@log内部定义的‘wrapper’。这对于那些依赖函数名的代码就会失效。decorator还改变了函数的_doc_等其它属性。如果要让调用者看不出一个函数经过了@decorator的“改造”，就需要把原函数的一些属性复制到新函数中：

def log(f):    def wrapper(*args, **kw):        print 'call...'        return f(*args, **kw)    wrapper.__name__ = f.__name__    wrapper.__doc__ = f.__doc__    return wrapper

这样写decorator很不方便，因为我们也很难把原函数的所有必要属性都一个一个复制到新函数上，所以Python内置的functools可以用来自动化完成这个“复制”的任务：

import functoolsdef log(f):    @functools.wraps(f)    def wrapper(*args, **kw):        print 'call...'        return f(*args, **kw)    return wrapper

最后需要指出，由于我们把原函数签名改成了(*args, **kw)，因此，无法获得原函数的原始参数信息。即便我们采用固定参数来装饰只有一个参数的函数：

def log(f):    @functools.wraps(f)    def wrapper(x):        print 'call...'        return f(x)    return wrapper

也可能改变原函数的参数名，因为新函数的参数名始终是 ‘x’，原函数定义的参数名不一定叫 ‘x’。

练习

请思考带参数的@decorator，@functools.wraps应该放置在哪：

def performance(unit):    def perf_decorator(f):        def wrapper(*args, **kw):            ???        return wrapper    return perf_decorator

代码

import time, functoolsdef performance(unit):    def perf_decorator(f):        @functools.wraps(f)        def wrapper(*args, **kw):            t1 = time.time()            r = f(*args, **kw)            t2 = time.time()            t = (t2 - t1) * 1000 if unit=='ms' else (t2 - t1)            print 'call %s() in %f %s' % (f.__name__, t, unit)            return r        return wrapper    return perf_decorator@performance('ms')def factorial(n):    return reduce(lambda x,y: x*y, range(1, n+1))print factorial.__name__

4.装饰器带类参数

__author__ = 'Administrator'class locker:    """    装饰器带类参数    """    def __init__(self):        print("locher init 不应该调用")    @staticmethod    def acquire():        print("locker.acquire() called.（这是静态方法）")    @staticmethod    def release():        print("realease 方法调用，不需要对象实例")def deco(cls):    '''    cls 必须实现 acquire和release静态方法    :param cls:    :return:    '''    def _deco(func):        def __deco():            print("%s 调用 %s 之前"%(func.__name__,cls))            cls.acquire()            try:                return func()            finally:                cls.release()        return __deco    return _deco@deco(locker)def myfunc():    print("myfunc()调用")myfunc()myfunc()

执行结果

D:\Python34\python.exe D:/py/pydecorator/test7.pymyfunc 调用 <class '__main__.locker'> 之前locker.acquire() called.（这是静态方法）myfunc()调用realease 方法调用，不需要对象实例myfunc 调用 <class '__main__.locker'> 之前locker.acquire() called.（这是静态方法）myfunc()调用realease 方法调用，不需要对象实例

5.装饰器带类参数，并分拆公共类到其他py文件中，同时演示了对一个函数应用多个装饰器

class mylocker：

__author__ = 'Administrator'class mylocker:    def __init__(self):        print("mylocker.__init__() called.")    @staticmethod    def acquire():        print("mylocker.acquire() called.")    @staticmethod    def unlock():        print("  mylocker.unlock() called.")class lockerex(mylocker):    @staticmethod    def acquire():        print("lockerex.acquire() called.")    @staticmethod    def unlock():        print("  lockerex.unlock() called.")def lockhelper(cls):    '''cls 必须实现acquire和release静态方法'''    def _deco(func):        def __deco(*args, **kwargs):            print("before %s called." % func.__name__)            cls.acquire()            try:                return func(*args, **kwargs)            finally:                cls.unlock()        return __deco    return _deco

from mylocker import *class example:    @lockhelper(mylocker)    def myfunc(self):        print(" myfunc() called.")    @lockhelper(mylocker)    @lockhelper(lockerex)    def myfunc2(self, a, b):        print(" myfunc2() called.")        return a + bif __name__=="__main__":    a = example()    a.myfunc()    print(a.myfunc())    print(a.myfunc2(1, 2))    print(a.myfunc2(3, 4))