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

歡迎關注公衆號：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 15, in <module>
    foo('a',5)
  File "E:/12homework/12homework.py", line 7, in 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數據科學家：