給妹子講python-S01E22詳解神奇的裝飾器

醬油哥在掘金發表於2018-08-22

歡迎關注公眾號:python資料科學家

【要點搶先看】

1.神奇的裝飾器到底是什麼
2.裝飾器的用法和語法糖
3.裝飾器如何新增引數

裝飾器是python裡的一個非常有意思的部分,他用於封裝函式程式碼,顯式的將封裝器應用到被封裝的函式上,從而使得他們選擇加入到裝飾器指定的功能中。對於在函式執行前處理常見前置條件(例如確認授權),或在函式執行後確保清理(輸出清除或異常處理),裝飾器都非常有用。

【妹子說】聽不明白,太繞了!

簡單來說,裝飾器就是實現了一個通用的功能,然後將這個通用的功能應用到不同的、需要使用這個功能的函式上,從而避免每次都在不同函式上反覆寫相同的功能程式碼。

裝飾器的本質是一個函式,他接受被裝飾的函式作為位置引數,裝飾器通過使用該引數來執行某些操作,然後返回一個函式引用,這個函式可以是原始函式,或者是另外一個函式。

我們舉例子說明,裝飾器是這樣的函式,他們接受被裝飾的可呼叫函式作為唯一的引數,並且返回一個可呼叫函式,

registry = []
def register(decorated):
    registry.append(decorated)
    return decorated

def foo():
    return 3

foo = register(foo)
print(registry[0])

<function foo at 0x00000000025D51E0>
複製程式碼

register方法是一個簡單的裝飾器,它把被裝飾的函式新增到一個列表中,然後這裡是將未改變的被裝飾函式返回,可以看出,裝飾器一般是傳入被裝飾函式的引用,然後經過一些指定的處理,最後返回值也是一個函式引用。

還有一種更簡單的語法形式:

裝飾器的語法糖:我們這裡看到的對foo進行裝飾的方法是運用

foo = register(foo)語句,還有一種簡單的用法是在宣告函式的位置應用裝飾器,從而使得程式碼更容易閱讀,並且讓人立刻意識到使用了裝飾器

registry = []
def register(decorated):
    registry.append(decorated)
    return decorated

@register
def foo(x=3):
    return x

@register
def bar(x=5):
    return 5

for func in registry:
    print(func())

3
5
複製程式碼

再看一個更復雜、更一般化的裝飾器函式。裝飾器的本質是在執行原有函式(被裝飾的函式)的同時,再加上一些額外的功能。

def requires_ints(decorated):
    def inner(*args, **kwargs):
        kwarg_values = [i for i in kwargs.values()]
        for arg in list(args) + kwarg_values:
            if not isinstance(arg, int):
                raise TypeError('{} only accepts integers as arguments'.format(decorated.__name__))
        return decorated(*args, **kwargs)
    return inner
複製程式碼

在這個裝飾器函式requires_ints我們可以看到,他定義了一個內嵌函式inner,這個內嵌函式的引數首先收集被裝飾函式的所有引數,然後對其進行判斷,判斷其是否為整數型別(這就是裝飾器新增的額外功能),然後再呼叫被裝飾的函式本身,最後將這個內嵌函式返回。因此當我們再用原函式名進行呼叫的時候,原來的被裝飾函式的引用就能指向這個新的內嵌函式,就能在實現原函式功能的基礎上,加上附加的功能了。

同時,我們再提煉一下這裡面的幾個重難點:

第一,requires_ints中,decorated這個變數是內嵌作用域的變數,在他呼叫退出後,返回的inner函式是可以記住這個變數的。

第二,python不支援函式的引數列表的多型,即一個函式名只能對應唯一的引數列表形式。

第三,在內嵌函式內部呼叫被裝飾函式的時候,使用瞭解包引數,關於這*args, **kwargs,的引數形式,前面章節中細講過。

【妹子說】那我們也用這個裝飾器來裝飾一個函式。

@requires_ints
def foo(x,y):
    print(x+y)

foo(3,5)

8
複製程式碼

這裡將名稱foo賦給inner函式,而不是賦給原來被定義的函式,如果執行foo(3,5),將利用傳入的這兩個引數執行inner函式,inner函式執行型別檢查,然後執行被裝飾方法,如果傳入的不是整形數,例如下面這個例子,那麼裝飾器的附加功能就會進行型別檢查:

@requires_ints
def foo(x,y):
    print(x+y)

foo('a',5)

Traceback (most recent call last):
  File "E:/12homework/12homework.py", line 15in <module>
    foo('a',5)
  File "E:/12homework/12homework.py", line 7in inner
raise TypeError('{} only accepts integers as arguments'.format(decorated.__name__))
TypeError: foo only accepts integers as arguments
複製程式碼

其次內嵌的函式和被裝飾的函式的引數形式必須完全一樣,這裡用的*args, **kwargs概況函式引數的一般形式,因此也是完全對應的。

最後說說裝飾器引數

最後來介紹這個複雜一些的話題,裝飾器引數。之前我們列舉的常規例子裡,裝飾器只有一個引數,就是被裝飾的方法。但是,有時讓裝飾器自身帶有一些需要的資訊,從而使裝飾器可以用恰當的方式裝飾方法十分有用。

這些引數並不是和被裝飾的函式並列作為引數簽名,而是在原有裝飾器的基礎上額外再增加一層封裝,那麼,實質是這個接受其他引數的裝飾器並不是一個實際的裝飾器,而是一個返回裝飾器的函式。

最終返回的內嵌函式inner是最終使用indent和sort_keys引數的函式,這沒有問題

import json

def json_output(indent=None, sort_keys=False):
    def actual_decorator(decorated):
        def inner(*args, **kwargs):
            result = decorated(*args, **kwargs)
            return json.dumps(result, indent=indent, sort_keys=sort_keys)
        return inner
    return actual_decorator

@json_output(indent=8)
def do_nothing():
    return {'status':'done','func':'yes'}

print(do_nothing())

{
        "status""done",
        "func""yes"
}
複製程式碼

我們在這裡詳細解釋說明的是操作順序,看上去我們使用的是@json_output(indent=8),作這和之前的裝飾器語法糖看上去有些不同,實際上這個不是最終的裝飾器函式,通過呼叫json_output(indent=8),返回函式指標actual_decorator,這個函式才是真正放在@後的裝飾器函式,原始的被裝飾函式最終獲得了內涵更豐富的inner函式物件,完成了裝飾過程,值得一提的是,所謂的裝飾器引數最終傳給了最內層的inner函式。

記住,在定義裝飾器函式後,真正的裝飾器函式只有一個引數,那就是被裝飾的函式指標,而有其他引數的函式實質上只是裝飾器的外圍函式,他可以依據引數對裝飾器進行進一步的定製。一句話:一個函式不可能接受被裝飾的方法,又接受其他引數

在語法糖中@func這種不帶括號的,就是直接使用裝飾器函式進行裝飾,如果是@func()帶括號的,實質上是先呼叫func()函式返回真正的裝飾器,然後再用@進行呼叫。

【妹子說】這個裝飾器的功能可真的是在python裡才見到,真得好好學學呀!

公眾號二維碼:python資料科學家:

給妹子講python-S01E22詳解神奇的裝飾器

相關文章