一篇學會Python函數裝飾器基礎知識
本文轉載自微信公眾號「dongfanger」,作者dongfanger。轉載本文請聯系dongfanger公眾號。
函數裝飾器是Python語言最優(yōu)秀的設計之一,它以非常簡潔的方式增強了函數的行為,讓崎嶇不平之路變得平坦順暢。
函數裝飾器是什么
函數裝飾器是一個可調用對象,它的參數是另外一個函數。比如:
- @decorate
- def target():
- print("running target()")
跟下面代碼效果是一樣的:
- def target():
- print("running target()")
- target = decorate(target)
簡單實現@decorate:
- def decorate(func):
- def inner():
- print("running inner()")
- return inner
測試一下:
- >>> target()
- running inner()
- >>> target
- <function decorate.<locals>.inner at 0x04899D18>
新的target是decorate(target)返回的inner函數。
因為裝飾器只是代碼優(yōu)化的一種手段,不像if語句for語句那樣,決定了程序流程,所以嚴格來說,裝飾器只是語法糖。它有兩個特性,一是能把被裝飾的函數替換成其他函數,二是裝飾器在加載模塊時立即執(zhí)行。
裝飾器在導入時執(zhí)行
若想真正理解裝飾器,需要區(qū)分導入時和運行時。函數裝飾器在導入模塊時立即執(zhí)行,而被裝飾的函數只在明確調用時運行。
接下來通過示例對這個特性進行說明,新建registration.py模塊:
- registry = []
- def register(func):
- # 裝飾器函數也可以不定義內部函數
- print("running register(%s)" % func)
- registry.append(func)
- return func
- @register
- def f1():
- print("running f1()")
- @register
- def f2():
- print("running f2()")
- def f3():
- print("running f3()")
- def main():
- print("running main()")
- print("registry ->", registry)
- f1()
- f2()
- f3()
- if __name__ == "__main__":
- main()
從結果能看出來:
- @register作用到f1和f2上,在導入時,在main()調用前就執(zhí)行了。
- f3沒有裝飾器,就沒有在main()調用前執(zhí)行@register。
- 在main()調用后,明確調用f1()、f2()、f3()才執(zhí)行函數。
import模塊能看得更明顯:
- >>> import registration
- running register(<function f1 at 0x0189A730>)
- running register(<function f2 at 0x0189A6E8>)
裝飾器在導入時就執(zhí)行了。
使用裝飾器改進策略模式
在《Python設計模式知多少》文章中提到了裝飾器可以更優(yōu)雅的實現策略模式的最佳策略,它的實現代碼如下:
- promos = []
- def promotion(promo_func):
- promos.append(promo_func)
- return promo_func
- @promotion
- def fidelity(order):
- """5% discount for customers with 1000 or more fidelity points"""
- return order.total() * .05 if order.customer.fidelity >= 1000 else 0
- @promotion
- def bulk_item(order):
- """10% discount for each LineItem with 20 or more units"""
- discount = 0
- for item in order.cart:
- if item.quantity >= 20:
- discount += item.total() * .1
- return discount
- @promotion
- def large_order(order):
- """7% discount for orders with 10 or more distinct items"""
- distinct_items = {item.product for item in order.cart}
- if len(distinct_items) >= 10:
- return order.total() * .07
- return 0
- def best_promo(order):
- """Select best discount available
- """
- return max(promo(order) for promo in promos)
它解決了"如果想要添加新的促銷策略,那么要定義相應函數并添加到promos列表中"這個缺陷,并有更多優(yōu)點:
- 新的促銷策略,用@promotion裝飾器即可添加。
- 促銷策略函數不用以_promo結尾,可以任意命令。
- 促銷策略可以在任意模塊定義,只需要使用@promotion裝飾器即可。
小結
本文首先介紹了函數裝飾器是一個可調用對象,它的參數是另外一個函數。嚴格來說,它只是語法糖。要理解裝飾器,需要區(qū)別導入時和運行時,裝飾器在導入時就會執(zhí)行。最后使用裝飾器對策略模式的最佳策略進行了優(yōu)化。為了進一步學習函數裝飾器,得先明白另外一個很重要的概念:閉包。
參考資料:
《流暢的Python》