『Python』裝飾器

1、參考

做者：zhijun liu
連接：https://www.zhihu.com/question/26930016/answer/99243411
來源：知乎

建議你們去原答案瀏覽

2、裝飾器做用

內褲能夠用來遮羞，可是到了冬天它無法爲咱們防風禦寒，聰明的人們發明了長褲，有了長褲後寶寶不再冷了，裝飾器就像咱們這裏說的長褲，在不影響內褲做用的前提下，給咱們的身子提供了保暖的功效。

再回到咱們的主題

裝飾器本質上是一個Python函數，它可讓其餘函數在不須要作任何代碼變更的前提下增長額外功能，裝飾器的返回值也是一個函數對象。它常常用於有切面需求的場景，好比：插入日誌、性能測試、事務處理、緩存、權限校驗等場景。裝飾器是解決這類問題的絕佳設計，有了裝飾器，咱們就能夠抽離出大量與函數功能自己無關的雷同代碼並繼續重用。歸納的講，裝飾器的做用就是爲已經存在的對象添加額外的功能。

一、裝飾器應用場景

def foo():
    print('i am foo')

 如今有一個新的需求，但願能夠記錄下函數的執行日誌，因而在代碼中添加日誌代碼：

def foo():
    print('i am foo')
    logging.info("foo is running")

 bar()、bar2()也有相似的需求，怎麼作？再寫一個logging在bar函數裏？這樣就形成大量雷同的代碼，爲了減小重複寫代碼，咱們能夠這樣作，從新定義一個函數：專門處理日誌 ，日誌處理完以後再執行真正的業務代碼

def use_logging(func):
    logging.warn("%s is running" % func.__name__)
    func()

def bar():
    print('i am bar')

use_logging(bar)

邏輯上不難理解， 可是這樣的話，咱們每次都要將一個函數做爲參數傳遞給use_logging函數。並且這種方式已經破壞了原有的代碼邏輯結構，以前執行業務邏輯時，執行運行bar()，可是如今不得不改爲use_logging(bar)。那麼有沒有更好的方式的呢？固然有，答案就是裝飾器。

def use_logging(func):

    def wrapper(*args, **kwargs):
        logging.warn("%s is running" % func.__name__)
        return func(*args, **kwargs)
    return wrapper

def bar():
    print('i am bar')

bar = use_logging(bar)
bar()

 函數use_logging就是裝飾器，它把執行真正業務方法的func包裹在函數裏面，看起來像bar被use_logging裝飾了。在這個例子中，函數進入和退出時 ，被稱爲一個橫切面(Aspect)，這種編程方式被稱爲面向切面的編程(Aspect-Oriented Programming)。
@符號是裝飾器的語法糖，在定義函數的時候使用，避免再一次賦值操做

def use_logging(func):  # <-----接收函數對象

    def wrapper(*args, **kwargs):  # <-----接收函數參數
        logging.warn("%s is running" % func.__name__)
        return func(*args)  # <-----返回函數(參數)的執行結果
    return wrapper  # 返回內置函數對象

@use_logging  # 效果就是foo = use_logging(foo)
def foo():
    print("i am foo")

@use_logging
def bar():
    print("i am bar")

bar()

如上所示，這樣咱們就能夠省去bar = use_logging(bar)這一句了，直接調用bar()便可獲得想要的結果。若是咱們有其餘的相似函數，咱們能夠繼續調用裝飾器來修飾函數，而不用重複修改函數或者增長新的封裝。這樣，咱們就提升了程序的可重複利用性，並增長了程序的可讀性。

裝飾器在Python使用如此方便都要歸因於Python的函數能像普通的對象同樣能做爲參數傳遞給其餘函數，能夠被賦值給其餘變量，能夠做爲返回值，能夠被定義在另一個函數內。

二、帶參數的裝飾器

裝飾器還有更大的靈活性，例如帶參數的裝飾器：在上面的裝飾器調用中，好比@use_logging，該裝飾器惟一的參數就是執行業務的函數。裝飾器的語法容許咱們在調用時，提供其它參數，好比@decorator(a)。這樣，就爲裝飾器的編寫和使用提供了更大的靈活性。

def use_logging(level):  # <-----封裝了裝飾器對象，接收全局變量
    def decorator(func):
        def wrapper(*args, **kwargs):
            if level == "warn":
                logging.warn("%s is running" % func.__name__)
            return func(*args)
        return wrapper
    return decorator  # <-----返回裝飾器對象

@use_logging(level="warn")  # 返回了一個帶上下文的裝飾器對象decorator，即一個含有全局變量level="warn"的decorator
def foo(name='foo'):
    print("i am %s" % name)

foo()

 上面的use_logging是容許帶參數的裝飾器。

它其實是對原有裝飾器的一個函數封裝，並返回一個裝飾器。咱們能夠將它理解爲一個含有參數的閉包。

當我 們使用@use_logging(level=」warn」)調用的時候，Python可以發現這一層的封裝，並把參數傳遞到裝飾器的環境中。

三、類裝飾器

再來看看類裝飾器，相比函數裝飾器，類裝飾器具備靈活度大、高內聚、封裝性等優勢。使用類裝飾器還能夠依靠類內部的__call__方法，當使用 @ 形式將裝飾器附加到函數上時，就會調用此方法。

class Foo(object):
    def __init__(self, func):  # <-----初始化時接收函數對象
        self._func = func

    def __call__(self):
        print('class decorator runing')
        self._func()
        print('class decorator ending')


@Foo  # <-----檢測裝飾器爲class時，會使用函數對象初始化類並，調用__call__方法
def bar():
    print('bar')

bar()

 3、裝飾器和 functools.wraps

使用裝飾器極大地複用了代碼，可是他有一個缺點就是原函數的元信息不見了，好比函數的__doc__、__name__、參數列表，先看例子：

def logged(func):
    def with_logging(*args, **kwargs):
        print func.__name__ + " was called"
        return func(*args, **kwargs)
    return with_logging

@logged
def f(x):
   """does some math"""
   return x + x * x

 該函數等價於：

def f(x):
    """does some math"""
    return x + x * x
f = logged(f)

 此時函數f被with_logging取代了，固然它的文檔等信息就變成了with_logging函數的信息了。

print(f.__name__)    # prints 'with_logging'
print(f.__doc__)     # prints None

這個問題就比較嚴重的，好在咱們有functools.wraps，wraps自己也是一個裝飾器，它能把原函數的元信息拷貝到裝飾器函數中，這使得裝飾器函數也有和原函數同樣的元信息了。

from functools import wraps
def logged(func):
    @wraps(func)  # <-----裝飾器內部使用，修飾內置函數，須要參數爲目標函數對象
    def with_logging(*args, **kwargs):
        print func.__name__ + " was called"
        return func(*args, **kwargs)
    return with_logging

@logged
def f(x):
    """does some math"""
    return x + x * x

print(f.__name__)  # prints 'f'
print(f.__doc__ )  # prints 'does some math'

 4、其餘

一、內置裝飾器

@staticmathod、@classmethod、@property

二、多個裝飾器的執行順序

@a @b @c def f ():

 等效於：f = a(b(c(f)))。