【python】裝飾器聽了N次也沒印象，讀完這篇你就懂了

裝飾器其實一直是我的一個”老大難”。這個知識點就放在那，但是拖延症。。。

其實在平常寫寫腳本的過程中，這個知識點你可能用到不多

但在面試的時候，這可是一個高頻問題。

一、什麼是裝飾器

所謂的裝飾器，其實就是通過裝飾器函數，來修改原函數的一些功能，使得原函數不需要修改。

這一句話理解起來可能沒那麼輕鬆，那先來看一個”傻瓜”函數。

放心，絕對不是”Hello World”！

def hello():
    print("你好，裝飾器")

腫么樣，木騙你吧？ 哈哈，這個函數不用運行相信大家都知道輸出結果："你好，裝飾器"。

那如果我想讓hello()函數再實現個其他功能，比如多列印一句話。

那麼，可以這樣”增強”一下：

def my_decorator(func):
    def wrapper():
        print("這是裝飾後具有的新輸出")
        func()
    return wrapper

def hello():
    print("你好，裝飾器")

hello = my_decorator(hello)

hello()

運行結果：

這是裝飾後具有的新輸出
你好，裝飾器
[Finished in 0.1s]

很顯然，這個”增強”沒啥作用，但是可以幫助理解裝飾器。

當運行最後的hello()函數時，調用過程是這樣的：

  1. hello = my_decorator(hello)中，變數hello指向的是my_decorator()
  2. my_decorator(func)中返回的wrapper(),傳參是hello，因此又會調用到原函數hello()
  3. 於是乎，先列印出了wrapper()函數里的，然後才列印出hello()函數里的

那上述程式碼里的my_decorator()就是一個裝飾器。
它改變了hello()的行為，但是並沒有去真正的改變hello()函數的內部實現。

但是，python一直以”優雅”被人追捧，而上述的程式碼顯然不夠優雅。

二、優雅的裝飾器

所以，想讓上述裝飾器變得優雅，可以這樣寫：

def my_decorator(func):
    def wrapper():
        print("這是裝飾後具有的新輸出")
        func()
    return wrapper

@my_decorator
def hello():
    print("你好，裝飾器")

hello()

這裡的@my_decorator就相當於舊程式碼的hello = my_decorator(hello)，@符號稱為語法糖。

那如果還有其他函數也需要加上類似的裝飾，直接在函數的上方加上@my_decorator就可以，大大提高函數
的重複利用與可讀性。

def my_decorator(func):
    def wrapper():
        print("這是裝飾後具有的新輸出")
        func()
    return wrapper

@my_decorator
def hello():
    print("你好，裝飾器")

@my_decorator
def hello2():
    print("你好，裝飾器2")

hello2()

輸出：

這是裝飾後具有的新輸出
你好，裝飾器2
[Finished in 0.1s]

三、帶參數的裝飾器

1. 單個參數

上面的只是一個非常簡單的裝飾器，但是實際場景中，很多函數都是要帶有參數的，比如hello(people_name)。

其實也很簡單，要什麼我們就給什麼唄，直接在對應裝飾器的wrapper()上，加上對應的參數：

def my_decorator(func):
    def wrapper(people_name):
        print("這是裝飾後具有的新輸出")
        func(people_name)
    return wrapper

@my_decorator
def hello(people_name):
    print("你好，{}".format(people_name))

hello("張三")

輸出：

這是裝飾後具有的新輸出
你好，張三
[Finished in 0.1s]

2. 多個參數

但是還沒完，這樣雖然簡單，但是隨之而來另一個問題：因為並不是所有函數參數都是一樣的，
當其他要使用裝飾器的函數參數不止這個一個腫么辦？比如：

@my_decorator
def hello3(speaker, listener):
    print("{}對{}說你好！".format(speaker, listener))

沒關係，在python里，*args和**kwargs表示接受任意數量和類型的參數，所以我們可以這樣
寫裝飾器里的wrapper()函數：

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("這是裝飾後具有的新輸出")
        func(*args, **kwargs)
    return wrapper

@my_decorator
def hello(people_name):
    print("你好，{}".format(people_name))

@my_decorator
def hello3(speaker, listener):
    print("{}對{}說你好！".format(speaker, listener))

hello("老王")
print("------------------------")
hello3("張三", "李四")

同時運行下hello("老王")，和hello3("張三", "李四")，看結果：

這是裝飾後具有的新輸出
你好，老王
------------------------
這是裝飾後具有的新輸出
張三對李四說你好！
[Finished in 0.1s]

3. 自定義參數

上面2種，裝飾器都是接收外來的參數，其實裝飾器還可以接收自己的參數。
比如，我加個參數來控制下裝飾器中列印資訊的次數：

def count(num):
    def my_decorator(func):
        def wrapper(*args, **kwargs):
            for i in range(num):
                print("這是裝飾後具有的新輸出")
                func(*args, **kwargs)
        return wrapper
    return my_decorator

@count(3)
def hello(people_name):
    print("你好，{}".format(people_name))

hello("老王")

注意，這裡count裝飾函數中的2個return.
運行下，應該會出現3次：

這是裝飾後具有的新輸出
你好，老王
這是裝飾後具有的新輸出
你好，老王
這是裝飾後具有的新輸出
你好，老王
[Finished in 0.1s]

4. 內置裝飾器@functools.wrap

現在多做一步探索，我們來列印下下面例子中的hello()函數的元資訊：

import functools

def my_decorator(func):
    # @functools.wraps(func)
    def wrapper(*args, **kwargs):
        print("這是裝飾後具有的新輸出")
        func(*args, **kwargs)
    return wrapper

@my_decorator
def hello(people_name):
    print("你好，{}".format(people_name))

print(hello.__name__) #看下hello函數的元資訊

輸出：

wrapper

這說明了，它不再是以前的那個 hello() 函數，而是被 wrapper() 函數取代了。

如果我們需要用到元函數資訊，那怎麼保留它呢？這時候可以用內置裝飾器@functools.wrap。

import functools

def my_decorator(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        print("這是裝飾後具有的新輸出")
        func(*args, **kwargs)
    return wrapper

@my_decorator
def hello(people_name):
    print("你好，{}".format(people_name))

print(hello.__name__)

運行下：

hello
[Finished in 0.1s]

好記性不如爛筆頭，寫一下理解一下會好很多。
下面還分享類的裝飾器，以及裝飾器所用場景。

Tags:

VirMach 便宜 VPS

QNews

QNews