一篇文章搞懂裝飾器全部用法（建議收藏）

時間 2019-11-06

標籤一篇文章裝飾全部用法建議收藏简体版

原文原文鏈接

本文的目錄以下：python

裝飾器語法糖
入門用法：日誌打印器
入門用法：時間計時器
進階用法：帶參數的函數裝飾器
高階用法：不帶參數的類裝飾器
高階用法：帶參數的類裝飾器
使用偏函數與類實現裝飾器
如何寫能裝飾類的裝飾器？
wraps 裝飾器有啥用？
內置裝飾器：property
其餘裝飾器：裝飾器實戰

01. 裝飾器語法糖

若是你接觸 Python 有一段時間了的話，想必你對 @ 符號必定不陌生了，沒錯 @ 符號就是裝飾器的語法糖。bash

它放在一個函數開始定義的地方，它就像一頂帽子同樣戴在這個函數的頭上。和這個函數綁定在一塊兒。在咱們調用這個函數的時候，第一件事並非執行這個函數，而是將這個函數作爲參數傳入它頭頂上這頂帽子，這頂帽子咱們稱之爲裝飾函數 或 裝飾器。閉包

你要問我裝飾器能夠實現什麼功能？我只能說你的腦洞有多大，裝飾器就有多強大。app

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

先定義一個裝飾函數（帽子）（也能夠用類、偏函數實現）
再定義你的業務函數、或者類（人）
最後把這頂帽子帶在這我的頭上

裝飾器的簡單的用法有不少，這裏舉兩個常見的。spa

日誌打印器
時間計時器

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

首先是日誌打印器。它要實現的功能是設計

在函數執行前，先打印一行日誌告知一下主人，我要執行函數了。
在函數執行完，也不能拍拍屁股就走人了，咱但是有禮貌的代碼，再打印一行日誌告知下主人，我執行完啦。

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

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

        print('啊哈，我計算完啦。給本身加個雞腿！！')
    return wrapper
複製代碼

假如，個人業務函數是，計算兩個數之和。寫好後，直接給它帶上帽子。調試

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

而後咱們來計算一下。日誌

add(200, 50)
複製代碼

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

我準備開始計算：add 函數了:
200 + 50 = 250
啊哈，我計算完啦。給本身加個雞腿！
複製代碼

03. 入門用法：時間計時器

再來看看 時間計時器 實現功能：顧名思義，就是計算一個函數的執行時長。

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

        # 計算下時長
        cost_time = t2-t1 
        print("花費時間：{}秒".format(cost_time))
    return wrapper
複製代碼

假如，咱們的函數是要睡眠10秒。這樣也能更好的看出這個計算時長到底靠不靠譜。

import time

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

want_sleep(10)
複製代碼

來看看，輸出。真的是10秒。

花費時間：10.0073800086975098秒
複製代碼

04. 進階用法：帶參數的函數裝飾器

經過上面簡單的入門，你大概已經感覺到了裝飾的神奇魅力了。

不過，裝飾器的用法遠不止如此。咱們今天就要把這個知識點學透。

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

若是你有經驗，你必定常常在項目中，看到有的裝飾器是帶有參數的。

裝飾器自己是一個函數，既然作爲一個函數都不能攜帶函數，那這個函數的功能就很受限。只能執行固定的邏輯。這無疑是很是不合理的。而若是咱們要用到兩個內容大致一致，只是某些地方不一樣的邏輯。不傳參的話，咱們就要寫兩個裝飾器。小明以爲這不能忍。

那麼裝飾器如何實現傳參呢，會比較複雜，須要兩層嵌套。

一樣，咱們也來舉個例子。

咱們要在這兩個函數的執行的時候，分別根據其國籍，來講出一段打招呼的話。

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

def chinese():
    print("我來自中國。")
複製代碼

在給他們倆戴上裝飾器的時候，就要跟裝飾器說，這我的是哪國人，而後裝飾器就會作出判斷，打出對應的招呼。

戴上帽子後，是這樣的。

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

@say_hello("america")
def american():
    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

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

複製代碼

執行一下

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

複製代碼

看看輸出結果。

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

複製代碼

emmmm，這很NB。。。

05. 高階用法：不帶參數的類裝飾器

以上都是基於函數實現的裝飾器，在閱讀別人代碼時，還能夠時常發現還有基於類實現的裝飾器。

基於類裝飾器的實現，必須實現 __call__ 和 __init__兩個內置函數。 __init__ ：接收被裝飾函數 __call__ ：實現裝飾邏輯。

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

複製代碼

執行一下，看看輸出

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

複製代碼

06. 高階用法：帶參數的類裝飾器

上面不帶參數的例子，你發現沒有，只能打印INFO級別的日誌，正常狀況下，咱們還須要打印DEBUG WARNING等級別的日誌。這就須要給類裝飾器傳入參數，給這個函數指定級別了。

帶參數和不帶參數的類裝飾器有很大的不一樣。

__init__ ：再也不接收被裝飾函數，而是接收傳入參數。 __call__ ：接收被裝飾函數，實現裝飾邏輯。

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

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

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

say("hello")

複製代碼

咱們指定WARNING級別，運行一下，來看看輸出。

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

複製代碼

07. 使用偏函數與類實現裝飾器

絕大多數裝飾器都是基於函數和閉包實現的，但這並不是製造裝飾器的惟一方式。

事實上，Python 對某個對象是否能經過裝飾器（ @decorator）形式使用只有一個要求：decorator 必須是一個「可被調用（callable）的對象。

對於這個 callable 對象，咱們最熟悉的就是函數了。

除函數以外，類也能夠是 callable 對象，只要實現了__call__ 函數（上面幾個盒子已經接觸過了），還有比較少人使用的偏函數也是 callable 對象。

接下來就來講說，如何使用類和偏函數結合實現一個不同凡響的裝飾器。

以下所示，DelayFunc 是一個實現了 __call__ 的類，delay 返回一個偏函數，在這裏 delay 就能夠作爲一個裝飾器。（如下代碼摘自 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):
    """ 裝飾器：推遲某個函數的執行。 同時提供 .eager_call 方法當即執行 """
    # 此處爲了不定義額外函數，
	# 直接使用 functools.partial 幫助構造 DelayFunc 實例
    return functools.partial(DelayFunc, duration)

複製代碼

咱們的業務函數很簡單，就是相加

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

複製代碼

來看一下執行過程

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

複製代碼

08. 如何寫能裝飾類的裝飾器？

用 Python 寫單例模式的時候，經常使用的有三種寫法。其中一種，是用裝飾器來實現的。

如下即是我本身寫的裝飾器版的單例寫法。

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 這個裝飾函數來裝飾 User 這個類。裝飾器用在類上，並非很常見，但只要熟悉裝飾器的實現過程，就不難以實現對類的裝飾。在上面這個例子中，裝飾器就只是實現對類實例的生成的控制而已。

其實例化的過程，你能夠參考我這裏的調試過程，加以理解。

09. wraps 裝飾器有啥用？

在 functools 標準庫中有提供一個 wraps 裝飾器，你應該也常常見過，那他有啥用呢？

先來看一個例子

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

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
#inner_function

複製代碼

爲何會這樣子？不是應該返回 func 嗎？

這也不難理解，由於上邊執行func 和下邊 decorator(func) 是等價的，因此上面 func.__name__ 是等價於下面decorator(func).__name__ 的，那固然名字是 inner_function

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

def wrapped():
    pass

print(wrapper(wrapped).__name__)
#inner_function

複製代碼

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

from functools import wraps

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

@wrapper
def wrapped():
    pass

print(wrapped.__name__)
# wrapped
複製代碼

準確點說，wraps 實際上是一個偏函數對象（partial），源碼以下

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

複製代碼

能夠看到wraps其實就是調用了一個函數update_wrapper，知道原理後，咱們改寫上面的代碼，在不使用 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. 內置裝飾器：property

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

其實Python語言自己也有一些裝飾器。好比property這個內建裝飾器，咱們再熟悉不過了。

它一般存在於類中，能夠將一個函數定義成一個屬性，屬性的值就是該函數return的內容。

一般咱們給實例綁定屬性是這樣的

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

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

# 添加屬性
XiaoMing.age=25

# 查詢屬性
XiaoMing.age

# 刪除屬性
del XiaoMing.age

複製代碼

可是稍有經驗的開發人員，一下就能夠看出，這樣直接把屬性暴露出去，雖然寫起來很簡單，可是並不能對屬性的值作合法性限制。爲了實現這個功能，咱們能夠這樣寫。

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('輸入不合法：年齡必須爲數值!')
        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()

複製代碼

上面的代碼設計雖然能夠變量的定義，可是能夠發現不論是獲取仍是賦值（經過函數）都和咱們平時見到的不同。按照咱們思惟習慣應該是這樣的。

# 賦值
XiaoMing.age = 25

# 獲取
XiaoMing.age

複製代碼

那麼這樣的方式咱們如何實現呢。請看下面的代碼。

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('輸入不合法：年齡必須爲數值!')
        if not 0 < value < 100:
            raise ValueError('輸入不合法：年齡範圍必須0-100')
        self._age=value

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

XiaoMing = Student("小明")

# 設置屬性
XiaoMing.age = 25

# 查詢屬性
XiaoMing.age

# 刪除屬性
del XiaoMing.age

複製代碼

用@property裝飾過的函數，會將一個函數定義成一個屬性，屬性的值就是該函數return的內容。同時，會將這個函數變成另一個裝飾器。就像後面咱們使用的@age.setter和@age.deleter。

@age.setter 使得咱們可使用XiaoMing.age = 25這樣的方式直接賦值。 @age.deleter 使得咱們可使用del XiaoMing.age這樣的方式來刪除屬性。

property 的底層實現機制是「描述符」，爲此我還寫過一篇文章。

這裏也介紹一下吧，正好將這些看似零散的文章所有串起來。

以下，我寫了一個類，裏面使用了 property 將 math 變成了類實例的屬性

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 底層是基於描述符協議的呢？經過 PyCharm 點擊進入 property 的源碼，很惋惜，只是一份相似文檔同樣的僞源碼，並無其具體的實現邏輯。

不過，從這份僞源碼的魔法函數結構組成，能夠大致知道其實現邏輯。

這裏我本身經過模仿其函數結構，結合「描述符協議」來本身實現類 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 類，咱們也相應改爲以下

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

    # 其實只有這裏改變
 @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]")

複製代碼

爲了儘可能讓你少產生一點疑惑，我這裏作兩點說明：

使用TestProperty裝飾後，math 再也不是一個函數，而是TestProperty 類的一個實例。因此第二個math函數可使用 math.setter 來裝飾，本質是調用TestProperty.setter 來產生一個新的 TestProperty 實例賦值給第二個math。
第一個 math 和第二個 math 是兩個不一樣 TestProperty 實例。但他們都屬於同一個描述符類（TestProperty），當對 math 對於賦值時，就會進入 TestProperty.__set__，當對math 進行取值裏，就會進入 TestProperty.__get__。仔細一看，其實最終訪問的仍是Student實例的 _math 屬性。

說了這麼多，仍是運行一下，更加直觀一點。

# 運行後，會直接打印這一行，這是在實例化 TestProperty 並賦值給第二個math
in setter
>>>
>>> s1.math = 90
in __set__
>>> s1.math
in __get__
90

複製代碼

如對上面代碼的運行原理，有疑問的同窗，請務必結合上面兩點說明加以理解，那兩點至關關鍵。

11. 其餘裝飾器：裝飾器實戰

讀完並理解了上面的內容，你能夠說是Python高手了。別懷疑，自信點，由於不少人都不知道裝飾器有這麼多用法呢。

在小明看來，使用裝飾器，能夠達到以下目的：

使代碼可讀性更高，逼格更高；
代碼結構更加清晰，代碼冗餘度更低；

恰好小明在最近也有一個場景，能夠用裝飾器很好的實現，暫且放上來看看。

這是一個實現控制函數運行超時的裝飾器。若是超時，則會拋出超時異常。

有興趣的能夠看看。

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

複製代碼

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。