Python装饰器学习（九步入门）

这是在Python学习小组上介绍的内容，现学现卖、多练习是好的学习方式。

第一步：最简单的函数，准备附加额外功能

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例1: 最简单的函数,表示调用了两次'''  
3.   
4. def myfunc():  
5.     print("myfunc() called.")  
6.   
7. myfunc()  
8. myfunc()  

 

第二步：使用装饰函数在函数执行前和执行后分别附加额外功能

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例2: 替换函数(装饰) 
3. 装饰函数的参数是被装饰的函数对象，返回原函数对象 
4. 装饰的实质语句: myfunc = deco(myfunc)'''  
5.   
6. def deco(func):  
7.     print("before myfunc() called.")  
8.     func()  
9.     print("  after myfunc() called.")  
10.     return func  
11.   
12. def myfunc():  
13.     print(" myfunc() called.")  
14.   
15. myfunc = deco(myfunc)  
16.   
17. myfunc()  
18. myfunc()  

第三步：使用语法糖@来装饰函数

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例3: 使用语法糖@来装饰函数，相当于“myfunc = deco(myfunc)” 
3. 但发现新函数只在第一次被调用，且原函数多调用了一次'''  
4.   
5. def deco(func):  
6.     print("before myfunc() called.")  
7.     func()  
8.     print("  after myfunc() called.")  
9.     return func  
10.  
11. @deco  
12. def myfunc():  
13.     print(" myfunc() called.")  
14.   
15. myfunc()  
16. myfunc()  

第四步：使用内嵌包装函数来确保每次新函数都被调用

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例4: 使用内嵌包装函数来确保每次新函数都被调用， 
3. 内嵌包装函数的形参和返回值与原函数相同，装饰函数返回内嵌包装函数对象'''  
4.   
5. def deco(func):  
6.     def _deco():  
7.         print("before myfunc() called.")  
8.         func()  
9.         print("  after myfunc() called.")  
10.         # 不需要返回func，实际上应返回原函数的返回值  
11.     return _deco  
12.  
13. @deco  
14. def myfunc():  
15.     print(" myfunc() called.")  
16.     return 'ok'  
17.   
18. myfunc()  
19. myfunc()  

第五步：对带参数的函数进行装饰

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例5: 对带参数的函数进行装饰， 
3. 内嵌包装函数的形参和返回值与原函数相同，装饰函数返回内嵌包装函数对象'''  
4.   
5. def deco(func):  
6.     def _deco(a, b):  
7.         print("before myfunc() called.")  
8.         ret = func(a, b)  
9.         print("  after myfunc() called. result: %s" % ret)  
10.         return ret  
11.     return _deco  
12.  
13. @deco  
14. def myfunc(a, b):  
15.     print(" myfunc(%s,%s) called." % (a, b))  
16.     return a + b  
17.   
18. myfunc(1, 2)  
19. myfunc(3, 4)  

第六步：对参数数量不确定的函数进行装饰

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例6: 对参数数量不确定的函数进行装饰， 
3. 参数用(*args, **kwargs)，自动适应变参和命名参数'''  
4.   
5. def deco(func):  
6.     def _deco(*args, **kwargs):  
7.         print("before %s called." % func.__name__)  
8.         ret = func(*args, **kwargs)  
9.         print("  after %s called. result: %s" % (func.__name__, ret))  
10.         return ret  
11.     return _deco  
12.  
13. @deco  
14. def myfunc(a, b):  
15.     print(" myfunc(%s,%s) called." % (a, b))  
16.     return a+b  
17.  
18. @deco  
19. def myfunc2(a, b, c):  
20.     print(" myfunc2(%s,%s,%s) called." % (a, b, c))  
21.     return a+b+c  
22.   
23. myfunc(1, 2)  
24. myfunc(3, 4)  
25. myfunc2(1, 2, 3)  
26. myfunc2(3, 4, 5)  

第七步：让装饰器带参数

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例7: 在示例4的基础上，让装饰器带参数， 
3. 和上一示例相比在外层多了一层包装。 
4. 装饰函数名实际上应更有意义些'''  
5.   
6. def deco(arg):  
7.     def _deco(func):  
8.         def __deco():  
9.             print("before %s called [%s]." % (func.__name__, arg))  
10.             func()  
11.             print("  after %s called [%s]." % (func.__name__, arg))  
12.         return __deco  
13.     return _deco  
14.  
15. @deco("mymodule")  
16. def myfunc():  
17.     print(" myfunc() called.")  
18.  
19. @deco("module2")  
20. def myfunc2():  
21.     print(" myfunc2() called.")  
22.   
23. myfunc()  
24. myfunc2()  

第八步：让装饰器带 类 参数

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例8: 装饰器带类参数'''  
3.   
4. class locker:  
5.     def __init__(self):  
6.         print("locker.__init__() should be not called.")  
7.          
8.     @staticmethod  
9.     def acquire():  
10.         print("locker.acquire() called.（这是静态方法）")  
11.          
12.     @staticmethod  
13.     def release():  
14.         print("  locker.release() called.（不需要对象实例）")  
15.   
16. def deco(cls):  
17.     '''''cls 必须实现acquire和release静态方法'''  
18.     def _deco(func):  
19.         def __deco():  
20.             print("before %s called [%s]." % (func.__name__, cls))  
21.             cls.acquire()  
22.             try:  
23.                 return func()  
24.             finally:  
25.                 cls.release()  
26.         return __deco  
27.     return _deco  
28.  
29. @deco(locker)  
30. def myfunc():  
31.     print(" myfunc() called.")  
32.   
33. myfunc()  
34. myfunc()  

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

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''mylocker.py: 公共类 for 示例9.py'''  
3.   
4. class mylocker:  
5.     def __init__(self):  
6.         print("mylocker.__init__() called.")  
7.          
8.     @staticmethod  
9.     def acquire():  
10.         print("mylocker.acquire() called.")  
11.          
12.     @staticmethod  
13.     def unlock():  
14.         print("  mylocker.unlock() called.")  
15.   
16. class lockerex(mylocker):  
17.     @staticmethod  
18.     def acquire():  
19.         print("lockerex.acquire() called.")  
20.          
21.     @staticmethod  
22.     def unlock():  
23.         print("  lockerex.unlock() called.")  
24.   
25. def lockhelper(cls):  
26.     '''''cls 必须实现acquire和release静态方法'''  
27.     def _deco(func):  
28.         def __deco(*args, **kwargs):  
29.             print("before %s called." % func.__name__)  
30.             cls.acquire()  
31.             try:  
32.                 return func(*args, **kwargs)  
33.             finally:  
34.                 cls.unlock()  
35.         return __deco  
36.     return _deco  

[python]  view plain  copy

1. # -*- coding:gbk -*-  
2. '''''示例9: 装饰器带类参数，并分拆公共类到其他py文件中 
3. 同时演示了对一个函数应用多个装饰器'''  
4.   
5. from mylocker import *  
6.   
7. class example:  
8.     @lockhelper(mylocker)  
9.     def myfunc(self):  
10.         print(" myfunc() called.")  
11.  
12.     @lockhelper(mylocker)  
13.     @lockhelper(lockerex)  
14.     def myfunc2(self, a, b):  
15.         print(" myfunc2() called.")  
16.         return a + b  
17.   
18. if __name__=="__main__":  
19.     a = example()  
20.     a.myfunc()  
21.     print(a.myfunc())  
22.     print(a.myfunc2(1, 2))  
23.     print(a.myfunc2(3, 4))  

下面是参考资料，当初有不少地方没看明白，真正练习后才明白些：

1. Python装饰器学习 http://blog.csdn.net/thy38/article/details/4471421

2. Python装饰器与面向切面编程 http://www.cnblogs.com/huxi/archive/2011/03/01/1967600.html

3. Python装饰器的理解 http://apps.hi.baidu.com/share/detail/17572338