Python 在函數上添加包裝器

問題

你想在函數上添加一個包裝器，增加額外的操作處理(比如日志、計時等)。

解決方案

如果你想使用額外的代碼包裝一個函數，可以定義一個裝飾器函數，例如：

import timefrom functools import wrapsdef timethis(func): ’’’ Decorator that reports the execution time. ’’’ @wraps(func) def wrapper(*args, **kwargs): start = time.time() result = func(*args, **kwargs) end = time.time() print(func.__name__, end-start) return result return wrapper

下面是使用裝飾器的例子：

>>> @timethis... def countdown(n):... ’’’... Counts down... ’’’... while n > 0:... n -= 1...>>> countdown(100000)countdown 0.008917808532714844>>> countdown(10000000)countdown 0.87188299392912>>>

討論

一個裝飾器就是一個函數，它接受一個函數作為參數并返回一個新的函數。當你像下面這樣寫：

@timethisdef countdown(n): pass

跟像下面這樣寫其實效果是一樣的：

def countdown(n): passcountdown = timethis(countdown)

順便說一下，內置的裝飾器比如 @staticmethod, @classmethod,@property 原理也是一樣的。例如，下面這兩個代碼片段是等價的：

class A: @classmethod def method(cls): passclass B: # Equivalent definition of a class method def method(cls): pass method = classmethod(method)

在上面的 wrapper() 函數中，裝飾器內部定義了一個使用 *args 和 **kwargs 來接受任意參數的函數。在這個函數里面調用了原始函數并將其結果返回，不過你還可以添加其他額外的代碼(比如計時)。然后這個新的函數包裝器被作為結果返回來代替原始函數。

需要強調的是裝飾器并不會修改原始函數的參數簽名以及返回值。使用 *args 和 **kwargs 目的就是確保任何參數都能適用。而返回結果值基本都是調用原始函數 func(*args, **kwargs) 的返回結果，其中func就是原始函數。

剛開始學習裝飾器的時候，會使用一些簡單的例子來說明，比如上面演示的這個。不過實際場景使用時，還是有一些細節問題要注意的。比如上面使用 @wraps(func) 注解是很重要的，它能保留原始函數的元數據(下一小節會講到)，新手經常會忽略這個細節。接下來的幾個小節我們會更加深入的講解裝飾器函數的細節問題，如果你想構造你自己的裝飾器函數，需要認真看一下。

以上就是Python 在函數上添加包裝器的詳細內容，更多關于Python 添加包裝器的資料請關注好吧啦網其它相關文章！