裝飾器是 Python 編程中常用的一個功能,可以將通用的邏輯抽象成裝飾器,通過裝飾器語法應用到不同的目標上,達到增強或修改目標邏輯的目的。 先來看一個簡單的例子 # 列印耗時的裝飾器 def log(f): def inner(*args, **kw): start = time.perf_cou ...
裝飾器是 Python 編程中常用的一個功能,可以將通用的邏輯抽象成裝飾器,通過裝飾器語法應用到不同的目標上,達到增強或修改目標邏輯的目的。
先來看一個簡單的例子
# 列印耗時的裝飾器
def log(f):
def inner(*args, **kw):
start = time.perf_counter()
result = f(*args, **kw)
cost = time.perf_counter() - start
print(f"cost {cost:.1} seconds")
return result
return inner
# 通過 @ 語法將裝飾器應用到目標對象上
@log
def download(url):
requests.get(url)
download("https://www.baidu.com")
# 輸出如下
# cost 0.1 seconds
被裝飾的目標是 download
函數,用於下載文件,通過 @
語法被列印耗時的裝飾器 log
修飾,download
在被調用的時候就會列印下載文件的耗時。那麼列印耗時的邏輯是怎麼嵌入到 download
函數中的呢,這裡的關鍵就是需要知道 Python 解釋器是怎麼處理 @
語法的。不妨用 Python 提供的 dis
模塊反彙編一下 download
的定義
@log
def download(url):
requests.get(url)
反彙編之後得到的位元組碼如下(不同 Python 版本反彙編的結果略有差異)
2 0 LOAD_NAME 0 (log)
3 2 LOAD_CONST 0 (<code object download at 0x7f7872e363a0, file "<dis>", line 2>)
4 LOAD_CONST 1 ('download')
6 MAKE_FUNCTION 0
8 CALL_FUNCTION 1
10 STORE_NAME 1 (download)
12 LOAD_CONST 2 (None)
14 RETURN_VALUE
# download 函數本來的函數體
Disassembly of <code object download at 0x7f7872e363a0, file "<dis>", line 2>:
4 0 LOAD_GLOBAL 0 (requests)
2 LOAD_METHOD 1 (get)
4 LOAD_FAST 0 (url)
6 CALL_METHOD 1
8 POP_TOP
10 LOAD_CONST 0 (None)
12 RETURN_VALUE
可以看到,一開始 MAKE_FUNCTION
指令通過編譯好的 download
函數體對應的 code
對象構造出一個新的函數對象存在 download
變數中,然後通過 CALL_FUNCTION
指令調用 log
函數(參數是 download
變數),最後再通過 STORE_NAME
指令將 log
函數的返回結果存到 download
變數中。所以從語義上說,用 log
對 download
進行裝飾的效果等價於下麵的偽代碼
download = make_function(code) # 構造最初的 download 函數對象
download = log(download) # 調用 log 函數將返回值賦給 download 變數
log
函數的返回是 inner
函數,也就是說 download
在被修飾之後指向的是 inner
函數,而 inner
函數中的 f
變數又指向了 download
在被修飾之前所指向的函數對象,所以最後在調用 download
的時候除了有原來的下載功能之外,還列印了耗時。
裝飾前後 download
變數的變化如下圖所示
在上面的例子中我們稱 log
為裝飾器,因為 log
與 @
同一行且是 @
後面的內容,這是 Python 語法規定的。log
是一個函數,且定義了一個參數。但是裝飾器本身不一定非得是函數,只要是值為可以通過傳遞一個位置參數進行調用的可調用對象的表達式即可。也就是說
- 裝飾器就是一個表達式
- 表達式的值是一個可調用對象
- 這個可調用對象可以通過位置傳參的方式傳遞一個參數進行調用
簡單來說,裝飾器的本質是可以通過形如 A(f)
的方式進行調用的可調用對象(A
是 @
後面整個表達式的值)。
可調用對象可以認為是像函數一樣可以在後面加括弧和參數進行調用的對象,函數本身就是一種可調用對象,還有類對象以及定義了 __call__
函數的類實例對象等都是可調用對象。
下麵的函數 wrapper
就是一個滿足條件的裝飾器,hello
開始是個空函數,被 wrapper
裝飾之後就變成了字元串 "zikcheng"
。當然這個裝飾器沒什麼用,只是為了說明定義一個滿足語法的裝飾器很簡單,不一定非要定義內部函數。
def wrapper(a=1, b="hello"):
return "zikcheng"
@wrapper
def hello():
pass
print(hello, type(hello))
# 輸出
# zikcheng <class 'str'>
再回到 log
與 download
的例子,如果我們想在列印耗時的同時列印負載類型(比如這裡是 IO,對於計算密集型的負載類型是 CPU),可以做如下修改
def log_outer(load_type):
def log(f):
def inner(*args, **kw):
start = time.perf_counter()
result = f(*args, **kw)
cost = time.perf_counter() - start
print(f"{load_type} cost {cost:.1} seconds")
return result
return inner
return log
@log_outer("IO")
def download(url):
requests.get(url)
download("https://www.baidu.com")
# 輸出如下
# IO cost 0.1 seconds
這個例子中的裝飾器表達式為 log_outer("IO")
,因為 @
符號後面的內容是 log_outer("IO")
整體,而不是 log_outer
。log_outer("IO")
的返回值為 log
函數,因此修飾 download
的裝飾器還是 log
函數,只不過這次 log
函數是一個閉包,引用了外部函數的 load_type
變數用於列印負載類型。本質上還是 download = log_outer("IO")(download)
。
如果要列印負載類型,除了上面這種方式,還可以通過定義一個類來實現
class LoadLog:
def __init__(self, load_type):
self.load_type = load_type
def __call__(self, f):
def inner(*args, **kw):
start = time.perf_counter()
result = f(*args, **kw)
cost = time.perf_counter() - start
print(f"{self.load_type} cost {cost:.1} seconds")
return result
return inner
@LoadLog("IO")
def download(url):
requests.get(url)
download("https://www.baidu.com")
# 輸出如下
# IO cost 0.1 seconds
同理,download = LoadLog("IO")(download)
,裝飾器是 LoadLog("IO")
,值為 LoadLog
類實例,是一個可調用對象,最終 download
指向 __call__
的返回值也就是 inner
函數,效果跟之前一樣。
只要我們明白裝飾器的本質是值為可調用對象的表達式,那麼無論怎麼變形,是三層嵌套函數還是類就都很好理解了。
上面例子中被裝飾的對象都是函數,實際上類也是可以被裝飾的,這裡就不展開了。
本文先通過一個簡單的示例引入裝飾器概念,然後分析其反彙編的位元組碼揭示了裝飾器的本質,最後通過無嵌套函數、三層嵌套函數和類分別作為裝飾器來加強對裝飾器本質的理解,希望文章能對你有所幫助。