摘要：實(shí)現(xiàn)一個(gè)簡(jiǎn)單的裝飾器輸出被裝飾函數(shù)的運(yùn)行時(shí)間簡(jiǎn)單運(yùn)用運(yùn)行結(jié)果運(yùn)行過(guò)程中，首先輸出裝飾器函數(shù)中的內(nèi)容被裝飾函數(shù)運(yùn)行時(shí)間長(zhǎng)度函數(shù)名稱和實(shí)際參數(shù)計(jì)算結(jié)果然后得到最終的計(jì)算結(jié)果。

函數(shù)裝飾器用于在源碼中“標(biāo)記”函數(shù)， 以某種方式增強(qiáng)函數(shù)的行為，這是一個(gè)強(qiáng)大的功能。

函數(shù)裝飾器是一個(gè)可調(diào)用對(duì)象，其參數(shù)是另外一個(gè)函數(shù)，即被裝飾函數(shù)。裝飾器可能處理被裝飾函數(shù)，然后將其返回，或者將其替換成另一個(gè)函數(shù)或可調(diào)用對(duì)象。

函數(shù)裝飾器的一個(gè)重要特性就是，它們?cè)诒谎b飾的函數(shù)定義之后立即運(yùn)行。

registry = []

def register(func):
    print("running register(%s)" % func)
    registry.append(func)
    return func

@register
def f1():
    print("running f1()")

@register
def f2():
    print("running f2()")

def f3():
    print("running f3()")

def main():
    print("running main()")
    print("registry ->", registry)
    f1()
    f2()
    f3()

if __name__ == "__main__":
    main()

運(yùn)行結(jié)果：

running register()
running register()
running main()
registry -> [, ]
running f1()
running f2()
running f3()

可以看到，被裝飾的 f1() 和 f2() 首先被運(yùn)行，隨后才運(yùn)行main()中的語(yǔ)句。

被裝飾函數(shù)運(yùn)行時(shí)，其本身的內(nèi)容（示例中print語(yǔ)句）并沒(méi)有被執(zhí)行，而是運(yùn)行了裝飾器函數(shù)中的print語(yǔ)句；這就是裝飾器的作用，替代被裝飾函數(shù)，同時(shí)裝飾器也可以調(diào)用外界自由變量（registry），從而引出一個(gè)重要概念：

實(shí)例中registry變量和register函數(shù)組合的共同體，被成稱為閉包。

該例中有兩個(gè)不太尋常的地方：

裝飾器函數(shù)和被裝飾函數(shù)定義在一個(gè)模塊之中；一般來(lái)說(shuō)，兩者應(yīng)該定義在不同的模塊；

register裝飾器返回的函數(shù)與通過(guò)參數(shù)傳入的相同；實(shí)際上，大部分裝飾器會(huì)在內(nèi)部定義一個(gè)函數(shù)，然后將其返回。

# clockdeco.py 輸出被裝飾函數(shù)的運(yùn)行時(shí)間
import time


def clock(func):
    def clocked(*args):
        t0 = time.perf_counter()
        result = func(*args)
        elapsed = time.perf_counter() - t0
        name = func.__name__
        arg_str = ",".join(repr(arg) for arg in args)
        print("[%0.8fs] %s(%s) -> %r" % (elapsed, name, arg_str, result))
        return result
    return clocked

簡(jiǎn)單運(yùn)用：

# clockdeco_demo.py 
import time
from clockdeco import clock

@clock
def snooze(seconds):
    time.sleep(seconds)

@clock
def factorial(n):
    return 1 if n < 2 else n*factorial(n-1)

def main():
    print("*" * 40, "Calling snooze(.123)")
    snooze(.123)
    print("*" * 40, "Calling factorial(6)")
    print("6! =", factorial(6))

if __name__ == "__main__":
    main()

運(yùn)行結(jié)果：

**************************************** Calling snooze(.123)
[0.12240868s] snooze(0.123) -> None
**************************************** Calling factorial(6)
[0.00000068s] factorial(1) -> 1
[0.00020317s] factorial(2) -> 2
[0.00039755s] factorial(3) -> 6
[0.00053638s] factorial(4) -> 24
[0.00062375s] factorial(5) -> 120
[0.00067319s] factorial(6) -> 720
6! = 720

運(yùn)行過(guò)程中，首先輸出裝飾器函數(shù)中的內(nèi)容：

被裝飾函數(shù)運(yùn)行時(shí)間長(zhǎng)度；

函數(shù)名稱和實(shí)際參數(shù)

計(jì)算結(jié)果

然后得到最終的計(jì)算結(jié)果。可見(jiàn)，裝飾器函數(shù)的優(yōu)先級(jí)較高

當(dāng)然，該實(shí)例中的裝飾器具有幾個(gè)缺點(diǎn)：

不支持關(guān)鍵字參數(shù)

遮蓋了被裝飾函數(shù)的__name__和__doc__屬性

下面的例子對(duì)其做出改進(jìn)：

# clockdeco2.py
import time
import functools


def clock(func):
    @functools.wraps(func)
    def clocked(*args, **kwargs):
        t0 = time.time()
        result = func(*args, **kwargs)
        elapsed = time.time() - t0
        name = func.__name__
        arg_lst = []
        if args:
            arg_lst.append(",".join(repr(arg) for arg in args))
        if kwargs:
            pairs = ["%s=%r" % (k, w) for k, w in sorted(kwargs.items())]
            arg_lst.append(", ".join(pairs))
        arg_str = ", ".join(arg_lst)
        print("[%0.8fs] %s(%s) -> %r " % (elapsed, name, arg_str, result))
        return result
    return clocked

運(yùn)用：

# clockdeco_demo.py
import time
from clockdeco2 import clock

@clock
def snooze(seconds):
    time.sleep(seconds)

@clock
def factorial(n):
    return 1 if n < 2 else n*factorial(n-1)

def main():
    print("*" * 40, "Calling snooze(.123)")
    snooze(.123)
    print("*" * 40, "Calling factorial(6)")
    print("6! =", factorial(6))

if __name__ == "__main__":
    main()

運(yùn)行結(jié)果：

**************************************** Calling snooze(.123)
[0.12328553s] snooze(0.123) -> None
**************************************** Calling factorial(6)
[0.00000000s] factorial(1) -> 1
[0.00000000s] factorial(2) -> 2
[0.00000000s] factorial(3) -> 6
[0.00099683s] factorial(4) -> 24
[0.00099683s] factorial(5) -> 120
[0.00099683s] factorial(6) -> 720
6! = 720

改進(jìn)后的clockdeco2.py中，使用functools.wraps裝飾器把相關(guān)屬性從func復(fù)制到clocked中，此外，這個(gè)新版本還能正確處理關(guān)鍵字參數(shù)。functools.wraps是標(biāo)準(zhǔn)庫(kù)中的裝飾器，它可以用于裝飾一個(gè)函數(shù)，但是對(duì)于被裝飾函數(shù)本身的功能沒(méi)有任何影響，它的功能只是傳遞函數(shù)內(nèi)置參數(shù)。

# clockdeco_param.py
import time


DEFAULT_FMT = "[{elapsed:0.8f}s] {name}({args}) -> {result}"

def clock(fmt=DEFAULT_FMT):
    def decorate(func):
        def clocked(*_args):
            t0 = time.time()
            _result = func(*_args)
            elapsed = time.time() - t0
            name = func.__name__
            args = ",".join(repr(arg) for arg in _args)
            result = repr(_result)
            print(fmt.format(**locals()))
            return _result
        return clocked
    return decorate

def clock 是參數(shù)化裝飾器工廠函數(shù)

decorate(func) 是真正的裝飾器

clocked 包裝被裝飾的函數(shù)

示例1：

# clockdeco_param_demo.py
import time
from clockdeco_param import clock

@clock()
def snooze(seconds):
    time.sleep(seconds)

for i in range(3):
    snooze(.123)

運(yùn)行結(jié)果：

[0.12367034s] snooze(0.123) -> None
[0.12367010s] snooze(0.123) -> None
[0.12366986s] snooze(0.123) -> None

示例2：

# clockdeco_param_demo.py
import time
from clockdeco_param import clock

@clock("{name}:{elapsed}s")
def snooze(seconds):
    time.sleep(seconds)

for i in range(3):
    snooze(.123)

運(yùn)行結(jié)果：

snooze:0.12366843223571777s
snooze:0.12369871139526367s
snooze:0.12366509437561035s

示例3：

# clockdeco_param_demo.py
import time
from clockdeco_param import clock

@clock("{name}({args}) dt={elapsed:0.3f}s")
def snooze(seconds):
    time.sleep(seconds)

for i in range(3):
    snooze(.123)

運(yùn)行結(jié)果：

snooze(0.123) dt=0.124s
snooze(0.123) dt=0.124s
snooze(0.123) dt=0.124s

分析三個(gè)示例可以看出，當(dāng)裝飾器clock的參數(shù)不同時(shí)，被裝飾函數(shù)運(yùn)行所得結(jié)果也會(huì)不同。

python中參數(shù)化裝飾器的用意在于將更多的參數(shù)傳送給裝飾器，因?yàn)檠b飾器的第一個(gè)參數(shù)一定是被裝飾函數(shù)。

functools.lru_cache和functools.wraps一樣，也是一個(gè)python內(nèi)置裝飾器，它的功能是將耗時(shí)的函數(shù)結(jié)果保存起來(lái)，避免傳圖相同的參數(shù)造成重復(fù)計(jì)算，從而節(jié)省代碼運(yùn)行時(shí)間。

下面以斐波那契數(shù)列寫(xiě)一個(gè)案例:

使用functools.lru_cache

import functools
from clockdeco import clock

@functools.lru_cache()
@clock
def fibonacci(n):

if n < 2:
    return  n
return fibonacci(n-2) + fibonacci(n-1)

if __name__=="__main__":

print(fibonacci(30))

運(yùn)行結(jié)果：

[0.00000000s] fibonacci(0) -> 0
[0.00000068s] fibonacci(1) -> 1
......
[0.00000271s] fibonacci(29) -> 514229
[0.00542815s] fibonacci(30) -> 832040
832040

多次運(yùn)行，計(jì)算fibonacci(30)大概耗時(shí)0.005秒左右

作為對(duì)比：

import functools
from clockdeco import clock


@clock
def fibonacci(n):
    if n < 2:
        return  n
    return fibonacci(n-2) + fibonacci(n-1)

if __name__=="__main__":
    print(fibonacci(30))

運(yùn)行結(jié)果：

.......
[156.42139917s] fibonacci(28) -> 317811
[230.80184171s] fibonacci(29) -> 514229
[368.52227404s] fibonacci(30) -> 832040
832040

嗯……陷入沉思，雖然筆記本渣渣配置，但是運(yùn)行了6分鐘，差距太大

函數(shù)裝飾器就是用來(lái)裝飾函數(shù)的函數(shù)，并使用內(nèi)置函數(shù)替代被裝飾函數(shù)

被裝飾函數(shù)在定義時(shí)就運(yùn)行，無(wú)需顯示調(diào)用

內(nèi)置裝飾器functools.wraps可以為被裝飾函數(shù)賦值內(nèi)置屬性

參數(shù)化裝飾器可以接受不同參數(shù)并適用于被裝飾函數(shù)，顯示不同的作用，相當(dāng)于裝飾器中的定制化

參數(shù)化的裝飾器嵌套層次較深，邏輯相對(duì)復(fù)雜

內(nèi)置裝飾器functools.lru_cache采用緩存機(jī)制，存儲(chǔ)需要多次調(diào)用的函數(shù)值，從而降低代碼運(yùn)行時(shí)間