回復(fù)“書(shū)籍”即可獲贈(zèng)Python從入門到進(jìn)階共10本電子書(shū)

對(duì)于每一個(gè)學(xué)習(xí) Python 的同學(xué)，想必對(duì) @ 符號(hào)一定不陌生了，正如你所知， @ 符號(hào)是裝飾器的語(yǔ)法糖，@符號(hào)后面的函數(shù)就是我們本文的主角：裝飾器。

裝飾器放在一個(gè)函數(shù)開(kāi)始定義的地方，它就像一頂帽子一樣戴在這個(gè)函數(shù)的頭上。和這個(gè)函數(shù)綁定在一起。在我們調(diào)用這個(gè)函數(shù)的時(shí)候，第一件事并不是執(zhí)行這個(gè)函數(shù)，而是將這個(gè)函數(shù)做為參數(shù)傳入它頭頂上這頂帽子，這頂帽子我們稱之為 裝飾器 。

曾經(jīng)我在剛轉(zhuǎn)行做程序員時(shí)的一次的面試中，被面試官問(wèn)過(guò)這樣的兩個(gè)問(wèn)題：

1、你都用過(guò)裝飾器實(shí)現(xiàn)過(guò)什么樣的功能？

2、如何寫(xiě)一個(gè)可以傳參的裝飾器？

對(duì)于當(dāng)時(shí)實(shí)戰(zhàn)經(jīng)驗(yàn)非常有限的我，第一個(gè)問(wèn)題只能回答一些非常簡(jiǎn)單的用法，而第二個(gè)問(wèn)題卻沒(méi)能回答上來(lái)。

當(dāng)時(shí)帶著這兩個(gè)問(wèn)題，我就開(kāi)始系統(tǒng)的學(xué)習(xí)裝飾器的所有內(nèi)容。這些一直整理在自己的博客中，今天對(duì)其進(jìn)行了大量的補(bǔ)充和勘誤，發(fā)表在這里分享給大家。希望對(duì)剛?cè)腴T以及進(jìn)階的朋友可以提供一些參考。

01. Hello，裝飾器

裝飾器的使用方法很固定

1. 先定義一個(gè)裝飾器（帽子）

2. 再定義你的業(yè)務(wù)函數(shù)或者類（人）

3. 最后把這裝飾器（帽子）扣在這個(gè)函數(shù)（人）頭上

就像下面這樣子

實(shí)際上，裝飾器并不是編碼必須性，意思就是說(shuō)，你不使用裝飾器完全可以，它的出現(xiàn)，應(yīng)該是使我們的代碼

• 更加優(yōu)雅，代碼結(jié)構(gòu)更加清晰

• 將實(shí)現(xiàn)特定的功能代碼封裝成裝飾器，提高代碼復(fù)用率，增強(qiáng)代碼可讀性

接下來(lái)，我將以實(shí)例講解，如何編寫(xiě)出各種簡(jiǎn)單及復(fù)雜的裝飾器。

02. 入門：日志打印器

首先是日志打印器。
實(shí)現(xiàn)的功能：

1. 在函數(shù)執(zhí)行前，先打印一行日志告知一下主人，我要執(zhí)行函數(shù)了。

2. 在函數(shù)執(zhí)行完，也不能拍拍屁股就走人了，咱可是有禮貌的代碼，再打印一行日志告知下主人，我執(zhí)行完啦。

# 這是裝飾器函數(shù)，參數(shù) func 是被裝飾的函數(shù)
def logger(func):
    def wrapper(*args, **kw):
        print('主人，我準(zhǔn)備開(kāi)始執(zhí)行：{} 函數(shù)了:'.format(func.__name__))

        # 真正執(zhí)行的是這行。
        func(*args, **kw)

        print('主人，我執(zhí)行完啦。')
    return wrapper

假如，我的業(yè)務(wù)函數(shù)是，計(jì)算兩個(gè)數(shù)之和。寫(xiě)好后，直接給它帶上帽子。

然后執(zhí)行一下 add 函數(shù)。

add(200, 50)

來(lái)看看輸出了什么？

03. 入門：時(shí)間計(jì)時(shí)器

再來(lái)看看 時(shí)間計(jì)時(shí)器
實(shí)現(xiàn)功能：顧名思義，就是計(jì)算一個(gè)函數(shù)的執(zhí)行時(shí)長(zhǎng)。

# 這是裝飾函數(shù)
def timer(func):
    def wrapper(*args, **kw):
        t1=time.time()
        # 這是函數(shù)真正執(zhí)行的地方
        func(*args, **kw)
        t2=time.time()

        # 計(jì)算下時(shí)長(zhǎng)
        cost_time = t2-t1 
        print('花費(fèi)時(shí)間：{}秒'.format(cost_time))
    return wrapper

假如，我們的函數(shù)是要睡眠10秒。這樣也能更好的看出這個(gè)計(jì)算時(shí)長(zhǎng)到底靠不靠譜。

來(lái)看看輸出，如預(yù)期一樣，輸出10秒。

花費(fèi)時(shí)間：10.0073800086975098秒

04. 進(jìn)階：帶參數(shù)的函數(shù)裝飾器

通過(guò)上面兩個(gè)簡(jiǎn)單的入門示例，你應(yīng)該能體會(huì)到裝飾器的工作原理了。

不過(guò)，裝飾器的用法還遠(yuǎn)不止如此，深究下去，還大有文章。今天就一起來(lái)把這個(gè)知識(shí)點(diǎn)學(xué)透。

回過(guò)頭去看看上面的例子，裝飾器是不能接收參數(shù)的。其用法，只能適用于一些簡(jiǎn)單的場(chǎng)景。不傳參的裝飾器，只能對(duì)被裝飾函數(shù)，執(zhí)行固定邏輯。

裝飾器本身是一個(gè)函數(shù)，做為一個(gè)函數(shù)，如果不能傳參，那這個(gè)函數(shù)的功能就會(huì)很受限，只能執(zhí)行固定的邏輯。這意味著，如果裝飾器的邏輯代碼的執(zhí)行需要根據(jù)不同場(chǎng)景進(jìn)行調(diào)整，若不能傳參的話，我們就要寫(xiě)兩個(gè)裝飾器，這顯然是不合理的。

比如我們要實(shí)現(xiàn)一個(gè)可以定時(shí)發(fā)送郵件的任務(wù)（一分鐘發(fā)送一封），定時(shí)進(jìn)行時(shí)間同步的任務(wù)（一天同步一次），就可以自己實(shí)現(xiàn)一個(gè) periodic_task （定時(shí)任務(wù)）的裝飾器，這個(gè)裝飾器可以接收一個(gè)時(shí)間間隔的參數(shù)，間隔多長(zhǎng)時(shí)間執(zhí)行一次任務(wù)。

可以這樣像下面這樣寫(xiě)，由于這個(gè)功能代碼比較復(fù)雜，不利于學(xué)習(xí)，這里就不貼了。

那我們來(lái)自己創(chuàng)造一個(gè)偽場(chǎng)景，可以在裝飾器里傳入一個(gè)參數(shù)，指明國(guó)籍，并在函數(shù)執(zhí)行前，用自己國(guó)家的母語(yǔ)打一個(gè)招呼。

# 小明，中國(guó)人
@say_hello('china')
def xiaoming():
    pass

# jack，美國(guó)人
@say_hello('america')
def jack():
    pass

那我們?nèi)绻麑?shí)現(xiàn)這個(gè)裝飾器，讓其可以實(shí)現(xiàn) 傳參 呢？

會(huì)比較復(fù)雜，需要兩層嵌套。

來(lái)執(zhí)行一下

xiaoming()
print('------------')
jack()

看看輸出結(jié)果。

05. 高階：不帶參數(shù)的類裝飾器

以上都是基于函數(shù)實(shí)現(xiàn)的裝飾器，在閱讀別人代碼時(shí)，還可以時(shí)常發(fā)現(xiàn)還有基于類實(shí)現(xiàn)的裝飾器。

基于類裝飾器的實(shí)現(xiàn)，必須實(shí)現(xiàn) __call__ 和 __init__兩個(gè)內(nèi)置函數(shù)。
__init__ ：接收被裝飾函數(shù)
__call__ ：實(shí)現(xiàn)裝飾邏輯。

還是以日志打印這個(gè)簡(jiǎn)單的例子為例

class logger(object):
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        print('[INFO]: the function {func}() is running...'\
            .format(func=self.func.__name__))
        return self.func(*args, **kwargs)

@logger
def say(something):
    print('say {}!'.format(something))

say('hello')

執(zhí)行一下，看看輸出

06. 高階：帶參數(shù)的類裝飾器

上面不帶參數(shù)的例子，你發(fā)現(xiàn)沒(méi)有，只能打印INFO級(jí)別的日志，正常情況下，我們還需要打印DEBUG WARNING等級(jí)別的日志。這就需要給類裝飾器傳入?yún)?shù)，給這個(gè)函數(shù)指定級(jí)別了。

帶參數(shù)和不帶參數(shù)的類裝飾器有很大的不同。

__init__ ：不再接收被裝飾函數(shù)，而是接收傳入?yún)?shù)。
__call__ ：接收被裝飾函數(shù)，實(shí)現(xiàn)裝飾邏輯。

class logger(object):
    def __init__(self, level='INFO'):
        self.level = level

    def __call__(self, func): # 接受函數(shù)
        def wrapper(*args, **kwargs):
            print('[{level}]: the function {func}() is running...'\
                .format(level=self.level, func=func.__name__))
            func(*args, **kwargs)
        return wrapper  #返回函數(shù)

@logger(level='WARNING')
def say(something):
    print('say {}!'.format(something))

say('hello')

我們指定WARNING級(jí)別，運(yùn)行一下，來(lái)看看輸出。

07. 使用偏函數(shù)與類實(shí)現(xiàn)裝飾器

絕大多數(shù)裝飾器都是基于函數(shù)和閉包實(shí)現(xiàn)的，但這并非制造裝飾器的唯一方式。

事實(shí)上，Python 對(duì)某個(gè)對(duì)象是否能通過(guò)裝飾器（ @decorator）形式使用只有一個(gè)要求：decorator 必須是一個(gè)“可被調(diào)用（callable）的對(duì)象。

對(duì)于這個(gè) callable 對(duì)象，我們最熟悉的就是函數(shù)了。

除函數(shù)之外，類也可以是 callable 對(duì)象，只要實(shí)現(xiàn)了__call__ 函數(shù)（上面幾個(gè)例子已經(jīng)接觸過(guò)了）。

還有容易被人忽略的偏函數(shù)其實(shí)也是 callable 對(duì)象。

接下來(lái)就來(lái)說(shuō)說(shuō)，如何使用 類和偏函數(shù)結(jié)合實(shí)現(xiàn)一個(gè)與眾不同的裝飾器。

如下所示，DelayFunc 是一個(gè)實(shí)現(xiàn)了 __call__ 的類，delay 返回一個(gè)偏函數(shù)，在這里 delay 就可以做為一個(gè)裝飾器。（以下代碼摘自 Python工匠：使用裝飾器的小技巧）

import time
import functools

class DelayFunc:
    def __init__(self,  duration, func):
        self.duration = duration
        self.func = func

    def __call__(self, *args, **kwargs):
        print(f'Wait for {self.duration} seconds...')
        time.sleep(self.duration)
        return self.func(*args, **kwargs)

    def eager_call(self, *args, **kwargs):
        print('Call without delay')
        return self.func(*args, **kwargs)

def delay(duration):
    '''
    裝飾器：推遲某個(gè)函數(shù)的執(zhí)行。
    同時(shí)提供 .eager_call 方法立即執(zhí)行
    '''
    # 此處為了避免定義額外函數(shù)，
    # 直接使用 functools.partial 幫助構(gòu)造 DelayFunc 實(shí)例
    return functools.partial(DelayFunc, duration)

我們的業(yè)務(wù)函數(shù)很簡(jiǎn)單，就是相加

來(lái)看一下執(zhí)行過(guò)程

>>> add    # 可見(jiàn) add 變成了 Delay 的實(shí)例
<__main__.DelayFunc object at 0x107bd0be0>
>>> 
>>> add(3,5)  # 直接調(diào)用實(shí)例，進(jìn)入 __call__
Wait for 2 seconds...
8
>>> 
>>> add.func # 實(shí)現(xiàn)實(shí)例方法
<function add at 0x107bef1e0>

08. 如何寫(xiě)能裝飾類的裝飾器？

用 Python 寫(xiě)單例模式的時(shí)候，常用的有三種寫(xiě)法。其中一種，是用裝飾器來(lái)實(shí)現(xiàn)的。

以下便是我自己寫(xiě)的裝飾器版的單例寫(xiě)法。

可以看到我們用singleton 這個(gè)裝飾函數(shù)來(lái)裝飾 User 這個(gè)類。裝飾器用在類上，并不是很常見(jiàn)，但只要熟悉裝飾器的實(shí)現(xiàn)過(guò)程，就不難以實(shí)現(xiàn)對(duì)類的裝飾。在上面這個(gè)例子中，裝飾器就只是實(shí)現(xiàn)對(duì)類實(shí)例的生成的控制而已。

其實(shí)例化的過(guò)程，你可以參考我這里的調(diào)試過(guò)程，加以理解。

09. wraps 裝飾器有啥用？

在 functools 標(biāo)準(zhǔn)庫(kù)中有提供一個(gè) wraps 裝飾器，你應(yīng)該也經(jīng)常見(jiàn)過(guò)，那他有啥用呢？

先來(lái)看一個(gè)例子

def wrapper(func):
    def inner_function():
        pass
    return inner_function

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
#inner_function

為什么會(huì)這樣子？不是應(yīng)該返回 func 嗎？

這也不難理解，因?yàn)樯线厛?zhí)行func 和下邊 decorator(func)  是等價(jià)的，所以上面 func.__name__ 是等價(jià)于下面decorator(func).__name__ 的，那當(dāng)然名字是 inner_function

那如何避免這種情況的產(chǎn)生？方法是使用 functools .wraps 裝飾器，它的作用就是將 被修飾的函數(shù)(wrapped) 的一些屬性值賦值給 修飾器函數(shù)(wrapper) ，最終讓屬性的顯示更符合我們的直覺(jué)。

from functools import wraps

def wrapper(func):
    @wraps(func)
    def inner_function():
        pass
    return inner_function

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
# wrapped

準(zhǔn)確點(diǎn)說(shuō)，wraps 其實(shí)是一個(gè)偏函數(shù)對(duì)象（partial），源碼如下

可以看到wraps其實(shí)就是調(diào)用了一個(gè)函數(shù)update_wrapper，知道原理后，我們改寫(xiě)上面的代碼，在不使用 wraps的情況下，也可以讓 wrapped.__name__ 打印出 wrapped，代碼如下：

from functools import update_wrapper

WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
                       '__annotations__')

def wrapper(func):
    def inner_function():
        pass

    update_wrapper(inner_function, func, assigned=WRAPPER_ASSIGNMENTS)
    return inner_function

@wrapper
def wrapped():
    pass

print(wrapped.__name__)

10. 內(nèi)置裝飾器：property

以上，我們介紹的都是自定義的裝飾器。

其實(shí)Python語(yǔ)言本身也有一些裝飾器。比如property這個(gè)內(nèi)建裝飾器，我們?cè)偈煜げ贿^(guò)了。

它通常存在于類中，可以將一個(gè)函數(shù)定義成一個(gè)屬性，屬性的值就是該函數(shù)return的內(nèi)容。

通常我們給實(shí)例綁定屬性是這樣的

但是稍有經(jīng)驗(yàn)的開(kāi)發(fā)人員，一下就可以看出，這樣直接把屬性暴露出去，雖然寫(xiě)起來(lái)很簡(jiǎn)單，但是并不能對(duì)屬性的值做合法性限制。為了實(shí)現(xiàn)這個(gè)功能，我們可以這樣寫(xiě)。

class Student(object):
    def __init__(self, name):
        self.name = name
        self.name = None

    def set_age(self, age):
        if not isinstance(age, int):
            raise ValueError('輸入不合法：年齡必須為數(shù)值!')
        if not 0 < age < 100:
            raise ValueError('輸入不合法：年齡范圍必須0-100')
        self._age=age

    def get_age(self):
        return self._age

    def del_age(self):
        self._age = None


xiaoming = Student('小明')

# 添加屬性
xiaoming.set_age(25)

# 查詢屬性
xiaoming.get_age()

# 刪除屬性
xiaoming.del_age()

上面的代碼設(shè)計(jì)雖然可以變量的定義，但是可以發(fā)現(xiàn)不管是獲取還是賦值（通過(guò)函數(shù)）都和我們平時(shí)見(jiàn)到的不一樣。
按照我們思維習(xí)慣應(yīng)該是這樣的。

那么這樣的方式我們?nèi)绾螌?shí)現(xiàn)呢。請(qǐng)看下面的代碼。

class Student(object):
    def __init__(self, name):
        self.name = name
        self.name = None

    @property
    def age(self):
        return self._age

    @age.setter
    def age(self, value):
        if not isinstance(value, int):
            raise ValueError('輸入不合法：年齡必須為數(shù)值!')
        if not 0 < value < 100:
            raise ValueError('輸入不合法：年齡范圍必須0-100')
        self._age=value

    @age.deleter
    def age(self):
        del self._age

xiaoming = Student('小明')

# 設(shè)置屬性
xiaoming.age = 25

# 查詢屬性
xiaoming.age

# 刪除屬性
del xiaoming.age

用@property裝飾過(guò)的函數(shù)，會(huì)將一個(gè)函數(shù)定義成一個(gè)屬性，屬性的值就是該函數(shù)return的內(nèi)容。同時(shí)，會(huì)將這個(gè)函數(shù)變成另外一個(gè)裝飾器。就像后面我們使用的@age.setter和@age.deleter。

@age.setter 使得我們可以使用XiaoMing.age = 25這樣的方式直接賦值。
@age.deleter 使得我們可以使用del XiaoMing.age這樣的方式來(lái)刪除屬性。

property 的底層實(shí)現(xiàn)機(jī)制是「描述符」，為此我還寫(xiě)過(guò)一篇文章。

這里也介紹一下吧，正好將這些看似零散的文章全部串起來(lái)。

如下，我寫(xiě)了一個(gè)類，里面使用了 property 將 math 變成了類實(shí)例的屬性

為什么說(shuō) property 底層是基于描述符協(xié)議的呢？通過(guò) PyCharm 點(diǎn)擊進(jìn)入 property 的源碼，很可惜，只是一份類似文檔一樣的偽源碼，并沒(méi)有其具體的實(shí)現(xiàn)邏輯。

不過(guò)，從這份偽源碼的魔法函數(shù)結(jié)構(gòu)組成，可以大體知道其實(shí)現(xiàn)邏輯。

這里我自己通過(guò)模仿其函數(shù)結(jié)構(gòu)，結(jié)合「描述符協(xié)議」來(lái)自己實(shí)現(xiàn)類 property 特性。

代碼如下：

class TestProperty(object):

    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
        self.fget = fget
        self.fset = fset
        self.fdel = fdel
        self.__doc__ = doc

    def __get__(self, obj, objtype=None):
        print('in __get__')
        if obj is None:
            return self
        if self.fget is None:
            raise AttributeError
        return self.fget(obj)

    def __set__(self, obj, value):
        print('in __set__')
        if self.fset is None:
            raise AttributeError
        self.fset(obj, value)

    def __delete__(self, obj):
        print('in __delete__')
        if self.fdel is None:
            raise AttributeError
        self.fdel(obj)


    def getter(self, fget):
        print('in getter')
        return type(self)(fget, self.fset, self.fdel, self.__doc__)

    def setter(self, fset):
        print('in setter')
        return type(self)(self.fget, fset, self.fdel, self.__doc__)

    def deleter(self, fdel):
        print('in deleter')
        return type(self)(self.fget, self.fset, fdel, self.__doc__)

然后 Student 類，我們也相應(yīng)改成如下

為了盡量讓你少產(chǎn)生一點(diǎn)疑惑，我這里做兩點(diǎn)說(shuō)明：

1. 使用TestProperty裝飾后，math 不再是一個(gè)函數(shù)，而是TestProperty類的一個(gè)實(shí)例。所以第二個(gè)math函數(shù)可以使用 math.setter 來(lái)裝飾，本質(zhì)是調(diào)用TestProperty.setter 來(lái)產(chǎn)生一個(gè)新的 TestProperty 實(shí)例賦值給第二個(gè)math。

2. 第一個(gè) math 和第二個(gè) math 是兩個(gè)不同 TestProperty 實(shí)例。但他們都屬于同一個(gè)描述符類（TestProperty），當(dāng)對(duì) math 對(duì)于賦值時(shí)，就會(huì)進(jìn)入 TestProperty.__set__，當(dāng)對(duì)math 進(jìn)行取值里，就會(huì)進(jìn)入 TestProperty.__get__。仔細(xì)一看，其實(shí)最終訪問(wèn)的還是Student實(shí)例的 _math 屬性。

說(shuō)了這么多，還是運(yùn)行一下，更加直觀一點(diǎn)。

# 運(yùn)行后，會(huì)直接打印這一行，這是在實(shí)例化 TestProperty 并賦值給第二個(gè)math
in setter
>>>
>>> s1.math = 90
in __set__
>>> s1.math
in __get__
90

如對(duì)上面代碼的運(yùn)行原理，有疑問(wèn)的同學(xué)，請(qǐng)務(wù)必結(jié)合上面兩點(diǎn)說(shuō)明加以理解，那兩點(diǎn)相當(dāng)關(guān)鍵。

11. 其他裝飾器：裝飾器實(shí)戰(zhàn)

讀完并理解了上面的內(nèi)容，你可以說(shuō)是Python高手了。別懷疑，自信點(diǎn)，因?yàn)楹芏嗳硕疾恢姥b飾器有這么多用法呢。

在我看來(lái)，使用裝飾器，可以達(dá)到如下目的：

• 使代碼可讀性更高，逼格更高；

• 代碼結(jié)構(gòu)更加清晰，代碼冗余度更低；

剛好我在最近也有一個(gè)場(chǎng)景，可以用裝飾器很好的實(shí)現(xiàn)，暫且放上來(lái)看看。

這是一個(gè)實(shí)現(xiàn)控制函數(shù)運(yùn)行超時(shí)的裝飾器。如果超時(shí)，則會(huì)拋出超時(shí)異常。

有興趣的可以看看。

---

以上，便是我對(duì)裝飾器的所有分享。

---

非常感謝你能閱讀到這里，這篇文章我寫(xiě)了很久，算是比較干貨的那種，文章有些長(zhǎng)，但還是希望花點(diǎn)時(shí)間把這些知識(shí)點(diǎn)都搞明白，而不要只是收藏。

另外，很多讀者反映送書(shū)活動(dòng)向來(lái)都是絕緣體，十分的扎心。于是乎Python進(jìn)階者想著增加大家的歸屬感，遂決定在明天發(fā)布的文章將第一次嘗試送紅包，一次發(fā)放40個(gè)紅包，感謝大家一路的支持和相伴，歡迎大家一起來(lái)參與。

------------------ End -------------------