00. 裝飾器簡介

在編程領(lǐng)域，有兩個(gè)原則是必須遵守的，具體就是開放封閉的原則，具體如下：

• 封閉：已實(shí)現(xiàn)的功能代碼不應(yīng)該被修改

• 開放：對現(xiàn)有功能的擴(kuò)展開放

  如果我們有N個(gè)函數(shù)，我們需要在N個(gè)函數(shù)中增加或者減少?個(gè)功能，那么也就意味著我們需要把同樣的代碼增加 多次或者是減少多次，很明顯這不符合開放封閉的原則，?且也不是?個(gè)好的編程?格，那么解決思路是什么了？ 解決思路就是裝飾器。我們先來寫?個(gè)簡單的裝飾器，再來看它的調(diào)?順序和過程，具體代碼如下：

  #!/usr/bin/env python
  #!coding:utf-8
  def outer(funObect):
    def inner():
        print('this is a log info')
        return funObect()
    return inner
  @outer
  def func():
    return 'this is a function'
  if __name__ == '__main__':
    print(func())
  

對如上的代碼進(jìn)?逐步的解釋：

a、?動(dòng)執(zhí)?outer函數(shù)并且將其下?的函數(shù)名fun當(dāng)作參數(shù)來傳遞；

b、將outer函數(shù)的返回值(變量或者是函數(shù))，重新賦值給fun；

c、?旦結(jié)合裝飾器后,調(diào)?fun其實(shí)執(zhí)?的是inner函數(shù)內(nèi)部,原來的fun被覆蓋；

d、?旦這個(gè)函數(shù)被裝飾器裝飾之后，被裝飾的函數(shù)重新賦值成裝飾器的內(nèi)層函數(shù)

依據(jù)如上，我們可以總結(jié)出，它執(zhí)?的順序具體為：

• 先執(zhí)?outer的函數(shù)
• 再執(zhí)?內(nèi)部函數(shù)inner
• 下來執(zhí)?到inner函數(shù)的返回值
• 再具體到inner的函數(shù)，執(zhí)?inner函數(shù)??的表達(dá)式

01.裝飾器語法糖

如果你接觸 Python 有一段時(shí)間了的話，想必你對 @ 符號一定不陌生了，沒錯(cuò) @ 符號就是裝飾器的語法糖。

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

你要問我裝飾器可以實(shí)現(xiàn)什么功能？我只能說你的腦洞有多大，裝飾器就有多強(qiáng)大。

裝飾器的使用方法很固定：

• 先定義一個(gè)裝飾函數(shù)（帽子）（也可以用類、偏函數(shù)實(shí)現(xiàn)）
• 再定義你的業(yè)務(wù)函數(shù)、或者類（人）
• 最后把這頂帽子帶在這個(gè)人頭上

裝飾器的簡單的用法有很多，這里舉兩個(gè)常見的。

• 日志打印器
• 時(shí)間計(jì)時(shí)器

02. 入門用法：日志打印器

首先是日志打印器。

實(shí)現(xiàn)的功能：

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

# 這是裝飾函數(shù)
def logger(func):
    def wrapper(*args, **kw):
        print('我準(zhǔn)備開始計(jì)算：{} 函數(shù)了:'.format(func.__name__))

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

        print('啊哈，我計(jì)算完啦。給自己加個(gè)雞腿！！')
    return wrapper

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

@logger
def add(x, y):
    print('{} + {} = {}'.format(x, y, x+y))

然后我們來計(jì)算一下。

add(200, 50)

快來看看輸出了什么，神奇不？

我準(zhǔn)備開始計(jì)算：add 函數(shù)了:
200 + 50 = 250
啊哈，我計(jì)算完啦。給自己加個(gè)雞腿！

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

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

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

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

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

import time

@timer
def want_sleep(sleep_time):
    time.sleep(sleep_time)

want_sleep(10)

來看看，輸出。真的是10秒耶。真歷害！??！

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

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

通過上面簡單的入門，你大概已經(jīng)感受到了裝飾的神奇魅力了。

不過，裝飾器的用法遠(yuǎn)不止如此。我們今天就要把這個(gè)知識點(diǎn)講透。

上面的例子，裝飾器是不能接收參數(shù)的。其用法，只能適用于一些簡單的場景。不傳參的裝飾器，只能對被裝飾函數(shù)，執(zhí)行固定邏輯。

如果你有經(jīng)驗(yàn)，你一定經(jīng)常在項(xiàng)目中，看到有的裝飾器是帶有參數(shù)的。

裝飾器本身是一個(gè)函數(shù)，既然做為一個(gè)函數(shù)都不能攜帶函數(shù)，那這個(gè)函數(shù)的功能就很受限。只能執(zhí)行固定的邏輯。這無疑是非常不合理的。而如果我們要用到兩個(gè)內(nèi)容大體一致，只是某些地方不同的邏輯。不傳參的話，我們就要寫兩個(gè)裝飾器。小明覺得這不能忍。

那么裝飾器如何實(shí)現(xiàn)傳參呢，會(huì)比較復(fù)雜，需要兩層嵌套。

同樣，我們也來舉個(gè)例子。

我們要在這兩個(gè)函數(shù)的執(zhí)行的時(shí)候，分別根據(jù)其國籍，來說出一段打招呼的話。

def american():
    print("我來自中國。")

def chinese():
    print("I am from America.")

在給他們倆戴上裝飾器的時(shí)候，就要跟裝飾器說，這個(gè)人是哪國人，然后裝飾器就會(huì)做出判斷，打出對應(yīng)的招呼。

戴上帽子后，是這樣的。

@say_hello("china")
def american():
    print("我來自中國。")

@say_hello("america")
def chinese():
    print("I am from America.")

萬事俱備，只差帽子了。來定義一下，這里需要兩層嵌套。

def say_hello(contry):
    def wrapper(func):
        def deco(*args, **kwargs):
            if contry == "china":
                print("你好!")
            elif contry == "america":
                print('hello.')
            else:
                return

            # 真正執(zhí)行函數(shù)的地方
            func(*args, **kwargs)
        return deco
    return wrapper

執(zhí)行一下

american()
print("------------")
chinese()

看看輸出結(jié)果。

你好!
我來自中國。
------------
hello.
I am from America

emmmm，這很NB。。。

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)裝飾邏輯

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í)行一下，看看輸出

[INFO]: the function say() is running...
say hello!

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

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

帶參數(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級別，運(yùn)行一下，來看看輸出。

[WARNING]: the function say() is running...
say hello!

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

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

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

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

除函數(shù)之外，類也可以是 callable 對象，只要實(shí)現(xiàn)了__call__ 函數(shù)（上面幾個(gè)盒子已經(jīng)接觸過了），還有比較少人使用的偏函數(shù)也是 callable 對象。

接下來就來說說，如何使用 類和偏函數(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ù)很簡單，就是相加

@delay(duration=2)
def add(a, b):
    return a+b

來看一下執(zhí)行過程

>>> add    # 可見 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. 如何寫能裝飾類的裝飾器？

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

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

instances = {}

def singleton(cls):
    def get_instance(*args, **kw):
        cls_name = cls.__name__
        print('===== 1 ====')
        if not cls_name in instances:
            print('===== 2 ====')
            instance = cls(*args, **kw)
            instances[cls_name] = instance
        return instances[cls_name]
    return get_instance

@singleton
class User:
    _instance = None

    def __init__(self, name):
        print('===== 3 ====')
        self.name = name

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

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

09. wraps 裝飾器有啥用？

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

先來看一個(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

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

def wrapped():
    pass

print(wrapper(wrapped).__name__)
#inner_function

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

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__)

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

def wraps(wrapped,
          assigned = WRAPPER_ASSIGNMENTS,
          updated = WRAPPER_UPDATES):
    return partial(update_wrapper, wrapped=wrapped,
                   assigned=assigned, updated=updated)

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

from functools import update_wrapper

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

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
# wrapped

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

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

其實(shí)Python語言本身也有一些裝飾器。比如property這個(gè)內(nèi)建裝飾器，我們再熟悉不過了。

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

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

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

# 實(shí)例化
XiaoMing = Student("小明")

# 添加屬性
XiaoMing.age=25

# 查詢屬性
XiaoMing.age

# 刪除屬性
del XiaoMing.age

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

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)不管是獲取還是賦值（通過函數(shù)）都和我們平時(shí)見到的不一樣。
按照我們思維習(xí)慣應(yīng)該是這樣的。

# 賦值
XiaoMing.age = 25

# 獲取
XiaoMing.age

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

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裝飾過的函數(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這樣的方式來刪除屬性。

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

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

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

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

    @property
    def math(self):
        return self._math

    @math.setter
    def math(self, value):
        if 0 <= value <= 100:
            self._math = value
        else:
            raise ValueError("Valid value must be in [0, 100]")

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

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

這里我自己通過模仿其函數(shù)結(jié)構(gòu)，結(jié)合「描述符協(xié)議」來自己實(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)改成如下

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

    # 其實(shí)只有這里改變
    @TestProperty
    def math(self):
        return self._math

    @math.setter
    def math(self, value):
        if 0 <= value <= 100:
            self._math = value
        else:
            raise ValueError("Valid value must be in [0, 100]")

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

1. 使用TestProperty裝飾后，math 不再是一個(gè)函數(shù)，而是TestProperty 類的一個(gè)實(shí)例。所以第二個(gè)math函數(shù)可以使用 math.setter 來裝飾，本質(zhì)是調(diào)用TestProperty.setter 來產(chǎn)生一個(gè)新的 TestProperty 實(shí)例賦值給第二個(gè)math。
2. 第一個(gè) math 和第二個(gè) math 是兩個(gè)不同 TestProperty 實(shí)例。但他們都屬于同一個(gè)描述符類（TestProperty），當(dāng)對 math 對于賦值時(shí)，就會(huì)進(jìn)入 TestProperty.__set__，當(dāng)對math 進(jìn)行取值里，就會(huì)進(jìn)入 TestProperty.__get__。仔細(xì)一看，其實(shí)最終訪問的還是Student實(shí)例的 _math 屬性。

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

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

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

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

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

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

• 使代碼可讀性更高，逼格更高；
• 代碼結(jié)構(gòu)更加清晰，代碼冗余度更低；

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

import signal

class TimeoutException(Exception):
    def __init__(self, error='Timeout waiting for response from Cloud'):
        Exception.__init__(self, error)


def timeout_limit(timeout_time):
    def wraps(func):
        def handler(signum, frame):
            raise TimeoutException()

        def deco(*args, **kwargs):
            signal.signal(signal.SIGALRM, handler)
            signal.alarm(timeout_time)
            func(*args, **kwargs)
            signal.alarm(0)
        return deco
    return wraps

動(dòng)動(dòng)手，自己實(shí)踐一下吧~