編寫裝飾器並儲存函式的元資料,程式碼簡潔之道
軟體開發中的重要一條真理就是“不要重複自己的工作”。通常當我們需要建立高度重複的程式碼時,都可以尋找到一個更加優雅的解決方案。
1 給函式新增一個包裝,讓它做一點額外的工作
當我們需要讓一個函式擁有計時統計、列印日誌的功能時,往往選擇的方案就是直接在函式體中增加需要的程式碼。這在只有一兩個函式的時候還可以接受,但是如果需要讓一個專案中的所有函式都具有這樣的功能時,就會變得十分繁瑣。
這時候,就需要我們使用“裝飾器”了。示例如下:
from functools import wraps import time def logit(func): ''' 使用裝飾器來列印函式呼叫資訊 ''' @wraps(func) def wrapper(*args, **kwargs): print('start func {}'.format(func.__name__), time.strftime('at %Y %m %d %H:%M:%S', time.localtime())) result = func(*args, **kwargs) print('finish func {}'.format(func.__name__), time.strftime('at %Y %m %d %H:%M:%S', time.localtime())) return result return wrapper
下面是使用演示:
>>> @logit
def countdown(n):
while(n > 0):
n -= 1
>>> countdown(10000000)
start func countdown at 2018 09 16 16:45:23
finish func countdown at 2018 09 16 16:45:24
只需要在函式定義時為它增加一個裝飾器(@logit),這個函式就能告訴我們它開始執行的時間以及結束執行的時間!
裝飾器其實就是一個函式,它可以接受一個函式作為輸入並返回一個新的函式作為輸出。
裝飾器內部的程式碼一般會涉及建立一個新的函式,利用*args和**kwargs可以接收任意的引數。在這個函式內部,我們呼叫原來的輸入函式(即被包裝的那個函式,它是裝飾器的輸入引數)並返回它的結果。此時,這個新建立的wrapper函式就會作為裝飾器的結果返回,取代了原本的函式。
需要強調的一點是,裝飾器一般來說不會修改呼叫的簽名,也不會修改被包裝函式返回的結果。這裡使用了*args和**kwargs來確保可以接受任何形式的輸入引數。裝飾器的返回值幾乎總是同調用func(*args,**kwargs)的結果一致,這裡的func就是那個未被包裝過的原始函式。
2 那裝飾器函式中的裝飾器@wraps有什麼作用
裝飾器@wraps可以用來儲存底層的元資料,比如函式名、文件字串、函式註解以及呼叫簽名。
如果沒有使用該裝飾器,獲取上一個例子中countdown函式的元資料就會看起來像這樣:
>>> countdown.__name__
'wrapper'
>>> countdown.__doc__
>>> countdown.__annotations__
@wraps的另一個重要特性就是可以通過__wrapped__屬性來訪問那個被包裝的函式,而該屬性同時也可以使得裝飾器函式可以合適的將底層被包裝的函式的簽名暴露出來:
>>> from inspect import signature
>>> print(signature(countdown))
(n:int)