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

本文章轉自廖雪峯的官方站點 https://www.liaoxuefeng.com/wiki/897692888725344/923030163290656