給妹子講python--22神奇的裝飾器

陪伴學習,一路成長。請一起關注,一起點贊吧!

【要點搶先看】

1.神奇的裝飾器到底是什麼n2.裝飾器的用法和語法糖n3.裝飾器如何添加參數n

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

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

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

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

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

registry = []ndef register(decorated):n registry.append(decorated)n return decoratednndef foo():n return 3nnfoo = register(foo)nprint(registry[0])nn<function foo at 0x00000000025D51E0>n

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

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

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

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

registry = []ndef register(decorated):n registry.append(decorated)n return decoratednn@registerndef foo(x=3):n return xnn@registerndef bar(x=5):n return 5nnfor func in registry:n print(func())nn3n5n

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

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

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

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

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

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

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

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

@requires_intsndef foo(x,y):n print(x+y)nnfoo(3,5)nn8n

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

@requires_intsndef foo(x,y):n print(x+y)nnfoo(a,5)nnTraceback (most recent call last):n File "E:/12homework/12homework.py", line 15, in <module>n foo(a,5)n File "E:/12homework/12homework.py", line 7, in innernraise TypeError({} only accepts integers as arguments.format(decorated.__name__))nTypeError: foo only accepts integers as argumentsn

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

最後說說裝飾器參數

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

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

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

import jsonnndef json_output(indent=None, sort_keys=False):n def actual_decorator(decorated):n def inner(*args, **kwargs):n result = decorated(*args, **kwargs)n return json.dumps(result, indent=indent, sort_keys=sort_keys)n return innern return actual_decoratornn@json_output(indent=8)ndef do_nothing():n return {status:done,func:yes}nnprint(do_nothing())nn{n "status": "done",n "func": "yes"n}n

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

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

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

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

@李輝 @LittleCoder @tonnie @yea yee @路人甲

請各位大神們多多指教哈,知識的淬鍊、語言的表達都需要向大家不斷的學習~


推薦閱讀:

怎麼用ε-δ語言來描述,當x→x0時,f(x)的極限≠A ?
R語言常用函數匯總
函數的內積為什麼要這麼定義?
我的GB2312轉化為UTF-8的代碼linux iconv函數為什麼一直返回-1?
程序的函數副本是個什麼概念?

TAG:装饰器 | Python | 函数 |