幾種你可能不知道的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的寫法來編寫裝飾器

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

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

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

六、總結

裝飾器是Python裏比較高級的一種語法，這裏只是介紹了它的幾種使用技巧，以及需要注意的問題。借用金庸先生的話，“武功無高低，修爲有深淺”。想要更加靈活的使用裝飾器，深入理解它的原理，我們在平時還是需要加強基本功的學習！