如何實現(xiàn)一個python函數(shù)裝飾器(Decorator)

更新時間：2020年10月12日 09:13:14 作者：半杯茶的小酒杯

這篇文章主要介紹了如何實現(xiàn)一個python函數(shù)裝飾器(Decorator),幫助大家更好的理解和學習python，感興趣的朋友可以了解下

裝飾器本質上是一個 Python 函數(shù)或類，它可以讓其他函數(shù)或類在不需要做任何代碼修改的前提下增加額外功能，裝飾器的返回值也是一個函數(shù)/類對象。它經(jīng)常用于為已有函數(shù)/類添加記錄日志、計時統(tǒng)計、性能測試等。

首先定義一個倒計時函數(shù)，這個函數(shù)的功能非常簡單，就是把n從當前值減少到0。

def countdown(n):
 while n > 0:
  print('time' + str(n))
  n -= 1

print(countdown.__name__)

程序輸出:

countdown

1.為函數(shù)增加一個日志裝飾器

假設現(xiàn)在要增強countdown的功能，在函數(shù)調用前后自動打印日志，又不想修改函數(shù)自身的功能。這種在代碼運行期間動態(tài)增加功能的方式，稱之為裝飾器(Decorator)。

能打印日志的decorator，可以定義如下：

def log(func):
  def wrapper(*args, **kw):
    print('call %s().' % func.__name__)
    return func(*args, **kw)
  return wrapper

然后我們借助Python的@語法，把decorator置于函數(shù)的定義處：

@log
def countdown(n):
 while n > 0:
  print('time:' + str(n))
  n -= 1

countdown(10)

程序輸出：

call countdown().
time:10
time:9
time:8
time:7
time:6
time:5
time:4
time:3
time:2
time:1

但此時我們再打印函數(shù)的name:

print(countdown.__name__)

程序輸出:

wrapper

我們發(fā)現(xiàn)函數(shù)的元數(shù)據(jù)信息變了，這顯然不是我們想要的結果。

2. 在裝飾器中拷貝元數(shù)據(jù)

為了把函數(shù)的元數(shù)據(jù)信息都保留下來，我們可以直接使用Python提供的functools庫中的@wraps裝飾器。

from functools import wraps

def log(func):
  @wraps(func)
  def wrapper(*args, **kw):
    print('call %s().' % func.__name__)
    return func(*args, **kw)
  return wrapper

@log
def countdown(n):
 while n > 0:
  print('time:' + str(n))
  n -= 1

print(countdown.__name__)

程序輸出：

countdown

3.為函數(shù)增加一個計時裝飾器

添加函數(shù)裝飾器的方法已經(jīng)講清楚了，現(xiàn)在再實現(xiàn)一個完整的函數(shù)計時耗時裝飾器。

import time
from functools import wraps

def TimeCost(func):
 @wraps(func)
 def wrapper(*arg, **kwargs):
  start = time.time()
  result = func(*args, **kwargs)
  end = time.time()
  print(func.__name__, end - start)
  return result
 return wrapper

@TimeCost
def countdown(n):
 while n > 0:
  print('time:' + str(n))
  n -= 1

countdown(10000)

函數(shù)輸出：