Python进阶(一) 装饰器

装饰器@ 在阅读源码时经常遇到，所以有必要弄明白！

概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能；

本质上，装饰器就是一个返回函数的高阶函数。其接受一个函数作为参数，并返回一个函数。 借助Python的@语法，把装饰器置于函数的定义处，实现功能扩展的目的；

（一）需要用装饰器的原因

先来看一个例子：

def f0():
    print('11111111')

f0()

这个函数的功能是打印出一窜字符窜。如果想要测试执行这个函数用了多长时间，我们可以这样做：

import time

def f0():
    start = time.clock()
    print('11111111')
    end = time.clock()
    print('used:', end - start)

f0()

 这样能够很好的达到目的。但是想测试一个模块的所有函数的执行时间呢，就得把所有函数中都加入如上时间差的计算方法，这样不太现实。

为了不改变原来的函数，我们可以定义一个函数timeit，将f0()的引用传递给他，然后在timeit中调用f0并进行计时，这样我们就不用修改f0函数而达到目的了:

import time

def f0():
    print('11111111')

def timeit(fc):
    start = time.clock()
    fc()
    end = time.clock()
    print( 'used:', end - start)

timeit(f0)

这样看上去逻辑没有问题，而且可以正常的工作。但却修改了调用部分的代码，原本是f0()调用，现在却成了timeit(f0)，如果f0在很多处都被调用了，就需要在很多处修改代码。注：这也是接下来的代码里，在timeit()函数里需要再定义一个wrapper()函数的原因.

如果不改动调用的代码，也就意味着调用f0()需要产生timeit(f0)的效果。我们可以这样做，把timeit(f0)的返回值付给f0，然后直接调用f0()，就不用修改源代码了：

import time

def f0():
    print('111111111111')

def timeit(fc):
    def wrapper():
        start = time.clock()
        fc()
        end = time.clock()
        print('used:', end - start)

    return wrapper

f0 = timeit(f0)
f0()

 这样，我们需在定义f0以后和调用f0之前，加上f0=timeit(f0)，就可以达到目的了。这就是修饰器，看起来像f0被timeit修饰了。

上面的代码，看似没法再精简了，python于是提供了一个特殊的语法来降低字符输入量：

import time

def timeit(fc):
    def wrapper():
        start = time.clock()
        fc()
        end = time.clock()
        print('used:', end - start)

    return wrapper

@timeit
def f0():
    print('11111111')

f0()

在第12行的@timeit，效果和f0=timeit(f0)一样，而且看上去更有修饰器的感觉。

这就是Python中修饰器的原理。

参考 https://www.tuicool.com/articles/6Z3Mbuj

（二）装饰器使用方法

函数作为一个对象：① 可以被赋值给其他变量，可以作为返回值      ② 也可以被定义在另外一个函数内；

装饰器分类：有参/无参

① 无参：用于生成一个新的装饰器函数   

② 有参：先处理这个参数，再生成一个新的装饰器函数，然后对其做装饰；

例

按照装饰器与函数各自是否有参，组合共4中：

① 无参的装饰器 ，包装无参的函数  —— 不需要针对参数进行处理和优化

def F(fc): #装饰器F无参
    print ('2222222')
    return fc

@F
def f0(): #函数无参
    print('1111111')

f0()

等价于

def F(fc):
    print ('2222222')
    return fc

def f0():
    print('1111111')

f0 = F(f0)
f0()

② 无参的装饰器 ，包装有参的函数

def F(fc): #装饰器无参
    def handle_args(*args, **kwargs): #处理传入函数的参数
        print("1111111")
        fc(*args, **kwargs) #函数调用
        print("2222222")
    return handle_args

@F
def f1(a, b=2): #函数有参
    print(a, b)

f1(1)

等价于

def F(fc):
    def handle_args(*args, **kwargs):
        print("1111111")
        fc(*args, **kwargs)
        print("2222222")
    return handle_args

def f1(a, b=2):
    print(a, b)

f1 = F(f1)
f1(1)

③ 有参的装饰器 ，包装无参的函数

def F(arg): #装饰器的参数arg
    print(arg)
    #最终被返回的函数
    def newDecorator(fc):
        print(fc)
        return fc
    return newDecorator

@F('11111111')
def f2(): #函数无参
    print('22222222')

f2()

等价于

def F(arg):
    print(arg)
    def newDecorator(fc):
        print(fc)
        return fc
    return newDecorator

def f2():
    print('22222222')

f2 = F('111111')(f2)
f2()

④ 有参的装饰器 ，包装有参的函数

def F(arg): #装饰器参数
    def handle_func(fc):
        def handle_args(*args, **kwargs): #'*'返回list或tuple，'**'返回dict
            print('11111111')
            fc(*args, **kwargs)
            print('22222222')
            print(arg, fc, args, kwargs)
        return handle_args
    return handle_func

@F('123')
def f3(a, b=2): #函数参数
    print('3333333333')

f3(1, b=3)

等价于

def F(arg):
    def handle_func(fc):
        def handle_args(*args, **kwargs):
            print('11111111')
            fc(*args, **kwargs)
            print('22222222')
            print(arg, fc, args, kwargs)
        return handle_args
    return handle_func

def f3(a, b=2):
    print('3333333333')

f3 = F('123')(f3)
f3(1, b=3)

 

注：有3个内置的装饰器 staticmethod, classmethod, property 。

参考：http://wklken.me/posts/2012/10/27/python-base-decorator.html