十足乾貨｜Python裝飾器的從入門到高階用法詳解

時間 2020-11-23

標籤 app ide 函數 spa 設計日誌 code orm 開發欄目 Python 简体版

原文原文鏈接

首先要恭喜你，點進了這一篇十足乾貨。app

不怕感動本身，這篇文章，小明足足整理了三天之久。絕對值得收藏，以備後用。ide

今天小明要講的是，Python中的裝飾器內容。函數

我會從裝飾器的入門用法逐步講到其高階用法。spa

. 目錄以下

裝飾器語法糖設計
入門用法：日誌打印器日誌
入門用法：時間計時器code
進階用法：帶參數的函數裝飾器orm
高階用法：不帶參數的類裝飾器ci
高階用法：帶參數的類裝飾器開發
內置裝飾器：property
其餘裝飾器：裝飾器實戰

. 裝飾器語法糖

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

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

你要問我裝飾器能夠實現什麼功能？這個真的是無解，小明只能說你的腦洞有多大，裝飾器就有多強大。

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

先定義一個裝飾函數（帽子）
再定義你的業務函數（人）
最後把這頂帽子帶在這我的頭上

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

日誌打印器
時間計時器

. 入門用法：日誌打印器

首先是日誌打印器。
實現的功能：

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

# 這是裝飾函數
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)

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

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

. 入門用法：時間計時器

再來看看 時間計時器
實現功能：

顧名思義，就是計算一個函數的執行時長。

# 這是裝飾函數
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

假如，咱們的函數是要睡眠 2秒（冏~，小明實在不知道要舉什麼例子了）。這樣也能更好的看出這個計算時長到底靠不靠譜。

import time

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

want_sleep( 2)

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

花費時間：2.0073800086975098秒

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

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

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

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

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

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

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

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

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

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

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

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

戴上帽子後，是這樣的。

@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

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

執行一下

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

看看輸出結果。

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

emmmm，這很NB。。。

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

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

基於類裝飾器的實現，必須實現 __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!

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

上面不帶參數的例子，你發現沒有，只能打印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!

. 內置裝飾器：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