(轉載)Python裝飾器學習

轉載出處：http://www.cnblogs.com/rhcad/archive/2011/12/21/2295507.html

這是在Python學習小組上介紹的内容，現學現賣、多練習是好的學習方式。

第一步：最簡單的函數，準備附加額外功能

1 # -*- coding:gbk -*-
2 '''示例1: 最簡單的函數,表示調用了兩次'''
3  
4 def myfunc():
5     print("myfunc() called.")
6  
7 myfunc()
8 myfunc()      

第二步：使用裝飾函數在函數執行前和執行後分别附加額外功能

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()      

第三步：使用文法糖@來裝飾函數

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()      

第四步：使用内嵌包裝函數來確定每次新函數都被調用

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()      

第五步：對帶參數的函數進行裝飾

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)      

第六步：對參數數量不确定的函數進行裝飾

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)      

第七步：讓裝飾器帶參數

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  //可看成是 xx = deco("mymodule")  myfunc = xx(myfunc),合并 myfunc = deco("mymodule")(myfunc)
19 @deco("module2")
20 def myfunc2():
21     print(" myfunc2() called.")
22  
23 myfunc()
24 myfunc2()      

第八步：讓裝飾器帶 類 參數

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檔案中，同時示範了對一個函數應用多個裝飾器

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      

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