一個已經存在10年，卻被嚴重低估的 Python 庫

本文已經收錄於《Python黑魔法手冊》v2.1 版本，在線文檔請前往

Python黑魔法手冊 2.0 文檔

今天介紹的是一個已經存在十年，可是依舊不紅的庫 decorator，好像不多有人知道他的存在同樣。

這個庫能夠幫你作什麼呢 ？

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

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

不瞭解裝飾器的能夠先去閱讀我以前寫的文章，很是全且詳細的介紹了裝飾器的各類實現方法。

常規的裝飾器

下面這是一個最簡單的裝飾器示例，在運行 myfunc 函數的先後都會打印一條日誌。

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()
複製代碼

裝飾器使用起來，彷佛有些高端和魔幻，對於一些重複性的功能，每每咱們會封裝成一個裝飾器函數。

在定義一個裝飾器的時候，咱們都須要像上面同樣機械性的寫一個嵌套的函數，對裝飾器原理理解不深的初學者，每每過段時間就會忘記如何定義裝飾器。

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

而後要使用的時候，直接敲入 deco 就會生成一個簡單的生成器代碼，提升編碼的準備效率

使用神庫

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

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

$ python3 -m pip install 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")

myfunc()
複製代碼

deco 做爲裝飾函數，第一個參數是固定的，都是指被裝飾函數，然後面的參數都固定使用 可變參數 *args 和 **kw 的寫法，代碼被裝飾函數的原參數。

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

帶參數的裝飾器

裝飾器根據有沒有攜帶參數，能夠分爲兩種

第一種：不帶參數，最簡單的示例，上面已經舉例

def decorator(func):
    def wrapper(*args, **kw):
        func(*args, **kw)
    return wrapper
複製代碼

第二種：帶參數，這就相對複雜了，理解起來了也不是那麼容易。

def decorator(arg1, arg2):
    def wrapper(func):
        def deco(*args, **kwargs) func(*args, **kwargs) return deco return wrapper 複製代碼

那麼對於須要帶參數的裝飾器，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
複製代碼

能夠看到

• 裝飾函數的第一個參數，仍是被裝飾器 func ，這個跟以前同樣
• 而第二個參數 timelimit 寫成了位置參數的寫法，而且有默認值
• 再日後，就仍是跟原來同樣使用了可變參數的寫法

不難推斷，只要你在裝飾函數中第二個參數開始，使用了非可變參數的寫法，這些參數就能夠作爲裝飾器調用時的參數。

簽名問題有解決？

咱們在本身寫裝飾器的時候，一般都會順手加上一個叫 functools.wraps 的裝飾器，我想你應該也常常見過，那他有啥用呢？

先來看一個例子

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

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
#inner_function
複製代碼

爲何會這樣子？不是應該返回 func 嗎？

這也不難理解，由於上邊執行func 和下邊 decorator(func) 是等價的，因此上面 func.__name__ 是等價於下面decorator(func).__name__ 的，那固然名字是 inner_function

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

def wrapped():
    pass

print(wrapper(wrapped).__name__)
#inner_function
複製代碼

目前，咱們能夠看到當一個函數被裝飾器裝飾事後，它的簽名信息會發生變化（譬如上面看到的函數名）

那如何避免這種狀況的產生？

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

它的做用就是將 被修飾的函數(wrapped) 的一些屬性值賦值給 修飾器函數(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__)
複製代碼

輸出的結果是 myfunc，說明 decorator 已經默認幫咱們處理了一切可預見的問題。

總結一下

decorator 是一個提升裝飾器編碼效率的第三方庫，它適用於對裝飾器原理感到困惑的新手，可讓你很輕易的寫出更符合人類直覺的代碼。對於帶參數裝飾器的定義，是很是複雜的，它須要要寫多層的嵌套函數，而且須要你熟悉各個參數的傳遞路徑，才能保證你寫出來的裝飾器能夠正常使用。這時候，只要用上 decorator 這個庫，你就能夠很輕鬆的寫出一個帶參數的裝飾器。同時你也不用擔憂他會出現簽名問題，這些它都爲你妥善的處理好了。

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

---

《Python黑魔法手冊》是我多年 Python 經驗的經驗總結，這本手冊專門介紹 Python 黑魔法玩法的電子書。其中包括少有人知的一些 Python 冷門知識，Python Shell 的多樣玩法，各類使人瘋狂的 Python 炫技操做，Python 的超詳細進階知識解讀，還有不斷擴充完善適合全部 Python 開發者的開發技巧等等。

本書旨在向你介紹一個不同的 Python，而不是一份初學者的 Python 基礎教學資料。

若是你對 Python 開發技巧、及黑魔法感興趣，那麼這本手冊可千萬別錯過，在線文檔的閱讀連接以下，歡迎前往學習：

Python 黑魔法手冊：magic.iswbm.com

本人發表的全部文章均爲本人原創，花費了巨大的心血，若文章對你幫助，還請你幫忙來個素質三連。