前言

一、什么是裝飾器

二、為什么要用裝飾器

三、簡單的裝飾器

四、裝飾器的語法糖@

五、裝飾器傳參

六、帶引數的裝飾器

七、類裝飾器

八、帶引數的類裝飾器

九、裝飾器的順序

總結

寫在后面

前言

最近有人問我裝飾器是什么，我就跟他說，其實就是裝飾器就是類似于女孩子的發卡，你喜歡的一個女孩子，她可以有很多個發卡，而當她戴上不同的發卡，她的頭頂上就是裝飾了不同的發卡，但是你喜歡的女孩子還是你喜歡的女孩子，如果還覺得不理解的話，裝飾器就是咱們的手機殼，你盡管套上了手機殼，但并不影響你的手機功能，可你的手機還是該可以給你玩，該打電話打電話，該玩游戲玩游戲，該收藏攻城獅白玉的博客就收藏攻城獅白玉的博客，而你的手機就變成了帶手機殼的手機，

裝飾器就是python的一個攔路虎，你干或者不干它，它都在那里，如果你想學會高級的python用法，裝飾器就是你這個武松必須打倒的一只虎，

本文的環境如下：

win10，python3.7

一、什么是裝飾器

裝飾器是給現有的模塊增添新的小功能，可以對原函式進行功能擴展，而且還不需要修改原函式的內容，也不需要修改原函式的呼叫，

裝飾器的使用符合了面向物件編程的開放封閉原則，

開放封閉原則主要體現在兩個方面：

對擴展開放，意味著有新的需求或變化時，可以對現有代碼進行擴展，以適應新的情況，
對修改封閉，意味著類一旦設計完成，就可以獨立其作業，而不要對類盡任何修改，

二、為什么要用裝飾器

使用裝飾器之前，我們要知道，其實python里是萬物皆物件，也就是萬物都可傳參，

函式也可以作為函式的引數進行傳遞的，

通過下面這個簡單的例子可以更直觀知道函式名是如何直接作為引數進行傳遞

def baiyu():
    print("我是攻城獅白玉")


def blog(name):
    print('進入blog函式')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')


if __name__ == '__main__':
    func = baiyu  # 這里是把baiyu這個函式名賦值給變數func
    func()  # 執行func函式
    print('------------')
    blog(baiyu)  # 把baiyu這個函式作為引數傳遞給blog函式

執行結果如下所示：

接下來，我想知道這baiyu和blog兩個函式分別的執行時間是多少，我就把代碼修改如下：

import time


def baiyu():
    t1 = time.time()
    print("我是攻城獅白玉")
    time.sleep(2)
    print("執行時間為：", time.time() - t1)


def blog(name):
    t1 = time.time()
    print('進入blog函式')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')
    print("執行時間為：", time.time() - t1)


if __name__ == '__main__':
    func = baiyu  # 這里是把baiyu這個函式名賦值給變數func
    func()  # 執行func函式
    print('------------')
    blog(baiyu)  # 把baiyu這個函式作為引數傳遞給blog函式

上述的改寫已經實作了我需要的功能，但是，當我有另外一個新的函式【python_blog_list】，具體如下：

def python_blog_list():
    print('''【Python】爬蟲實戰，零基礎初試爬蟲下載圖片（附原始碼和分析程序）
    https://blog.csdn.net/zhh763984017/article/details/119063252 ''')
    print('''【Python】除了多執行緒和多行程，你還要會協程
    https://blog.csdn.net/zhh763984017/article/details/118958668 ''')
    print('''【Python】爬蟲提速小技巧，多執行緒與多行程（附原始碼示例）
    https://blog.csdn.net/zhh763984017/article/details/118773313 ''')
    print('''【Python】爬蟲決議利器Xpath，由淺入深快速掌握（附原始碼例子）
    https://blog.csdn.net/zhh763984017/article/details/118634945 ''')

也需要計算函式執行時間的，那按之前的邏輯，就是改寫如下：

def python_blog_list():
    t1 = time.time()
    print('''【Python】爬蟲實戰，零基礎初試爬蟲下載圖片（附原始碼和分析程序）
    https://blog.csdn.net/zhh763984017/article/details/119063252 ''')
    print('''【Python】除了多執行緒和多行程，你還要會協程
    https://blog.csdn.net/zhh763984017/article/details/118958668 ''')
    print('''【Python】爬蟲提速小技巧，多執行緒與多行程（附原始碼示例）
    https://blog.csdn.net/zhh763984017/article/details/118773313 ''')
    print('''【Python】爬蟲決議利器Xpath，由淺入深快速掌握（附原始碼例子）
    https://blog.csdn.net/zhh763984017/article/details/118634945 ''')
    print("執行時間為：", time.time() - t1)

如果也要這樣子寫的話，不就重復造輪子了嗎？雖說人類的本質是鴿王和復讀機，但作為一個優秀的cv攻城獅（ctrl+c和ctrl+v）肯定是要想辦法偷懶的呀

裝飾器，就是可以讓我們拓展一些原有函式沒有的功能，

三、簡單的裝飾器

基于上面的函式執行時間的需求，我們就手寫一個簡單的裝飾器進行實作，

import time


def baiyu():
    print("我是攻城獅白玉")
    time.sleep(2)


def count_time(func):
    def wrapper():
        t1 = time.time()
        func()
        print("執行時間為：", time.time() - t1)

    return wrapper


if __name__ == '__main__':
    baiyu = count_time(baiyu)  # 因為裝飾器 count_time(baiyu) 回傳的時函式物件 wrapper，這條陳述句相當于  baiyu = wrapper
    baiyu()  # 執行baiyu()就相當于執行wrapper()

這里的count_time是一個裝飾器，裝飾器函式里面定義一個wrapper函式，把func這個函式當作引數傳入，函式實作的功能是把func包裹起來，并且回傳wrapper函式，wrapper函式體就是要實作裝飾器的內容，

當然，這里的wrapper函式名是可以自定義的，只要你定義的函式名，跟你return的函式名是相同的就好了

四、裝飾器的語法糖@

你如果看過其他python專案里面的代碼里，難免會看到@符號，這個@符號就是裝飾器的語法糖，因此上面簡單的裝飾器還是可以通過語法糖來實作的，這樣就可以省去

baiyu = count_time(baiyu)

這一句代碼，而直接呼叫baiyu()這個函式

換句話說，其實使用裝飾器的是，默認傳入的引數就是被裝飾的函式，

import time


def count_time(func):
    def wrapper():
        t1 = time.time()
        func()
        print("執行時間為：", time.time() - t1)

    return wrapper


@count_time
def baiyu():
    print("我是攻城獅白玉")
    time.sleep(2)


if __name__ == '__main__':
    # baiyu = count_time(baiyu)  # 因為裝飾器 count_time(baiyu) 回傳的時函式物件 wrapper，這條陳述句相當于  baiyu = wrapper
    # baiyu()  # 執行baiyu()就相當于執行wrapper()

    baiyu()  # 用語法糖之后，就可以直接呼叫該函式了

五、裝飾器傳參

當我們的被裝飾的函式是帶引數的，此時要怎么寫裝飾器呢？

上面我們有定義了一個blog函式是帶引數的

def blog(name):
    print('進入blog函式')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')

此時我們的裝飾器函式要優化一下下，修改成為可以接受任意引數的裝飾器

def count_time(func):
    def wrapper(*args,**kwargs):
        t1 = time.time()
        func(*args,**kwargs)
        print("執行時間為：", time.time() - t1)

    return wrapper

此處，我們的wrapper函式的引數為*args和**kwargs，表示可以接受任意引數

這時我們就可以呼叫我們的裝飾器了，

import time


def count_time(func):
    def wrapper(*args, **kwargs):
        t1 = time.time()
        func(*args, **kwargs)
        print("執行時間為：", time.time() - t1)

    return wrapper


@count_time
def blog(name):
    print('進入blog函式')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')


if __name__ == '__main__':
    # baiyu = count_time(baiyu)  # 因為裝飾器 count_time(baiyu) 回傳的時函式物件 wrapper，這條陳述句相當于  baiyu = wrapper
    # baiyu()  # 執行baiyu()就相當于執行wrapper()

    # baiyu()  # 用語法糖之后，就可以直接呼叫該函式了
    blog(baiyu)

六、帶引數的裝飾器

前面咱們知道，裝飾器函式也是函式，既然是函式，那么就可以進行引數傳遞，咱們怎么寫一個帶引數的裝飾器呢？

前面咱們的裝飾器只是實作了一個計數，那么我想在使用該裝飾器的時候，傳入一些備注的msg資訊，怎么辦呢？咱們一起看一下下面的代碼

import time


def count_time_args(msg=None):
    def count_time(func):
        def wrapper(*args, **kwargs):
            t1 = time.time()
            func(*args, **kwargs)
            print(f"[{msg}]執行時間為：", time.time() - t1)

        return wrapper

    return count_time


@count_time_args(msg="baiyu")
def fun_one():
    time.sleep(1)


@count_time_args(msg="zhh")
def fun_two():
    time.sleep(1)


@count_time_args(msg="mylove")
def fun_three():
    time.sleep(1)


if __name__ == '__main__':
    fun_one()
    fun_two()
    fun_three()

咱們基于原來的count_time函式外部再包一層用于接收引數的count_time_args，接識訓來的引數就可以直接在內部的函式里面呼叫了，上述代碼執行效果如下：

七、類裝飾器

上面咱們一起學習了怎么寫裝飾器函式，在python中，其實也可以同類來實作裝飾器的功能，稱之為類裝飾器，類裝飾器的實作是呼叫了類里面的__call__函式，類裝飾器的寫法比我們裝飾器函式的寫法更加簡單，

當我們將類作為一個裝飾器，作業流程：

通過__init__（）方法初始化類
通過__call__（）方法呼叫真正的裝飾方法

import time


class BaiyuDecorator:
    def __init__(self, func):
        self.func = func
        print("執行類的__init__方法")

    def __call__(self, *args, **kwargs):
        print('進入__call__函式')
        t1 = time.time()
        self.func(*args, **kwargs)
        print("執行時間為：", time.time() - t1)


@BaiyuDecorator
def baiyu():
    print("我是攻城獅白玉")
    time.sleep(2)


def python_blog_list():
    time.sleep(5)
    print('''【Python】爬蟲實戰，零基礎初試爬蟲下載圖片（附原始碼和分析程序）
    https://blog.csdn.net/zhh763984017/article/details/119063252 ''')
    print('''【Python】除了多執行緒和多行程，你還要會協程
    https://blog.csdn.net/zhh763984017/article/details/118958668 ''')
    print('''【Python】爬蟲提速小技巧，多執行緒與多行程（附原始碼示例）
    https://blog.csdn.net/zhh763984017/article/details/118773313 ''')
    print('''【Python】爬蟲決議利器Xpath，由淺入深快速掌握（附原始碼例子）
    https://blog.csdn.net/zhh763984017/article/details/118634945 ''')


@BaiyuDecorator
def blog(name):
    print('進入blog函式')
    name()
    print('我的博客是 https://blog.csdn.net/zhh763984017')


if __name__ == '__main__':
    baiyu()
    print('--------------')
    blog(python_blog_list)

八、帶引數的類裝飾器

當裝飾器有引數的時候，__init__() 函式就不能傳入func（func代表要裝飾的函式）了，而func是在__call__函式呼叫的時候傳入的，

class BaiyuDecorator:
    def __init__(self, arg1, arg2):  # init()方法里面的引數都是裝飾器的引數
        print('執行類Decorator的__init__()方法')
        self.arg1 = arg1
        self.arg2 = arg2

    def __call__(self, func):  # 因為裝飾器帶了引數，所以接收傳入函式變數的位置是這里
        print('執行類Decorator的__call__()方法')

        def baiyu_warp(*args):  # 這里裝飾器的函式名字可以隨便命名，只要跟return的函式名相同即可
            print('執行wrap()')
            print('裝飾器引數：', self.arg1, self.arg2)
            print('執行' + func.__name__ + '()')
            func(*args)
            print(func.__name__ + '()執行完畢')

        return baiyu_warp


@BaiyuDecorator('Hello', 'Baiyu')
def example(a1, a2, a3):
    print('傳入example()的引數：', a1, a2, a3)


if __name__ == '__main__':
    print('準備呼叫example()')
    example('Baiyu', 'Happy', 'Coder')
    print('測驗代碼執行完畢')

建議各位同學好好比對一下這里的代碼和不帶引數的裝飾器代碼的區別，加深理解，

九、裝飾器的順序

一個函式可以被多個裝飾器進行裝飾，那么裝飾器的執行順序是怎么樣的呢？咱們執行一下下面的代碼就清楚了

def BaiyuDecorator_1(func):
    def wrapper(*args, **kwargs):
        func(*args, **kwargs)
        print('我是裝飾器1')

    return wrapper

def BaiyuDecorator_2(func):
    def wrapper(*args, **kwargs):
        func(*args, **kwargs)
        print('我是裝飾器2')

    return wrapper

def BaiyuDecorator_3(func):
    def wrapper(*args, **kwargs):
        func(*args, **kwargs)
        print('我是裝飾器3')

    return wrapper

@BaiyuDecorator_1
@BaiyuDecorator_2
@BaiyuDecorator_3
def baiyu():
    print("我是攻城獅白玉")


if __name__ == '__main__':
    baiyu()

由輸出結果可知，在裝飾器修飾完的函式，在執行的時候先執行原函式的功能，然后再由里到外依次執行裝飾器的內容，

我們帶三個裝飾器的函式的代碼如下：

@BaiyuDecorator_1
@BaiyuDecorator_2
@BaiyuDecorator_3
def baiyu():
    print("我是攻城獅白玉")

上述的代碼可以看作如下代碼，就能理解為何是由里到外執行了

baiyu = BaiyuDecorator_1 (BaiyuDecorator_2 (BaiyuDecorator_3(baiyu)))

總結

本文由淺入深介紹了python的裝飾器，并且通過代碼展現了如何自己手寫裝飾器函式和類裝飾器，

寫在后面

如果覺得有用的話，麻煩一鍵三連支持一下攻城獅白玉，并把本文分享給更多的小伙伴，你的簡單支持，我的無限創作動力

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/297303.html

標籤：python

上一篇：Django3商城專案從0到1 【五】商品資訊模塊

下一篇：Selenium+python親測爬蟲工具爬取年度電影榜單

【Python】一文弄懂python裝飾器（附原始碼例子）

前言

一、什么是裝飾器

二、為什么要用裝飾器

三、簡單的裝飾器

四、裝飾器的語法糖@

五、裝飾器傳參

六、帶引數的裝飾器

七、類裝飾器

八、帶引數的類裝飾器

九、裝飾器的順序

總結

寫在后面