如何寫一個簡單的裝飾器

今天介紹的是一個已經(jīng)存在十三年，但是依舊不紅的庫 decorator，好像很少有人知道他的存在一樣。

這個庫可以幫你做什么呢 ？

其實很簡單，就是可以幫你更方便地寫python裝飾器代碼，更重要的是，它讓 Python 中被裝飾器裝飾后的方法長得更像裝飾前的方法。

本篇文章不會過多的向你介紹裝飾器的基本知識，我會默認(rèn)你知道什么是裝飾器，并且懂得如何寫一個簡單的裝飾器。

不了解裝飾器的可以先去閱讀我之前寫的文章，非常全且詳細(xì)的介紹了裝飾器的各種實現(xiàn)方法。

1. 常規(guī)的裝飾器

下面這是一個最簡單的裝飾器示例，在運行 myfunc 函數(shù)的前后都會打印一條日志。

def deco(func):
    def wrapper(*args, **kw):
        print("Ready to run task")
        func(*args, **kw)
        print("Successful to run task")
    return wrapper

@deco
def myfunc():
    print("Running the task")

myfunc()

裝飾器使用起來，似乎有些高端和魔幻，對于一些重復(fù)性的功能，往往我們會封裝成一個裝飾器函數(shù)。

在定義一個裝飾器的時候，我們都需要像上面一樣機械性的寫一個嵌套的函數(shù)，對裝飾器原理理解不深的初學(xué)者，往往過段時間就會忘記如何定義裝飾器。

有一些比較聰明的同學(xué)，會利用 PyCharm 來自動生成裝飾器模板

然后要使用的時候，直接敲入 deco 就會生成一個簡單的生成器代碼，提高編碼的準(zhǔn)備效率

2. 使用神庫

使用 PyCharm 的 Live Template ，雖然能降低編寫裝飾器的難度，但卻要依賴 PyCharm 這一專業(yè)的代碼編輯器。

這里，明哥要教你一個更加簡單的方法，使用這個方法呢，你需要先安裝一個庫 ：decorator，使用 pip 可以很輕易地去安裝它

$ python3 -m pip install decorator

從庫的名稱不難看出，這是一個專門用來解決裝飾器問題的第三方庫。

有了它之后，你會驚奇的發(fā)現(xiàn)，以后自己定義的裝飾器，就再也不需要寫嵌套的函數(shù)了

from decorator import decorator

@decorator
def deco(func, *args, **kw):
    print("Ready to run task")
    func(*args, **kw)
    print("Successful to run task")

@deco
def myfunc():
    print("Running the task")

myfunc()

deco 作為裝飾函數(shù)，第一個參數(shù)是固定的，都是指被裝飾函數(shù)，而后面的參數(shù)都固定使用 可變參數(shù) *args 和 **kw 的寫法，代碼被裝飾函數(shù)的原參數(shù)。

這種寫法，不得不說，更加符合直覺，代碼的邏輯也更容易理解。

3. 帶參數(shù)的裝飾器可用？

裝飾器根據(jù)有沒有攜帶參數(shù)，可以分為兩種

第一種 ：不帶參數(shù)，最簡單的示例，上面已經(jīng)舉例

def decorator(func):
    def wrapper(*args, **kw):
        func(*args, **kw)
    return wrapper

第二種 ：帶參數(shù)，這就相對復(fù)雜了，理解起來了也不是那么容易。

def decorator(arg1, arg2):
    def wrapper(func):
        def deco(*args, **kwargs)
            func(*args, **kwargs)
        return deco
    return wrapper

那么對于需要帶參數(shù)的裝飾器，decorator 是否也一樣能很好的支持呢？

下面是一個官方的示例

from decorator import decorator

@decorator
def warn_slow(func, timelimit=60, *args, **kw):
    t0 = time.time()
    result = func(*args, **kw)
    dt = time.time() - t0
    if dt > timelimit:
        logging.warn('%s took %d seconds', func.__name__, dt)
    else:
        logging.info('%s took %d seconds', func.__name__, dt)
    return result

@warn_slow(timelimit=600)  # warn if it takes more than 10 minutes
def run_calculation(tempdir, outdir):
    pass

可以看到

• 裝飾函數(shù)的第一個參數(shù)，還是被裝飾器 func ，這個跟之前一樣
• 而第二個參數(shù) timelimit 寫成了位置參數(shù)的寫法，并且有默認(rèn)值
• 再往后，就還是跟原來一樣使用了可變參數(shù)的寫法

不難推斷，只要你在裝飾函數(shù)中第二個參數(shù)開始，使用了非可變參數(shù)的寫法，這些參數(shù)就可以做為裝飾器調(diào)用時的參數(shù)。

4. 簽名問題有解決？

我們在自己寫裝飾器的時候，通常都會順手加上一個叫 functools.wraps 的裝飾器，我想你應(yīng)該也經(jīng)常見過，那他有啥用呢？

先來看一個例子

def wrapper(func):
    def inner_function():
        pass
    return inner_function

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
#inner_function

為什么會這樣子？不是應(yīng)該返回 func 嗎？

這也不難理解，因為上邊執(zhí)行func 和下邊 decorator(func) 是等價的，所以上面 func.__name__ 是等價于下面decorator(func).__name__ 的，那當(dāng)然名字是 inner_function

def wrapper(func):
    def inner_function():
        pass
    return inner_function

def wrapped():
    pass

print(wrapper(wrapped).__name__)
#inner_function

目前，我們可以看到當(dāng)一個函數(shù)被裝飾器裝飾過后，它的簽名信息會發(fā)生變化（譬如上面看到的函數(shù)名）

那如何避免這種情況的產(chǎn)生？

解決方案就是使用我們前面所說的 functools .wraps 裝飾器。

它的作用就是將 被修飾的函數(shù)(wrapped) 的一些屬性值賦值給 修飾器函數(shù)(wrapper) ，最終讓屬性的顯示更符合我們的直覺。

from functools import wraps

def wrapper(func):
    @wraps(func)
    def inner_function():
        pass
    return inner_function

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
# wrapped

那么問題就來了，我們使用了 decorator 之后，是否還會存在這種簽名的問題呢？

寫個例子來驗證一下就知道啦

from decorator import decorator

@decorator
def deco(func, *args, **kw):
    print("Ready to run task")
    func(*args, **kw)
    print("Successful to run task")

@deco
def myfunc():
    print("Running the task")

print(myfunc.__name__)

輸出的結(jié)果是 myfunc，說明 decorator 已經(jīng)默認(rèn)幫我們處理了一切可預(yù)見的問題。

5. 總結(jié)一下

decorator 是一個提高裝飾器編碼效率的第三方庫，它適用于對裝飾器原理感到困惑的新手，可以讓你很輕易的寫出更符合人類直覺的代碼。

對于帶參數(shù)裝飾器的定義，是非常復(fù)雜的，它需要要寫多層的嵌套函數(shù)，并且需要你熟悉各個參數(shù)的傳遞路徑，才能保證你寫出來的裝飾器可以正常使用。

這時候，只要用上 decorator 這個庫，你就可以很輕松的寫出一個帶參數(shù)的裝飾器。同時你也不用擔(dān)心他會出現(xiàn)簽名問題，這些它都為你妥善的處理好了。

這么棒的一個庫，推薦你使用起來。