裝飾器(decorator)是一種高級Python語法。裝飾器可以對一個函數、方法或者類進行加工。在Python中,我們有多種方法對函數和類進行加工,比如在Python閉包中,我們見到函數對象作為某一個函數的返回結果。相對于其它方式,裝飾器語法簡單,代碼可讀性高。因此,裝飾器在Python項目中有廣泛的應用。
裝飾器最早在Python 2.5中出現,它最初被用于加工函數和方法這樣的可調用對象(callable object,這樣的對象定義有__call__方法)。在Python 2.6以及之后的Python版本中,裝飾器被進一步用于加工類。
裝飾函數和方法
我們先定義兩個簡單的數學函數,一個用來計算平方和,一個用來計算平方差:
代碼如下:
# get square sum
def square_sum(a, b):
return a**2 + b**2
# get square diff
def square_diff(a, b):
return a**2 - b**2
print(square_sum(3, 4))
print(square_diff(3, 4))
在擁有了基本的數學功能之后,我們可能想為函數增加其它的功能,比如打印輸入。我們可以改寫函數來實現這一點:
代碼如下:
# modify: print input
# get square sum
def square_sum(a, b):
print("intput:", a, b)
return a**2 + b**2
# get square diff
def square_diff(a, b):
print("input", a, b)
return a**2 - b**2
print(square_sum(3, 4))
print(square_diff(3, 4))
我們修改了函數的定義,為函數增加了功能。
現在,我們使用裝飾器來實現上述修改:
代碼如下:
def decorator(F):
def new_F(a, b):
print("input", a, b)
return F(a, b)
return new_F
# get square sum
@decorator
def square_sum(a, b):
return a**2 + b**2
# get square diff
@decorator
def square_diff(a, b):
return a**2 - b**2
print(square_sum(3, 4))
print(square_diff(3, 4))
裝飾器可以用def的形式定義,如上面代碼中的decorator。裝飾器接收一個可調用對象作為輸入參數,并返回一個新的可調用對象。裝飾器新建了一個可調用對象,也就是上面的new_F。new_F中,我們增加了打印的功能,并通過調用F(a, b)來實現原有函數的功能。
定義好裝飾器后,我們就可以通過@語法使用了。在函數square_sum和square_diff定義之前調用@decorator,我們實際上將square_sum或square_diff傳遞給decorator,并將decorator返回的新的可調用對象賦給原來的函數名(square_sum或square_diff)。 所以,當我們調用square_sum(3, 4)的時候,就相當于:
代碼如下:
square_sum = decorator(square_sum)
新聞熱點
疑難解答