python进阶一（函数式编程）【1-8 python中decorator装饰器】

python中编写无参数decorator

Python的 decorator 本质上就是一个高阶函数，它接收一个函数作为参数，然后，返回一个新函数。

使用 decorator 用Python提供的 @ 语法，这样可以避免手动编写f = decorate(f) 这样的代码。

考察一个@log的定义：

def log(f):#编写一个装饰器，本质就是一个高阶函数，接受一个函数（f）作为参数，然后返回一个新函数fn
    def fn(x):
        print 'call ' + f.__name__ + '()...'#实现打印函数调用
        return f(x)#返回一个函数，对于f(x)，只有一个参数x
    return fn#返回一个新函数

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

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

结果：

call factorial()...
3628800

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

@log
def add(x, y):
    return x + y
print 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，它可以打印出函数调用的时间。

import time

def performance(f):#编写一个时间装饰器，用来打印调用函数的时间
    def fn(*args,**kw):#自适应任何参数定义，保证了任意个数的参数总是能正常调用
        t1 = time.time()#调用前计时
        r = f(*args,**kw)#这里f是要调用的那个函数
        t2 = time.time()#调用完计时
        print 'call %s() in %fs' %(f.__name__, (t2-t1))
        return r#返回函数
    return fn#返回新的函数fn
        

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

print factorial(10)

 

python中编写带参数decorator

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

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

如果有的函数非常重要，希望打印出'[INFO] call xxx()...'，有的函数不太重要，希望打印出'[DEBUG] call xxx()...'，这时，log函数本身就需要传入'INFO'或'DEBUG'这样的参数，类似这样：

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

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

my_func = log('DEBUG')(my_func)

带参数的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():
    pass
print test()

任务

上一节的@performance只能打印秒，请给 @performace 增加一个参数，允许传入's'或'ms'：

import time
def performance(unit):#带参装饰器（需要三层嵌套decorator），参数是unit，这里是单位ms
    def perf_decorator(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)#这判断用时是否是毫秒，time默认时间单位是s，如果是s，就乘1000，如果是ms，直接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)

 

python中完善decorator

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

在没有decorator的情况下，打印函数名：

def f1(x):
    pass
print f1.__name__

输出： f1

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

def log(f):
    def wrapper(*args, **kw):
        print 'call...'
        return f(*args, **kw)
    return wrapper
@log
def f2(x):
    pass
print 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 functools
def log(f):
    @functools.wraps(f)
    def wrapper(*args, **kw):
        print 'call...'
        return f(*args, **kw)
    return wrapper

任务

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

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

import time, functools
def 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__