如何實現一個python函數裝飾器(Decorator)
裝飾器本質上是一個 Python 函數或類,它可以讓其他函數或類在不需要做任何代碼修改的前提下增加額外功能,裝飾器的返回值也是一個函數/類對象。它經常用于為已有函數/類添加記錄日志、計時統計、性能測試等。
首先定義一個倒計時函數,這個函數的功能非常簡單,就是把n從當前值減少到0。
def countdown(n): while n > 0: print(’time’ + str(n)) n -= 1print(countdown.__name__)
程序輸出:
countdown
1.為函數增加一個日志裝飾器
假設現在要增強countdown的功能,在函數調用前后自動打印日志,又不想修改函數自身的功能。這種在代碼運行期間動態增加功能的方式,稱之為裝飾器(Decorator)。
能打印日志的decorator,可以定義如下:
def log(func): def wrapper(*args, **kw): print(’call %s().’ % func.__name__) return func(*args, **kw) return wrapper
然后我們借助Python的@語法,把decorator置于函數的定義處:
@logdef countdown(n): while n > 0: print(’time:’ + str(n)) n -= 1countdown(10)
程序輸出:
call countdown().time:10time:9time:8time:7time:6time:5time:4time:3time:2time:1
但此時我們再打印函數的name:
print(countdown.__name__)
程序輸出:
wrapper
我們發現函數的元數據信息變了,這顯然不是我們想要的結果。
2. 在裝飾器中拷貝元數據
為了把函數的元數據信息都保留下來,我們可以直接使用Python提供的functools庫中的@wraps裝飾器。
from functools import wrapsdef log(func): @wraps(func) def wrapper(*args, **kw): print(’call %s().’ % func.__name__) return func(*args, **kw) return wrapper@logdef countdown(n): while n > 0: print(’time:’ + str(n)) n -= 1print(countdown.__name__)
程序輸出:
countdown
3.為函數增加一個計時裝飾器
添加函數裝飾器的方法已經講清楚了,現在再實現一個完整的函數計時耗時裝飾器。
import timefrom functools import wrapsdef TimeCost(func): @wraps(func) def wrapper(*arg, **kwargs): start = time.time() result = func(*args, **kwargs) end = time.time() print(func.__name__, end - start) return result return wrapper@TimeCostdef countdown(n): while n > 0: print(’time:’ + str(n)) n -= 1countdown(10000)
函數輸出:
(’countdown’, 0.0004801750183105469)
參考資料:
https://www.liaoxuefeng.com/wiki/1016959663602400/1017451662295584
Python Cookbook中文版
以上就是如何實現一個python函數裝飾器(Decorator)的詳細內容,更多關于python函數裝飾器的資料請關注好吧啦網其它相關文章!
相關文章:
