Python中装饰器的总结

装饰器(decorator)功能

引入日志
函数执行时间统计
执行函数前预备处理
执行函数后清理功能
权限校验等场景
缓存

装饰器示例

例1:无参数的函数

from timeimport ctime, sleepdeftimefun(func):defwrappedfunc():
        print("%s called at %s"%(func.__name__, ctime()))
        func()return wrappedfunc@timefundeffoo():
    print("I am foo")

foo()
sleep(2)
foo()

• 
  
• 分析如下：
  

上面代码理解装饰器执行行为可理解成
foo = timefun(foo)
1，foo先作为参数赋值给func后,foo接收指向timefun返回的wrappedfunc
2，调用foo(),即等价调用wrappedfunc()
3，内部函数wrappedfunc被引用，所以外部函数的func变量(自由变量)并没有释放
4，func里保存的是原foo函数对象

例2:被装饰的函数有参数

from timeimport ctime, sleepdeftimefun(func):defwrappedfunc(a, b):
        print("%s called at %s"%(func.__name__, ctime()))
        print(a, b)
        func(a, b)return wrappedfunc@timefundeffoo(a, b):
    print(a+b)

foo(3,5)
sleep(2)
foo(2,4)

例3:被装饰的函数有不定长参数

from timeimport ctime, sleepdeftimefun(func):defwrappedfunc(*args, **kwargs):
        print("%s called at %s"%(func.__name__, ctime()))
        func(*args, **kwargs)return wrappedfunc@timefundeffoo(a, b, c):
    print(a+b+c)

foo(3,5,7)
sleep(2)
foo(2,4,9)

例4:装饰器中的return

from timeimport ctime, sleepdeftimefun(func):defwrappedfunc():
        print("%s called at %s"%(func.__name__, ctime()))
        func()return wrappedfunc@timefundeffoo():
    print("I am foo")@timefundefgetInfo():return'----hahah---'

foo()
sleep(2)
foo()


print(getInfo())
执行结果:

foo called at Sun Jun1800:31:532017
I am foo
foo called at Sun Jun1800:31:552017
I am foo
getInfo called at Sun Jun1800:31:552017None

如果修改装饰器为return func()，则运行结果：

foo called at Sun Jun1800:34:122017
I am foo
foo called at Sun Jun1800:34:142017
I am foo
getInfo called at Sun Jun1800:34:142017
----hahah---

总结：

一般情况下为了让装饰器更通用，可以有return

例5:装饰器带参数,在原有装饰器的基础上，设置外部变量

from timeimport ctime, sleepdeftimefun_arg(pre="hello"):deftimefun(func):defwrappedfunc():
            print("%s called at %s %s"%(func.__name__, ctime(), pre))return func()return wrappedfuncreturn timefun@timefun_arg("itcast")deffoo():
    print("I am foo")@timefun_arg("python")deftoo():
    print("I am too")

foo()
sleep(2)
foo()

too()
sleep(2)
too()
可以理解为

foo()==timefun_arg("itcast")(foo)()

例6：类装饰器

装饰器函数其实是这样一个接口约束，它必须接受一个callable对象作为参数，然后返回一个callable对象。在Python中一般callable对象都是函数，但也有例外。只要某个对象重写了call() 方法，那么这个对象就是callable的。

classTest():def__call__(self):
        print('call me!')

t = Test()
t()# call me
类装饰器democlassTest(object):def__init__(self, func):
        print("---初始化---")
        print("func name is %s"%func.__name__)
        self.__func = funcdef__call__(self):
        print("---装饰器中的功能---")
        self.__func()

说明：
1. 当用Test来装作装饰器对test函数进行装饰的时候，首先会创建Test的实例对象,并且会把test这个函数名当做参数传递到init方法中
即在init方法中的func变量指向了test函数体
2. test函数相当于指向了用Test创建出来的实例对象
3. 当在使用test()进行调用时，就相当于让这个对象()，因此会调用这个对象的call方法
4. 为了能够在call方法中调用原来test指向的函数体，所以在init方法中就需要一个实例属性来保存这个函数体的引用
所以才有了self.func = func这句代码，从而在调用__call方法中能够调用到test之前的函数体
@Test
def test():
print(“—-test—”)
test()
showpy()#如果把这句话注释，重新运行程序，依然会看到”–初始化–”

运行结果如下：

---初始化---funcnameistest---装饰器中的功能-------test---

wraps函数

使用装饰器时，有一些细节需要被注意。例如，被装饰后的函数其实已经是另外一个函数了（函数名等函数属性会发生改变）。

添加后由于函数名和函数的doc发生了改变，对测试结果有一些影响，例如:

defnote(func):"note function"defwrapper():"wrapper function"
        print('note something')return func()return wrapper@notedeftest():"test function"
    print('I am test')

test()
print(test.__doc__)

运行结果

note something
I am test
wrapperfunction

所以，Python的functools包中提供了一个叫wraps的装饰器来消除这样的副作用。例如：

import functoolsdefnote(func):"note function"@functools.wraps(func)defwrapper():"wrapper function"
        print('note something')return func()return wrapper@notedeftest():"test function"
    print('I am test')

test()
print(test.__doc__)

运行结果

note something
I am test
testfunction