python如何使用wrapt模塊編寫更扁平的裝飾器

這篇文章主要介紹了python如何使用wrapt模塊編寫更扁平的裝飾器，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

使用 wrapt 模塊編寫更扁平的裝飾器

在寫裝飾器的過程中，你有沒有碰到過什么不爽的事情？不管你有沒有，反正我有。我經常在寫代碼的時候，被下面兩件事情搞得特別難受：

1. 實現帶參數的裝飾器時，層層嵌套的函數代碼特別難寫、難讀

2. 因為函數和類方法的不同，為前者寫的裝飾器經常沒法直接套用在后者上

比如，在下面的例子里，我實現了一個生成隨機數并注入為函數參數的裝飾器。

import random
def provide_number(min_num, max_num):
    """裝飾器：隨機生成一個在 [min_num, max_num] 范圍的整數，追加為函數的第一個位置參數
    """
    def wrapper(func):
        def decorated(*args, **kwargs):
            num = random.randint(min_num, max_num)
            # 將 num 作為第一個參數追加后調用函數
            return func(num, *args, **kwargs)
        return decorated
    return wrapper
@provide_number(1, 100)
def print_random_number(num):
    print(num)
# 輸出 1-100 的隨機整數
# OUTPUT: 72
print_random_number()
@provide_number 裝飾器功能看上去很不錯，但它有著我在前面提到的兩個問題：嵌套層級深、無法在類方法上使用。如果直接用它去裝飾類方法，會出現下面的情況：
class Foo:
    @provide_number(1, 100)
    def print_random_number(self, num):
        print(num)
# OUTPUT: <__main__.Foo object at 0x104047278>
Foo().print_random_number()

Foo 類實例中的 print_random_number 方法將會輸出類實例 self ，而不是我們期望的隨機數 num。

之所以會出現這個結果，是因為類方法（method）和函數（function）二者在工作機制上有著細微不同。如果要修復這個問題，provider_number 裝飾器在修改類方法的位置參數時，必須聰明的跳過藏在 *args 里面的類實例 self 變量，才能正確的將 num 作為第一個參數注入。

這時，就應該是 wrapt 模塊閃亮登場的時候了。wrapt 模塊是一個專門幫助你編寫裝飾器的工具庫。利用它，我們可以非常方便的改造 provide_number 裝飾器，完美解決“嵌套層級深”和“無法通用”兩個問題，

import wrapt
def provide_number(min_num, max_num):
    @wrapt.decorator
    def wrapper(wrapped, instance, args, kwargs):
        # 參數含義：
        #
        # - wrapped：被裝飾的函數或類方法
        # - instance：
        #   - 如果被裝飾者為普通類方法，該值為類實例
        #   - 如果被裝飾者為 classmethod 類方法，該值為類
        #   - 如果被裝飾者為類/函數/靜態方法，該值為 None
        #
        # - args：調用時的位置參數（注意沒有 * 符號）
        # - kwargs：調用時的關鍵字參數（注意沒有 ** 符號）
        #
        num = random.randint(min_num, max_num)
        # 無需關注 wrapped 是類方法或普通函數，直接在頭部追加參數
        args = (num,) + args
        return wrapped(*args, **kwargs)
    return wrapper
<... 應用裝飾器部分代碼省略 ...>
# OUTPUT: 48
Foo().print_random_number()

使用 wrapt 模塊編寫的裝飾器，相比原來擁有下面這些優勢：

? 嵌套層級少：使用 @wrapt.decorator 可以將兩層嵌套減少為一層

? 更簡單：處理位置與關鍵字參數時，可以忽略類實例等特殊情況

? 更靈活：針對 instance 值進行條件判斷后，更容易讓裝飾器變得通用

感謝你能夠認真閱讀完這篇文章，希望小編分享的“python如何使用wrapt模塊編寫更扁平的裝飾器”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!