舉例講解Python中裝飾器的用法

>>> def now():
... print '2013-12-25'
...
>>> f = now
>>> f()
2013-12-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 '2013-12-25'

調用now()函數，不僅會運行now()函數本身，還會在運行now()函數前打印一行日志：

>>> now()
call now():
2013-12-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 '2013-12-25'

執行結果如下：

>>> now()
execute now():
2013-12-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)即可。
小結

在面向對象（OOP）的設計模式中，decorator被稱為裝飾模式。OOP的裝飾模式需要通過繼承和組合來實現，而Python除了能支持OOP的decorator外，直接從語法層次支持decorator。Python的decorator可以用函數實現，也可以用類實現。

decorator可以增強函數的功能，定義起來雖然有點復雜，但使用起來非常靈活和方便。

請編寫一個decorator，能在函數調用的前后打印出'begin call'和'end call'的日志。

再思考一下能否寫出一個@log的decorator，使它既支持：

@log
def f():
 pass

又支持：

@log('execute')
def f():
 pass

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com