---1---
假設我們要增強某個
函數的功能,比如,在函數調用前后自動打印日志,但又不希望修改某個
函數的定義,這種在代碼運行期間動態增加功能的方式,稱之為“裝飾器”(Decorator).
裝飾器本質上是一個Python函數,它可以讓其他函數在不需要做任何代碼變動的前提下增加額外功能,裝飾器的返回值也是一個函數對象。它經常用于有切面需求的場景,比如:插入日志、性能測試、事務處理、緩存、權限校驗等場景。裝飾器是解決這類問題的絕佳設計,有了裝飾器,我們就可以抽離出大量與函數功能本身無關的雷同代碼并繼續重用。概括的講,裝飾器的作用就是為已經存在的對象添加額外的功能。
---2---
本質上,decorator就是一個返回函數的高階函數。所以,我們要定義一個能打印日志的decorator.
觀察下面的代碼:
?
def log(func):def wrapper(*args, **kw):print('call %s():' % func.__name__)return func(*args, **kw)return wrapper
@log
def now():print('2015-3-25')
把@log
放到now()
函數的定義處,相當于執行了語句:
now = log(now)
由于log()
是一個decorator,返回一個函數,所以,原來的now()
函數仍然存在,只是現在同名的now
變量指向了新的函數,于是調用now()
將執行新函數,即在log()
函數中返回的wrapper()
函數。
wrapper()
函數的參數定義是(*args, **kw)
,因此,wrapper()
函數可以接受任意參數的調用。在wrapper()
函數內,首先打印日志,再緊接著調用原始函數。
---3---
如果decorator本身需要傳入參數,那就需要編寫一個返回decorator的高階函數,寫出來會更復雜。比如,要自定義log的文本:
def log(text):def decorator(func):def wrapper(*args, **kw):print('%s %s():' % (text, func.__name__))return func(*args, **kw)return wrapperreturn decorator
這個3層嵌套的decorator用法如下:
@log('execute')
def now():print('2015-3-25')
和兩層嵌套的decorator相比,3層嵌套的效果是這樣的:
>>> now = log('execute')(now)
我們來剖析上面的語句,首先執行log('execute')
,返回的是decorator
函數,再調用返回的函數,參數是now
函數,返回值最終是wrapper
函數。
以上兩種decorator的定義都沒有問題,但還差最后一步。因為我們講了函數也是對象,它有__name__
等屬性,但你去看經過decorator裝飾之后的函數,它們的__name__
已經從原來的'now'
變成了'wrapper'
:
>>> now.__name__
'wrapper'
因為返回的那個wrapper()
函數名字就是'wrapper'
,所以,需要把原始函數的__name__
等屬性復制到wrapper()
函數中,否則,有些依賴函數簽名的代碼執行就會出錯。
不需要編寫wrapper.__name__ = func.__name__
這樣的代碼,Python內置的functools.wraps
就是干這個事的,所以,一個完整的decorator的寫法如下:
import functoolsdef log(func):@functools.wraps(func)def wrapper(*args, **kw):print('call %s():' % func.__name__)return func(*args, **kw)return wrapper
或者針對帶參數的decorator:
import functoolsdef log(text):def decorator(func):@functools.wraps(func)def wrapper(*args, **kw):print('%s %s():' % (text, func.__name__))return func(*args, **kw)return wrapperreturn decorator
上面的東西看的一知半解的,看完下面的這一段應該會好點:
def check_is_admin(f):def wrapper(*args,**kwargs):if kwargs.get('username') != 'admin':raise Exception("This user is not allowed to get food")return f(*args, **kwargs)return wrapperclass Storage(object):@check_is_admindef get_food(self, username,food):return Storage.get(food)@check_is_admindef put_food(self,username,food):return Storage.put(food)
?
參考:
(1).https://www.liaoxuefeng.com/wiki/1016959663602400/1017451662295584(廖雪峰官方文檔)
(2).https://www.zhihu.com/question/21408921/answer/129036707?(怎樣才能寫出 Pythonic 的代碼?)
(3).https://www.zhihu.com/question/26930016/answer/99243411? ?(如何理解Python裝飾器?)
?
?