Python裝飾器的寫法是什么

這篇文章主要講解了“Python裝飾器的寫法是什么”，文中的講解內(nèi)容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“Python裝飾器的寫法是什么”吧！

Hello，裝飾器

裝飾器本質(zhì)上是一個Python函數(shù)，它可以讓其他函數(shù)在不需要做任何代碼變動的前提下增加額外功能，裝飾器的返回值也是一個函數(shù)對象。

它經(jīng)常用于有切面需求的場景，比如：插入日志、性能測試、事務處理、緩存、權限校驗等場景。

裝飾器是解決這類問題的絕佳設計，有了裝飾器，我們就可以抽離出大量與函數(shù)功能本身無關的雷同代碼并繼續(xù)重用。

裝飾器的使用方法很固定

• 先定義一個裝飾器(帽子)

• 再定義你的業(yè)務函數(shù)或者類(人)

• 最后把這裝飾器(帽子)扣在這個函數(shù)(人)頭上

就像下面這樣子

# 定義裝飾器 def decorator(func):     def wrapper(*args, **kw):         return func()     return wrapper  # 定義業(yè)務函數(shù)并進行裝飾 @decorator def function():     print("hello, decorator")

實際上，裝飾器并不是編碼必須性，意思就是說，你不使用裝飾器完全可以，它的出現(xiàn)，應該是使我們的代碼

更加優(yōu)雅，代碼結構更加清晰

將實現(xiàn)特定的功能代碼封裝成裝飾器，提高代碼復用率，增強代碼可讀性

接下來，我將以實例講解，如何編寫出各種簡單及復雜的裝飾器。

第一種：普通裝飾器

首先咱來寫一個最普通的裝飾器，它實現(xiàn)的功能是：

• 在函數(shù)執(zhí)行前，先記錄一行日志

• 在函數(shù)執(zhí)行完，再記錄一行日志

# 這是裝飾器函數(shù)，參數(shù) func 是被裝飾的函數(shù) def logger(func):     def wrapper(*args, **kw):         print('我準備開始執(zhí)行：{} 函數(shù)了:'.format(func.__name__))          # 真正執(zhí)行的是這行。         func(*args, **kw)          print('主人，我執(zhí)行完啦。')     return wrapper

假如，我的業(yè)務函數(shù)是，計算兩個數(shù)之和。寫好后，直接給它帶上帽子。

@logger def add(x, y):     print('{} + {} = {}'.format(x, y, x+y))

然后執(zhí)行一下 add 函數(shù)。

add(200, 50)

來看看輸出了什么?

我準備開始執(zhí)行：add 函數(shù)了: 200 + 50 = 250 我執(zhí)行完啦。

第二種：帶參數(shù)的函數(shù)裝飾器

通過上面兩個簡單的入門示例，你應該能體會到裝飾器的工作原理了。

不過，裝飾器的用法還遠不止如此，深究下去，還大有文章。今天就一起來把這個知識點學透。

回過頭去看看上面的例子，裝飾器是不能接收參數(shù)的。其用法，只能適用于一些簡單的場景。不傳參的裝飾器，只能對被裝飾函數(shù)，執(zhí)行固定邏輯。

裝飾器本身是一個函數(shù)，做為一個函數(shù)，如果不能傳參，那這個函數(shù)的功能就會很受限，只能執(zhí)行固定的邏輯。這意味著，如果裝飾器的邏輯代碼的執(zhí)行需要根據(jù)不同場景進行調(diào)整，若不能傳參的話，我們就要寫兩個裝飾器，這顯然是不合理的。

比如我們要實現(xiàn)一個可以定時發(fā)送郵件的任務(一分鐘發(fā)送一封)，定時進行時間同步的任務(一天同步一次)，就可以自己實現(xiàn)一個 periodic_task  (定時任務)的裝飾器，這個裝飾器可以接收一個時間間隔的參數(shù)，間隔多長時間執(zhí)行一次任務。

可以這樣像下面這樣寫，由于這個功能代碼比較復雜，不利于學習，這里就不貼了。

@periodic_task(spacing=60) def send_mail():      pass  @periodic_task(spacing=86400) def ntp()     pass

那我們來自己創(chuàng)造一個偽場景，可以在裝飾器里傳入一個參數(shù)，指明國籍，并在函數(shù)執(zhí)行前，用自己國家的母語打一個招呼。

# 小明，中國人 @say_hello("china") def xiaoming():     pass  # jack，美國人 @say_hello("america") def jack():     pass

那我們?nèi)绻麑崿F(xiàn)這個裝飾器，讓其可以實現(xiàn) 傳參 呢?

會比較復雜，需要兩層嵌套。

def say_hello(contry):     def wrapper(func):         def deco(*args, **kwargs):             if contry == "china":                 print("你好!")             elif contry == "america":                 print('hello.')             else:                 return              # 真正執(zhí)行函數(shù)的地方             func(*args, **kwargs)         return deco     return wrapper

來執(zhí)行一下

xiaoming() print("------------") jack()

看看輸出結果。

你好! ------------ hello.

第三種：不帶參數(shù)的類裝飾器

以上都是基于函數(shù)實現(xiàn)的裝飾器，在閱讀別人代碼時，還可以時常發(fā)現(xiàn)還有基于類實現(xiàn)的裝飾器。

基于類裝飾器的實現(xiàn)，必須實現(xiàn) __call__ 和 __init__兩個內(nèi)置函數(shù)。

__init__ ：接收被裝飾函數(shù)

__call__ ：實現(xiàn)裝飾邏輯。

還是以日志打印這個簡單的例子為例

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")

執(zhí)行一下，看看輸出

[INFO]: the function say() is running... say hello!

第四種：帶參數(shù)的類裝飾器

上面不帶參數(shù)的例子，你發(fā)現(xiàn)沒有，只能打印INFO級別的日志，正常情況下，我們還需要打印DEBUG  WARNING等級別的日志。這就需要給類裝飾器傳入?yún)?shù)，給這個函數(shù)指定級別了。

帶參數(shù)和不帶參數(shù)的類裝飾器有很大的不同。

__init__ ：不再接收被裝飾函數(shù)，而是接收傳入?yún)?shù)。

__call__ ：接收被裝飾函數(shù)，實現(xiàn)裝飾邏輯。

class logger(object):     def __init__(self, level='INFO'):         self.level = level      def __call__(self, func): # 接受函數(shù)         def wrapper(*args, **kwargs):             print("[{level}]: the function {func}() is running..."\                 .format(level=self.level, func=func.__name__))             func(*args, **kwargs)         return wrapper  #返回函數(shù)  @logger(level='WARNING') def say(something):     print("say {}!".format(something))  say("hello")

我們指定WARNING級別，運行一下，來看看輸出。

[WARNING]: the function say() is running... say hello!

第五種：使用偏函數(shù)與類實現(xiàn)裝飾器

絕大多數(shù)裝飾器都是基于函數(shù)和閉包實現(xiàn)的，但這并非制造裝飾器的唯一方式。

事實上，Python 對某個對象是否能通過裝飾器( @decorator)形式使用只有一個要求：decorator  必須是一個“可被調(diào)用(callable)的對象。

對于這個 callable 對象，我們最熟悉的就是函數(shù)了。

除函數(shù)之外，類也可以是 callable 對象，只要實現(xiàn)了__call__ 函數(shù)(上面幾個例子已經(jīng)接觸過了)。

還有容易被人忽略的偏函數(shù)其實也是 callable 對象。

接下來就來說說，如何使用 類和偏函數(shù)結合實現(xiàn)一個與眾不同的裝飾器。

如下所示，DelayFunc 是一個實現(xiàn)了 __call__ 的類，delay 返回一個偏函數(shù)，在這里 delay 就可以做為一個裝飾器。(以下代碼摘自  Python工匠：使用裝飾器的小技巧)

import time import functools  class DelayFunc:     def __init__(self,  duration, func):         self.duration = duration         self.func = func      def __call__(self, *args, **kwargs):         print(f'Wait for {self.duration} seconds...')         time.sleep(self.duration)         return self.func(*args, **kwargs)      def eager_call(self, *args, **kwargs):         print('Call without delay')         return self.func(*args, **kwargs)  def delay(duration):     """     裝飾器：推遲某個函數(shù)的執(zhí)行。     同時提供 .eager_call 方法立即執(zhí)行     """     # 此處為了避免定義額外函數(shù)，     # 直接使用 functools.partial 幫助構造 DelayFunc 實例     return functools.partial(DelayFunc, duration)

我們的業(yè)務函數(shù)很簡單，就是相加

@delay(duration=2) def add(a, b):     return a+b

來看一下執(zhí)行過程

>>> add    # 可見 add 變成了 Delay 的實例 <__main__.DelayFunc object at 0x107bd0be0> >>>  >>> add(3,5)  # 直接調(diào)用實例，進入 __call__ Wait for 2 seconds... 8 >>>  >>> add.func # 實現(xiàn)實例方法 <function add at 0x107bef1e0>

第六種：能裝飾類的裝飾器

用 Python 寫單例模式的時候，常用的有三種寫法。其中一種，是用裝飾器來實現(xiàn)的。

以下便是我自己寫的裝飾器版的單例寫法。

instances = {}  def singleton(cls):     def get_instance(*args, **kw):         cls_name = cls.__name__         print('===== 1 ====')         if not cls_name in instances:             print('===== 2 ====')             instance = cls(*args, **kw)             instances[cls_name] = instance         return instances[cls_name]     return get_instance  @singleton class User:     _instance = None      def __init__(self, name):         print('===== 3 ====')         self.name = name

可以看到我們用singleton 這個裝飾函數(shù)來裝飾 User  這個類。裝飾器用在類上，并不是很常見，但只要熟悉裝飾器的實現(xiàn)過程，就不難以實現(xiàn)對類的裝飾。在上面這個例子中，裝飾器就只是實現(xiàn)對類實例的生成的控制而已。

其實例化的過程，你可以參考我這里的調(diào)試過程，加以理解。

感謝各位的閱讀，以上就是“Python裝飾器的寫法是什么”的內(nèi)容了，經(jīng)過本文的學習后，相信大家對Python裝飾器的寫法是什么這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！