編寫裝飾器并保存函數(shù)的元數(shù)據(jù)，代碼簡潔之道-創(chuàng)新互聯(lián)

  軟件開發(fā)中的重要一條真理就是“不要重復自己的工作”。通常當我們需要創(chuàng)建高度重復的代碼時，都可以尋找到一個更加優(yōu)雅的解決方案。

1    給函數(shù)添加一個包裝，讓它做一點額外的工作

    當我們需要讓一個函數(shù)擁有計時統(tǒng)計、打印日志的功能時，往往選擇的方案就是直接在函數(shù)體中增加需要的代碼。這在只有一兩個函數(shù)的時候還可以接受，但是如果需要讓一個項目中的所有函數(shù)都具有這樣的功能時，就會變得十分繁瑣。

    這時候，就需要我們使用“裝飾器”了。示例如下：

from functools import wraps
import time

def logit(func):
    '''
    使用裝飾器來打印函數(shù)調(diào)用信息
    '''
    @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

    只需要在函數(shù)定義時為它增加一個裝飾器（@logit），這個函數(shù)就能告訴我們它開始運行的時間以及結(jié)束運行的時間！

    裝飾器其實就是一個函數(shù)，它可以接受一個函數(shù)作為輸入并返回一個新的函數(shù)作為輸出。

    裝飾器內(nèi)部的代碼一般會涉及創(chuàng)建一個新的函數(shù)，利用*args和**kwargs可以接收任意的參數(shù)。在這個函數(shù)內(nèi)部，我們調(diào)用原來的輸入函數(shù)（即被包裝的那個函數(shù)，它是裝飾器的輸入?yún)?shù)）并返回它的結(jié)果。此時，這個新創(chuàng)建的wrapper函數(shù)就會作為裝飾器的結(jié)果返回，取代了原本的函數(shù)。

    需要強調(diào)的一點是，裝飾器一般來說不會修改調(diào)用的簽名，也不會修改被包裝函數(shù)返回的結(jié)果。這里使用了*args和**kwargs來確?？梢越邮苋魏涡问降妮斎?yún)?shù)。裝飾器的返回值幾乎總是同調(diào)用func(*args,**kwargs)的結(jié)果一致，這里的func就是那個未被包裝過的原始函數(shù)。

2    那裝飾器函數(shù)中的裝飾器@wraps有什么作用

    裝飾器@wraps可以用來保存底層的元數(shù)據(jù)，比如函數(shù)名、文檔字符串、函數(shù)注解以及調(diào)用簽名。

    如果沒有使用該裝飾器，獲取上一個例子中countdown函數(shù)的元數(shù)據(jù)就會看起來像這樣：

>>> countdown.__name__
'wrapper'
>>> countdown.__doc__
>>> countdown.__annotations__

    @wraps的另一個重要特性就是可以通過__wrapped__屬性來訪問那個被包裝的函數(shù)，而該屬性同時也可以使得裝飾器函數(shù)可以合適的將底層被包裝的函數(shù)的簽名暴露出來：

>>> from inspect import signature
>>> print(signature(countdown))
(n:int)