怎樣python中使用裝飾器

這篇文章給大家介紹怎樣python中使用裝飾器，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。

01. 裝飾器語法糖

如果你接觸 Python 有一段時間了的話，想必你對 @ 符號一定不陌生了，沒錯 @ 符號就是裝飾器的語法糖。
它放在一個函數開始定義的地方，它就像一頂帽子一樣戴在這個函數的頭上。和這個函數綁定在一起。在我們調用這個函數的時候，第一件事并不是執行這個函數，而是將這個函數做為參數傳入它頭頂上這頂帽子，這頂帽子我們稱之為裝飾函數 或 裝飾器。

你要問我裝飾器可以實現什么功能？我只能說你的腦洞有多大，裝飾器就有多強大。

裝飾器的使用方法很固定：

• 先定義一個裝飾函數（帽子）（也可以用類、偏函數實現）

• 再定義你的業務函數、或者類（人）

• 最后把這頂帽子帶在這個人頭上

裝飾器的簡單的用法有很多，這里舉兩個常見的。

• 日志打印器

• 時間計時器

02. 入門用法：日志打印器

首先是日志打印器。

它要實現的功能是

• 在函數執行前，先打印一行日志告知一下主人，我要執行函數了。

• 在函數執行完，也不能拍拍屁股就走人了，咱可是有禮貌的代碼，再打印一行日志告知下主人，我執行完啦。

# 這是裝飾函數
def logger(func):
  def wrapper(*args, **kw):
    print('我準備開始計算：{} 函數了:'.format(func.__name__))

    # 真正執行的是這行。
    func(*args, **kw)

    print('啊哈，我計算完啦。給自己加個雞腿！！')
  return wrapper

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

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

然后我們來計算一下。

add(200, 50)

快來看看輸出了什么，神奇不？

我準備開始計算：add 函數了:
200 + 50 = 250
啊哈，我計算完啦。給自己加個雞腿！

03. 入門用法：時間計時器

再來看看 時間計時器

實現功能：顧名思義，就是計算一個函數的執行時長。

# 這是裝飾函數
def timer(func):
  def wrapper(*args, **kw):
    t1=time.time()
    # 這是函數真正執行的地方
    func(*args, **kw)
    t2=time.time()

    # 計算下時長
    cost_time = t2-t1 
    print("花費時間：{}秒".format(cost_time))
  return wrapper

假如，我們的函數是要睡眠10秒。這樣也能更好的看出這個計算時長到底靠不靠譜。

import time

@timer
def want_sleep(sleep_time):
  time.sleep(sleep_time)

want_sleep(10)

來看看，輸出。真的是10秒。

花費時間：10.0073800086975098秒

04. 進階用法：帶參數的函數裝飾器

通過上面簡單的入門，你大概已經感受到了裝飾的神奇魅力了。

不過，裝飾器的用法遠不止如此。我們今天就要把這個知識點學透。

上面的例子，裝飾器是不能接收參數的。其用法，只能適用于一些簡單的場景。不傳參的裝飾器，只能對被裝飾函數，執行固定邏輯。

如果你有經驗，你一定經常在項目中，看到有的裝飾器是帶有參數的。

裝飾器本身是一個函數，既然做為一個函數都不能攜帶函數，那這個函數的功能就很受限。只能執行固定的邏輯。這無疑是非常不合理的。而如果我們要用到兩個內容大體一致，只是某些地方不同的邏輯。不傳參的話，我們就要寫兩個裝飾器。小明覺得這不能忍。

那么裝飾器如何實現傳參呢，會比較復雜，需要兩層嵌套。

同樣，我們也來舉個例子。

我們要在這兩個函數的執行的時候，分別根據其國籍，來說出一段打招呼的話。

def american():
  print("I am from America.")

def chinese():
  print("我來自中國。")

在給他們倆戴上裝飾器的時候，就要跟裝飾器說，這個人是哪國人，然后裝飾器就會做出判斷，打出對應的招呼。
戴上帽子后，是這樣的。

@say_hello("china")
def chinese():
  print("我來自中國。")

@say_hello("america")
def american():
  print("I am from America.")

萬事俱備，只差帽子了。來定義一下，這里需要兩層嵌套。

def say_hello(contry):
  def wrapper(func):
    def deco(*args, **kwargs):
      if contry == "china":
        print("你好!")
      elif contry == "america":
        print('hello.')
      else:
        return

      # 真正執行函數的地方
      func(*args, **kwargs)
    return deco
  return wrapper

執行一下

american()
print("------------")
chinese()

看看輸出結果。

你好!
我來自中國。
------------
hello.
I am from America

emmmm，這很NB。。。

05. 高階用法：不帶參數的類裝飾器

以上都是基于函數實現的裝飾器，在閱讀別人代碼時，還可以時常發現還有基于類實現的裝飾器。

基于類裝飾器的實現，必須實現 __call__ 和 __init__兩個內置函數。

• __init__ ：接收被裝飾函數

• __call__ ：實現裝飾邏輯。

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

執行一下，看看輸出

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

06. 高階用法：帶參數的類裝飾器

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

帶參數和不帶參數的類裝飾器有很大的不同。

• __init__ ：不再接收被裝飾函數，而是接收傳入參數。

• __call__ ：接收被裝飾函數，實現裝飾邏輯。

class logger(object):
  def __init__(self, level='INFO'):
    self.level = level

  def __call__(self, func): # 接受函數
    def wrapper(*args, **kwargs):
      print("[{level}]: the function {func}() is running..."\
        .format(level=self.level, func=func.__name__))
      func(*args, **kwargs)
    return wrapper #返回函數

@logger(level='WARNING')
def say(something):
  print("say {}!".format(something))

say("hello")

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

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

07. 使用偏函數與類實現裝飾器

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

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

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

除函數之外，類也可以是 callable 對象，只要實現了__call__ 函數（上面幾個盒子已經接觸過了），還有比較少人使用的偏函數也是 callable 對象。

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

如下所示，DelayFunc 是一個實現了 __call__ 的類，delay 返回一個偏函數，在這里 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):
  """
  裝飾器：推遲某個函數的執行。
  同時提供 .eager_call 方法立即執行
  """
  # 此處為了避免定義額外函數，
 # 直接使用 functools.partial 幫助構造 DelayFunc 實例
  return functools.partial(DelayFunc, duration)

我們的業務函數很簡單，就是相加

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

來看一下執行過程

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

08. 如何寫能裝飾類的裝飾器？

用 Python 寫單例模式的時候，常用的有三種寫法。其中一種，是用裝飾器來實現的。
以下便是我自己寫的裝飾器版的單例寫法。

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 這個裝飾函數來裝飾 User 這個類。裝飾器用在類上，并不是很常見，但只要熟悉裝飾器的實現過程，就不難以實現對類的裝飾。在上面這個例子中，裝飾器就只是實現對類實例的生成的控制而已。
其實例化的過程，你可以參考我這里的調試過程，加以理解。

09. wraps 裝飾器有啥用？

在 functools 標準庫中有提供一個 wraps 裝飾器，你應該也經常見過，那他有啥用呢？

先來看一個例子

def wrapper(func):
  def inner_function():
    pass
  return inner_function

@wrapper
def wrapped():
  pass

print(wrapped.__name__)
#inner_function

為什么會這樣子？不是應該返回 func 嗎？

這也不難理解，因為上邊執行func 和下邊 decorator(func)  是等價的，所以上面 func.__name__ 是等價于下面decorator(func).__name__ 的，那當然名字是 inner_function

def wrapper(func):
  def inner_function():
    pass
  return inner_function

def wrapped():
  pass

print(wrapper(wrapped).__name__)
#inner_function

那如何避免這種情況的產生？方法是使用 functools .wraps 裝飾器，它的作用就是將 被修飾的函數(wrapped) 的一些屬性值賦值給 修飾器函數(wrapper) ，最終讓屬性的顯示更符合我們的直覺。

from functools import wraps

def wrapper(func):
  @wraps(func)
  def inner_function():
    pass
  return inner_function

@wrapper
def wrapped():
  pass

print(wrapped.__name__)
# wrapped

準確點說，wraps 其實是一個偏函數對象（partial），源碼如下

def wraps(wrapped,
     assigned = WRAPPER_ASSIGNMENTS,
     updated = WRAPPER_UPDATES):
  return partial(update_wrapper, wrapped=wrapped,
          assigned=assigned, updated=updated)

可以看到wraps其實就是調用了一個函數update_wrapper，知道原理后，我們改寫上面的代碼，在不使用 wraps的情況下，也可以讓 wrapped.__name__ 打印出 wrapped，代碼如下：

from functools import update_wrapper

WRAPPER_ASSIGNMENTS = ('__module__', '__name__', '__qualname__', '__doc__',
            '__annotations__')

def wrapper(func):
  def inner_function():
    pass

  update_wrapper(inner_function, func, assigned=WRAPPER_ASSIGNMENTS)
  return inner_function

@wrapper
def wrapped():
  pass

print(wrapped.__name__)

10. 內置裝飾器：property

以上，我們介紹的都是自定義的裝飾器。

其實Python語言本身也有一些裝飾器。比如property這個內建裝飾器，我們再熟悉不過了。

它通常存在于類中，可以將一個函數定義成一個屬性，屬性的值就是該函數return的內容。

通常我們給實例綁定屬性是這樣的

class Student(object):
  def __init__(self, name, age=None):
    self.name = name
    self.age = age

# 實例化
XiaoMing = Student("小明")

# 添加屬性
XiaoMing.age=25

# 查詢屬性
XiaoMing.age

# 刪除屬性
del XiaoMing.age

但是稍有經驗的開發人員，一下就可以看出，這樣直接把屬性暴露出去，雖然寫起來很簡單，但是并不能對屬性的值做合法性限制。為了實現這個功能，我們可以這樣寫。

class Student(object):
  def __init__(self, name):
    self.name = name
    self.name = None

  def set_age(self, age):
    if not isinstance(age, int):
      raise ValueError('輸入不合法：年齡必須為數值!')
    if not 0 < age < 100:
      raise ValueError('輸入不合法：年齡范圍必須0-100')
    self._age=age

  def get_age(self):
    return self._age

  def del_age(self):
    self._age = None


XiaoMing = Student("小明")

# 添加屬性
XiaoMing.set_age(25)

# 查詢屬性
XiaoMing.get_age()

# 刪除屬性
XiaoMing.del_age()

上面的代碼設計雖然可以變量的定義，但是可以發現不管是獲取還是賦值（通過函數）都和我們平時見到的不一樣。
按照我們思維習慣應該是這樣的。

# 賦值
XiaoMing.age = 25

# 獲取
XiaoMing.age

那么這樣的方式我們如何實現呢。請看下面的代碼。

class Student(object):
  def __init__(self, name):
    self.name = name
    self.name = None

  @property
  def age(self):
    return self._age

  @age.setter
  def age(self, value):
    if not isinstance(value, int):
      raise ValueError('輸入不合法：年齡必須為數值!')
    if not 0 < value < 100:
      raise ValueError('輸入不合法：年齡范圍必須0-100')
    self._age=value

  @age.deleter
  def age(self):
    del self._age

XiaoMing = Student("小明")

# 設置屬性
XiaoMing.age = 25

# 查詢屬性
XiaoMing.age

# 刪除屬性
del XiaoMing.age

用@property裝飾過的函數，會將一個函數定義成一個屬性，屬性的值就是該函數return的內容。同時，會將這個函數變成另外一個裝飾器。就像后面我們使用的@age.setter和@age.deleter。

@age.setter 使得我們可以使用XiaoMing.age = 25這樣的方式直接賦值。

@age.deleter 使得我們可以使用del XiaoMing.age這樣的方式來刪除屬性。

property 的底層實現機制是「描述符」，為此我還寫過一篇文章。

這里也介紹一下吧，正好將這些看似零散的文章全部串起來。

如下，我寫了一個類，里面使用了 property 將 math 變成了類實例的屬性

class Student:
  def __init__(self, name):
    self.name = name

  @property
  def math(self):
    return self._math

  @math.setter
  def math(self, value):
    if 0 <= value <= 100:
      self._math = value
    else:
      raise ValueError("Valid value must be in [0, 100]")

為什么說 property 底層是基于描述符協議的呢？通過 PyCharm 點擊進入 property 的源碼，很可惜，只是一份類似文檔一樣的偽源碼，并沒有其具體的實現邏輯。

不過，從這份偽源碼的魔法函數結構組成，可以大體知道其實現邏輯。

這里我自己通過模仿其函數結構，結合「描述符協議」來自己實現類 property 特性。

代碼如下：

class TestProperty(object):

  def __init__(self, fget=None, fset=None, fdel=None, doc=None):
    self.fget = fget
    self.fset = fset
    self.fdel = fdel
    self.__doc__ = doc

  def __get__(self, obj, objtype=None):
    print("in __get__")
    if obj is None:
      return self
    if self.fget is None:
      raise AttributeError
    return self.fget(obj)

  def __set__(self, obj, value):
    print("in __set__")
    if self.fset is None:
      raise AttributeError
    self.fset(obj, value)

  def __delete__(self, obj):
    print("in __delete__")
    if self.fdel is None:
      raise AttributeError
    self.fdel(obj)


  def getter(self, fget):
    print("in getter")
    return type(self)(fget, self.fset, self.fdel, self.__doc__)

  def setter(self, fset):
    print("in setter")
    return type(self)(self.fget, fset, self.fdel, self.__doc__)

  def deleter(self, fdel):
    print("in deleter")
    return type(self)(self.fget, self.fset, fdel, self.__doc__)

然后 Student 類，我們也相應改成如下

class Student:
  def __init__(self, name):
    self.name = name

  # 其實只有這里改變
  @TestProperty
  def math(self):
    return self._math

  @math.setter
  def math(self, value):
    if 0 <= value <= 100:
      self._math = value
    else:
      raise ValueError("Valid value must be in [0, 100]")

為了盡量讓你少產生一點疑惑，我這里做兩點說明：

• 使用TestProperty裝飾后，math 不再是一個函數，而是TestProperty 類的一個實例。所以第二個math函數可以使用 math.setter 來裝飾，本質是調用TestProperty.setter 來產生一個新的 TestProperty 實例賦值給第二個math。

• 第一個 math 和第二個 math 是兩個不同 TestProperty 實例。但他們都屬于同一個描述符類（TestProperty），當對 math 對于賦值時，就會進入 TestProperty.__set__，當對math 進行取值里，就會進入 TestProperty.__get__。仔細一看，其實最終訪問的還是Student實例的 _math 屬性。

說了這么多，還是運行一下，更加直觀一點。

# 運行后，會直接打印這一行，這是在實例化 TestProperty 并賦值給第二個math
in setter
>>>
>>> s1.math = 90
in __set__
>>> s1.math
in __get__
90

如對上面代碼的運行原理

，有疑問的同學，請務必結合上面兩點說明加以理解，那兩點相當關鍵。

11. 其他裝飾器：裝飾器實戰

讀完并理解了上面的內容，你可以說是Python高手了。別懷疑，自信點，因為很多人都不知道裝飾器有這么多用法呢。

在小明看來，使用裝飾器，可以達到如下目的：

• 使代碼可讀性更高，逼格更高；

• 代碼結構更加清晰，代碼冗余度更低；

剛好小明在最近也有一個場景，可以用裝飾器很好的實現，暫且放上來看看。

這是一個實現控制函數運行超時的裝飾器。如果超時，則會拋出超時異常。

有興趣的可以看看。

import signal

class TimeoutException(Exception):
  def __init__(self, error='Timeout waiting for response from Cloud'):
    Exception.__init__(self, error)


def timeout_limit(timeout_time):
  def wraps(func):
    def handler(signum, frame):
      raise TimeoutException()

    def deco(*args, **kwargs):
      signal.signal(signal.SIGALRM, handler)
      signal.alarm(timeout_time)
      func(*args, **kwargs)
      signal.alarm(0)
    return deco
  return wraps

關于怎樣python中使用裝飾器就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。