Python裝飾器-給你的咖啡加點料

公眾號老韓隨筆發表於2021-07-11

    今天你的咖啡加糖了嗎? 讓我們通過一個簡單的例子來引出裝飾器的概念及用法。在引出裝飾器之前,我們先來了解一下函式的概念。 一、函式回顧 1、在python中函式是一等公民,函式也是物件。我們可以把函式賦予變數。

def make_cofe(type):
    print('獲得一杯 : {}'.format(type))
​
get_cofe = make_cofe
get_cofe('咖啡')
​
####輸出#####
獲得一杯 : 咖啡

  

     這個例子中,我們把函式make_cofe 賦予了變數 get_cofe,這樣之後你呼叫 get_cofe,就相當於是呼叫函式 make_cofe()。 2、把函式當作引數,傳入另一個函式中。

def make_cofe(type):
    print('獲得一杯 : {}'.format(type))
​
def shop(func,type):
    func(type)
​
shop(make_cofe,'咖啡')
​
####輸出####
獲得一杯 : 咖啡

  

      這個例子,我們把make_cofe以引數的形式傳入shop中,然後呼叫它。 3、函式是可以巢狀的。

def shop(type):
    def make_cofe(type):
        print('獲得一杯 : {}'.format(type))
    make_cofe(type)
​
shop('咖啡')
​
#####輸出####
獲得一杯 : 咖啡

  

     這段程式碼中,我們在函式shop內部定義了函式make_cofe 4、函式的返回值也可以是函式物件(閉包)。

def shop():
    def make_cofe(type):
        print('獲得一杯 : {}'.format(type))
    return make_cofe
​
get_cofe=shop()
get_cofe("咖啡")
​
####輸出#####
獲得一杯 : 咖啡

  

     這裡,函式 shop() 的返回值是函式物件 make_cofe 本身,之後,我們將其賦予變數 get_cofe,再呼叫 get_cofe("咖啡")。 二、裝飾器 下面我們正式開始裝飾器的學習。 我們先想一個問題。如果我們去咖啡店要一杯咖啡,我們應該如何實現。你也許會這麼寫。

def cofe():
    print('咖啡', end='')
​
cofe()
​
####輸出####
咖啡

  

     那我們現在想來一杯加糖咖啡,我們該如何寫呢?你也許會這麼想,那還不簡單,直接在cofe()函式裡改不就好了。

def cofe():
    print('加糖咖啡', end='')
​
cofe()
​
####輸出####
加糖咖啡

  

     那麼問題來了,如果我們現在不想喝加糖咖啡了,該怎麼辦呢,總不能在cofe()函式裡去掉吧。那如果有人想喝加糖咖啡、有人不想喝加糖咖啡如何是好,總不能寫兩個cofe()函式吧。 那我們帶著問題看一下下面這段程式碼。

def add_sugar(func):
    def add():
        print('加糖',end='')
        func()
    return add
​
def cofe():
    print('咖啡',end='')
​
cofe = add_sugar(cofe)
​
print("獲得一杯",end='')
cofe()
​
####輸出#####
獲得一杯加糖咖啡

  

    變數 cofe 指向了內部函式 add(),而內部函式 add() 中又會呼叫原函式 cofe(),因此,最後呼叫 cofe() 時,就會先列印‘加糖’,然後輸出‘咖啡’。這裡的函式 add_sugar() 就是一個裝飾器,它把真正需要執行的函式cofe()包裹在其中,並且改變了它的行為,但是原函式 cofe() 不變。 下面我們來看一下更優雅的寫法。

def add_sugar(func):
    def add():
        print('加糖',end='')
        func()
    return add
​
@add_sugar
def cofe():
    print('咖啡',end='')
​
print("獲得一杯",end='')
cofe()
​
#####輸出#####
獲得一杯加糖咖啡

  

     這裡的@叫做語法糖, @add_sugar就相當於前面的cofe = add_sugar(cofe)語句,只不過更加簡潔。因此程式中建議用這種寫法。 好了,讓我們來回顧下我們的問題,如果有人想喝加糖咖啡、有人不想喝加糖咖啡如何是好。學了裝飾器那不就很簡單了,如果要喝加糖咖啡,我們把加糖的裝飾器@add_sugar給加上不就好了,如果喝不加糖的,那就不加裝飾器,這樣我們就把這個問題給完美解決掉了。在不改變函式內部的前提了,給函式又新增了新的功能。 到目前為止,我們已經把最簡單的裝飾器學完了。下面我們在考慮一個問題,如果原函式 cofe() 中,有引數需要傳遞給裝飾器怎麼辦?一個簡單的辦法,是可以在對應的裝飾器函式 add() 上,加上相應的引數。

def add_sugar(func):
    def add(type):
        print('加糖',end='')
        func(type)
    return add
​
@add_sugar
def cofe(type):
    print('{}咖啡'.format(type),end='')
​
​
cofe("美式")
print()
cofe("拿鐵")
​
####輸出#####
加糖美式咖啡
加糖拿鐵咖啡

  

    不過,新的問題來了。如果我另外還有一個函式(奶茶函式),也需要使用 add_sugar() 裝飾器,但是這個新的函式有兩個引數,又該怎麼辦呢? 通常情況下,我們會把*args和 **kwargs,作為裝飾器內部函式 add() 的引數。*args和**kwargs,表示接受任意數量和型別的引數,因此加糖裝飾器就可以寫成下面的形式:

def add_sugar(func):
    def add(*args, **kwargs):
        print('加糖',end='')
        func(*args, **kwargs)
    return add
    
@add_sugar
def cofe(type):
    print('{}咖啡'.format(type),end='')
​
@add_sugar
def milk_tea(type,num):
    print('{}杯{}奶茶'.format(num,type), end='')
​
​
cofe("美式")
print()
milk_tea("xx牌子","4")
​
####輸出####
加糖美式咖啡
加糖4杯xx牌子奶茶

  

     這樣我們的咖啡和奶茶都可以加糖了。 前面我們講的是函式的裝飾器,下面我們來講一下類作為裝飾器。類裝飾器主要依賴於函式__call__(),每當你呼叫一個類的例項時,函式__call__()就會被執行一次。

​class Add_sugar:
    def __init__(self, func):
        self.func = func
        self.add_suger = "加糖"
​
    def __call__(self, *args, **kwargs):
        print(self.add_suger,end='')
        return self.func(*args, **kwargs)
​
@Add_sugar
def cofe():
    print("咖啡")
​
cofe()
​
####輸出#####
加糖咖啡

  

    最後如果我們的咖啡既要加糖又要加冰,那我們該如何做呢?我們定義一個加冰的裝飾器就好了呀。

def add_sugar(func):
    def add():
        print('加糖',end='')
        func()
    return add
​
def add_ice(func):
    def add():
        print('加冰',end='')
        func()
    return add
​
​
@add_sugar
@add_ice
def cofe():
    print('咖啡',end='')
​
cofe()
​
####輸出####
加糖加冰咖啡

  

   從此以後,我們的咖啡想加什麼就加什麼。 歡迎大家留言和我交流。

 

相關文章