裝飾器

裝飾器

---

因爲函數也是一個對象，並且函數對象能夠被賦值給變量，因此，經過變量也能調用該函數。

>>> def now(): ... print('2015-3-25') ... >>> f = now >>> f() 2015-3-25 

函數對象有一個__name__屬性，能夠拿到函數的名字：

>>> now.__name__ 'now' >>> f.__name__ 'now' 

如今，假設咱們要加強now()函數的功能，好比，在函數調用先後自動打印日誌，但又不但願修改now()函數的定義，這種在代碼運行期間動態增長功能的方式，稱之爲「裝飾器」（Decorator）。

本質上，decorator就是一個返回函數的高階函數。因此，咱們要定義一個能打印日誌的decorator，能夠定義以下：

def log(func): def wrapper(*args, **kw): print('call %s():' % func.__name__) return func(*args, **kw) return wrapper 

觀察上面的log，由於它是一個decorator，因此接受一個函數做爲參數，並返回一個函數。咱們要藉助Python的@語法，把decorator置於函數的定義處：

@log def now(): print('2015-3-25') 

調用now()函數，不只會運行now()函數自己，還會在運行now()函數前打印一行日誌：

>>> now()
call now(): 2015-3-25 

把@log放到now()函數的定義處，至關於執行了語句：

now = log(now) 

因爲log()是一個decorator，返回一個函數，因此，原來的now()函數仍然存在，只是如今同名的now變量指向了新的函數，因而調用now()將執行新函數，即在log()函數中返回的wrapper()函數。

wrapper()函數的參數定義是(*args, **kw)，所以，wrapper()函數能夠接受任意參數的調用。在wrapper()函數內，首先打印日誌，再緊接着調用原始函數。

若是decorator自己須要傳入參數，那就須要編寫一個返回decorator的高階函數，寫出來會更復雜。好比，要自定義log的文本：

def log(text): def decorator(func): def wrapper(*args, **kw): print('%s %s():' % (text, func.__name__)) return func(*args, **kw) return wrapper return decorator 

這個3層嵌套的decorator用法以下：

@log('execute') def now(): print('2015-3-25') 

執行結果以下：

>>> now() execute now(): 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 functools def log(func): @functools.wraps(func) def wrapper(*args, **kw): print('call %s():' % func.__name__) return func(*args, **kw) return wrapper 

或者針對帶參數的decorator：

import functools def log(text): def decorator(func): @functools.wraps(func) def wrapper(*args, **kw): print('%s %s():' % (text, func.__name__)) return func(*args, **kw) return wrapper return decorator 

import functools是導入functools模塊。模塊的概念稍候講解。如今，只需記住在定義wrapper()的前面加上@functools.wraps(func)便可。