python裝飾器的集中使用姿勢

嗨学编程發表於2024-08-10
Python

在Python中，裝飾器是一種十分強大並且好用的語法，一些重複的程式碼使用裝飾器語法的話能夠使程式碼更容易理解及閱讀。

因此在這裡簡單總結了一下Python中裝飾器的幾種用法以及需要注意的事情。

一、在裝飾器中獲取被裝飾函式的引數

假設我們在開發web的時候，需要做反爬。要判斷介面的訪問來源我們就可以透過下面裝飾器的方法來實現：

def mydecorator(func):
    def wrapped(*args, **kwargs):
        print("進入裝飾器")
        if args[0]['header'] == 'spider':
            print("code: 400")
            return

        result = func(*args, **kwargs)
        return result

    return wrapped
@mydecorator
def request_page(request):
    print("一個訪問請求")
    print("返回了response")
if __name__ == '__main__':
    request = {
        'data': 100,
        'header': 'spider'
    }
    request_page(request)

在這個裝飾器中，我們在裝飾器中獲取了request中的header引數，如果判斷訪問來源於爬蟲，那麼便給它返回一個400。

使用裝飾器的寫法等同於下面不使用裝飾器的寫法

def mydecorator(*args, **kwargs):
    print("進入函式")
    if args[0]['header'] == 'spider':
        print("code: 400")
        return False
    return True
def request_page(request):
    if not mydecorator(request):
        return
    print("訪問一個網頁")
    print("得到了response")
if __name__ == '__main__':
    request = {
        'data': 100,
        'header': 'spider'
    }
    request_page(request)

在只需要裝飾一個函式的時候後面一種寫法可能更優於裝飾器的寫法，但是在需要裝飾很多個函式的時候，使用裝飾器明顯是更好的選擇。

二、在裝飾器獲取函式的返回值

有的時候我們需要對函式的返回值做出判斷，但又不想直接將判斷寫在函式里的時候，我們也可以使用裝飾器來實現：

def mydecorator(func):
    def wrapped(*args, **kwargs):
        print("進入裝飾器")
        result = func(*args, **kwargs)
        if result == 400:
            print("response is 400!")
            return False
        return True
    return wrapped

@mydecorator
def request_page():
    print("訪問一個網頁")
    print("得到了response")
    return 200

if __name__ == '__main__':
    print(request_page())

三、給裝飾器傳入引數

在實際應用中，我們有時需要根據函式的執行狀態來重複執行。例如在編寫爬蟲的時候，可能由於網路的原因會導致一些頁面訪問失敗，這時我們就需要根據爬蟲的返回結果進行重複請求。

def retry(MAXRETRY=3):
    def decorator(func):
        def wrapped(*args, **kwargs):
            print("進入裝飾器")

            result = 0
            retry = 1
            while result != 200 and retry <= MAXRETRY:
                result = func(*args, **kwargs)
                print("重試第%s次" % retry)
                retry += 1

            return result

        return wrapped

    return decorator
    
@retry(5)
def request_page():
    print("訪問一個網頁")
    print("得到了response")
    return 400

在這裡我們假設訪問一個網頁得到400的時候便重新請求。我們在retry裝飾器裡傳了一個5，這表示我們希望重試的最大次數為5次，如果不傳入這個值，那麼它的預設重試次數則為3次。

在熟悉了基本裝飾器的寫法後，傳參裝飾器的寫法也十分的好理解了。就是在外面多加了一層函式，用於傳入引數。

四、裝飾器文件的問題

我們都知道透過魔術方法__doc__可以獲取我們寫在程式碼中的文件，那麼你是否知道使用裝飾器後，會造成被包裝函式的文件被裝飾器的文件覆蓋的問題呢。

def request_page():
    '''
    request_page 函式文件
    :return:
    '''
    print("訪問一個網頁")
    print("得到了response")

if __name__ == '__main__':
    print(request_page.__doc__)

在上面對上面未使用裝飾的程式碼使用__doc__方法的時候，我們得到的結果是：

In[3]: request_page.__doc__
Out[3]: '\n    request_page 函式文件\n    :return:\n    '

這是我們理想中的結果！

但是當我們將上述函式使用裝飾器裝飾後：

def decorator(func):
    def wrapped(*args, **kwargs):
        '''
        裝飾器文件
        :param args:
        :param kwargs:
        :return:
        '''
        print("進入裝飾器")
        result = func(*args, **kwargs)
        return result

    return wrapped


@decorator
def request_page():
    '''
    request_page 函式文件
    :return:
    '''
    print("訪問一個網頁")
    print("得到了response")

我們再一次執行__doc__魔術方法的時候，得到的結果卻是裝飾器的內部文件:

In[4]: request_page.__doc__
Out[4]: '\n        裝飾器文件\n        :param args:\n        :param kwargs:\n        :return:\n        '
In[5]: request_page.__name__
Out[5]: 'wrapped'

這個問題會使得我們的除錯變得困難，也會使許多自動文件生成工具失去效果。

解決這個問題的最好辦法就是使用 functools包的wraps()模組來將裝飾器進行一個包裝。

from functools import wraps
def decorator(func):

    @wraps(func)
    def wrapped(*args, **kwargs):
        '''
        裝飾器
        :param args:
        :param kwargs:
        :return:
        '''
        print("進入裝飾器")
        result = func(*args, **kwargs)
        return result
    return wrapped

@decorator
def request_page():
    '''
    request_page 函式文件
    :return:
    '''
    print("訪問一個網頁")
    print("得到了response")

使用wraps將裝飾器裝飾後，這樣我們的函式便能夠儲存它的一些重要資料了。

In[3]: request_page.__doc__
Out[3]: '\n    request_page 函式文件\n    :return:\n    '
In[3]: request_page.__name__
Out[4]: 'request_page'

五、使用class的寫法來編寫裝飾器

雖然大多數的裝飾器都是透過函式的寫法來實現的，但同樣的可以透過類的寫法來實現裝飾器。

使用類的寫法，我們可以實現一些使用函式寫法不太好實現的需求。例如記錄一個函式執行的次數

#學習中遇到問題沒人解答？小編建立了一個Python學習交流群：531509025

class Decorator():
    def __init__(self,func):
        print('類初始化')
        self.func = func
        self.count = 0
    def __call__(self, *args, **kwargs):
        print('進入裝飾器')
        result = self.func(*args,**kwargs)
        self.count += 1

        return result
@Decorator
def request_page():
    '''
    request_page
    :return:
    '''
    print("訪問一個網頁")
    print("得到了response")

相關文章