Python裝飾器學習(十步入門)
一步步深入循序漸進,非常好的教程
第一步:最簡單的函數,準備附加額外功能
# -*- coding:utf-8 -*-
'''示例1: 最簡單的函數,表示調用了兩次'''
def myfunc():
print("myfunc() called.")
myfunc()
myfunc()
第二步:使用裝飾函數在函數執行前和執行後分别附加額外功能
# -*- coding:utf-8 -*-
'''示例2: 替換函數(裝飾)
裝飾函數的參數是被裝飾的函數對象,傳回原函數對象
裝飾的實質語句: myfunc = deco(myfunc)
'''
def deco(func):
print("before myfunc() called.")
func()
print(" after myfunc() called.")
return func
def myfunc():
print(" myfunc() called.")
myfunc = deco(myfunc)
myfunc()
myfunc()
第三步:使用文法糖@來裝飾函數
# -*- coding:utf-8 -*-
'''示例3: 使用文法糖@來裝飾函數,相當于“myfunc = deco(myfunc)”
但發現新函數隻在第一次被調用,且原函數多調用了一次'''
def deco(func):
print("before myfunc() called.")
func()
print(" after myfunc() called.")
return func
@deco
def myfunc():
print(" myfunc() called.")
myfunc()
myfunc()
第四步:使用内嵌包裝函數來確定每次新函數都被調用
# -*- coding:utf-8 -*-
'''示例4: 使用内嵌包裝函數來確定每次新函數都被調用,
内嵌包裝函數的形參和傳回值與原函數相同,裝飾函數傳回内嵌包裝函數對象'''
def deco(func):
def _deco():
print("before myfunc() called.")
func()
print(" after myfunc() called.")
# 不需要傳回func,實際上應傳回原函數的傳回值
return _deco
@deco
def myfunc():
print(" myfunc() called.")
return 'ok'
myfunc()
myfunc()
第五步:對帶參數的函數進行裝飾
# -*- coding:utf-8 -*-
'''示例5: 對帶參數的函數進行裝飾,
内嵌包裝函數的形參和傳回值與原函數相同,裝飾函數傳回内嵌包裝函數對象
'''
def deco(func):
def _deco(a, b):
print("before myfunc() called.")
ret = func(a, b)
print(" after myfunc() called. result: %s" % ret)
return ret
return _deco
@deco
def myfunc(a, b):
print(" myfunc(%s,%s) called." % (a, b))
return a + b
myfunc(1, 2)
myfunc(3, 4)
第六步:對參數數量不确定的函數進行裝飾
# -*- coding:utf-8 -*-
'''示例6: 對參數數量不确定的函數進行裝飾,
參數用(*args, **kwargs),自動适應變參和命名參數
'''
def deco(func):
def _deco(*args, **kwargs):
print("before %s called." % func.__name__)
ret = func(*args, **kwargs)
print(" after %s called. result: %s" % (func.__name__, ret))
return ret
return _deco
@deco
def myfunc(a, b):
print(" myfunc(%s,%s) called." % (a, b))
return a + b
@deco
def myfunc2(a, b, c):
print(" myfunc2(%s,%s,%s) called." % (a, b, c))
return a + b + c
myfunc(1, 2)
myfunc(3, 4)
myfunc2(1, 2, 3)
myfunc2(3, 4, 5)
第七步:讓裝飾器帶參數
# -*- coding:utf-8 -*-
'''示例7: 在示例4的基礎上,讓裝飾器帶參數,
和上一示例相比在外層多了一層包裝。
裝飾函數名實際上應更有意義些
'''
def deco(arg):
def _deco(func):
def __deco():
print("before %s called [%s]." % (func.__name__, arg))
func()
print(" after %s called [%s]." % (func.__name__, arg))
return __deco
return _deco
@deco("mymodule")
def myfunc():
print(" myfunc() called.")
@deco("module2")
def myfunc2():
print(" myfunc2() called.")
myfunc()
myfunc2()
第八步:讓裝飾器帶 類 參數
# -*- coding:utf-8 -*-
'''示例8: 裝飾器帶類參數'''
class locker(object):
def __init__(self):
print("locker.__init__() should be not called.")
@staticmethod
def acquire():
print("locker.acquire() called.(這是靜态方法)")
@staticmethod
def release():
print(" locker.release() called.(不需要對象執行個體)")
def deco(cls):
'''cls 必須實作acquire和release靜态方法'''
def _deco(func):
def __deco():
print("before %s called [%s]." % (func.__name__, cls))
cls.acquire()
try:
return func()
finally:
cls.release()
return __deco
return _deco
@deco(locker)
def myfunc():
print(" myfunc() called.")
myfunc()
myfunc()
第九步:裝飾器帶類參數,并分拆公共類到其他py檔案中,同時示範了對一個函數應用多個裝飾器
# -*- coding:utf-8 -*-
'''mylocker.py: 公共類 for 示例9.py'''
class mylocker:
def __init__(self):
print("mylocker.__init__() called.")
@staticmethod
def acquire():
print("mylocker.acquire() called.")
@staticmethod
def unlock():
print(" mylocker.unlock() called.")
class lockerex(mylocker):
@staticmethod
def acquire():
print("lockerex.acquire() called.")
@staticmethod
def unlock():
print(" lockerex.unlock() called.")
def lockhelper(cls):
'''cls 必須實作acquire和release靜态方法'''
def _deco(func):
def __deco(*args, **kwargs):
print("before %s called." % func.__name__)
cls.acquire()
try:
return func(*args, **kwargs)
finally:
cls.unlock()
return __deco
return _deco
# -*- coding:utf-8 -*-
'''示例9: 裝飾器帶類參數,并分拆公共類到其他py檔案中
同時示範了對一個函數應用多個裝飾器'''
from mylocker import *
class example:
@lockhelper(mylocker)
def myfunc(self):
print(" myfunc() called.")
@lockhelper(mylocker)
@lockhelper(lockerex)
def myfunc2(self, a, b):
print(" myfunc2() called.")
return a + b
if __name__ == "__main__":
a = example()
a.myfunc()
print(a.myfunc())
print(a.myfunc2(1, 2))
print(a.myfunc2(3, 4))
第九步:類裝飾器
# -*- coding:utf-8 -*-
'''示例10: 帶參類裝飾器,利用 __call__ 調用'''
import functools
class Deco(object):
def __init__(self, a): # @類的時候執行
self.a = a
print('server init --')
def __call__(self, f): # 裝飾後的調用執行
print('server call --')
@functools.wraps(f)
def wrapper(*args, **kwargs):
print('before func')
res = f(self.a,*args, **kwargs)
print('after func')
return res
return wrapper
@Deco(123)
def func(*args):
print('--func')
res = sum(args)
return '傳回結果',res
print(func(1, 2, 3))
print('------' * 10)
print(func(4, 5, 6))
下面是參考資料,當初有不少地方沒看明白,真正練習後才明白些:
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
4. 前九步來自 https://blog.csdn.net/dreamcoding/article/details/8611578