40.少有人知的 Python“重試機制”

為了避免由于一些網絡或其他不可控因素，而引起的功能性問題。比如在發送請求時，會因為網絡不穩定，往往會有請求逾時的問題。

這種情況下，我們通常會在代碼中加入重試的代碼。重試的代碼本身不難實作，但如何寫得優雅、易用，是我們要考慮的問題。

這裡要給大家介紹的是一個第三方庫 - Tenacity ，它實作了幾乎我們可以使用到的所有重試場景，比如：

1. 在什麼情況下才進行重試？
2. 重試幾次呢?
3. 重試多久後結束？
4. 每次重試的間隔多長呢？
5. 重試失敗後的回調？

在使用它之前 ，先要安裝它

$ pip install tenacity
           

最基本的重試

無條件重試，重試之間無間隔

from tenacity import retry

@retry
def test_retry():
    print("等待重試，重試無間隔執行...")
    raise Exception

test_retry()
           

無條件重試，但是在重試之前要等待 2 秒

from tenacity import retry, wait_fixed

@retry(wait=wait_fixed(2))
def test_retry():
    print("等待重試...")
    raise Exception

test_retry()
           

設定停止基本條件

隻重試7 次

from tenacity import retry, stop_after_attempt

@retry(stop=stop_after_attempt(7))
def test_retry():
    print("等待重試...")
    raise Exception

test_retry()
           

重試 10 秒後不再重試

from tenacity import retry, stop_after_delay

@retry(stop=stop_after_delay(10))
def test_retry():
    print("等待重試...")
    raise Exception

test_retry()
           

或者上面兩個條件滿足一個就結束重試

from tenacity import retry, stop_after_delay, stop_after_attempt

@retry(stop=(stop_after_delay(10) | stop_after_attempt(7)))
def test_retry():
    print("等待重試...")
    raise Exception

test_retry()
           

設定何時進行重試

在出現特定錯誤/異常（比如請求逾時）的情況下，再進行重試

from requests import exceptions
from tenacity import retry, retry_if_exception_type

@retry(retry=retry_if_exception_type(exceptions.Timeout))
def test_retry():
    print("等待重試...")
    raise exceptions.Timeout

test_retry()
           

在滿足自定義條件時，再進行重試。

如下示例，當 test_retry 函數傳回值為 False 時，再進行重試

from tenacity import retry, stop_after_attempt, retry_if_result

def is_false(value):
    return value is False

@retry(stop=stop_after_attempt(3),
       retry=retry_if_result(is_false))
def test_retry():
    return False

test_retry()
           

多個條件注意順序

如果想對一個異常進行重試，但是最多重試3次。

下面這個代碼是無效的，因為它會一直重試，重試三次的限制不會生效，因為它的條件是有順序的，在前面的條件會先被走到，就永遠走不到後面的條件。

import time
from requests import exceptions
from tenacity import retry, retry_if_exception_type, stop_after_attempt

@retry(retry=retry_if_exception_type(exceptions.Timeout), stop=stop_after_attempt(3))
def test_retry():
    time.sleep(1)
    print("retry")
    raise exceptions.Timeout

test_retry()
           

如果你把 stop_after_attempt 寫到前邊，就沒有問題了。

import time
from requests import exceptions
from tenacity import retry, retry_if_exception_type, stop_after_attempt

@retry(stop=stop_after_attempt(5), retry=retry_if_exception_type(exceptions.Timeout))
def test_retry():
    time.sleep(1)
    print("retry")
    raise exceptions.Timeout

test_retry()
           

重試後錯誤重新抛出

當出現異常後，tenacity 會進行重試，若重試後還是失敗，預設情況下，往上抛出的異常會變成 RetryError，而不是最根本的原因。

是以可以加一個參數（reraise=True），使得當重試失敗後，往外抛出的異常還是原來的那個。

from tenacity import retry, stop_after_attempt

@retry(stop=stop_after_attempt(7), reraise=True)
def test_retry():
    print("等待重試...")
    raise Exception

test_retry()
           

設定回調函數

當最後一次重試失敗後，可以執行一個回調函數

from tenacity import *

def return_last_value(retry_state):
    print("執行回調函數")
    return retry_state.outcome.result()  # 表示傳回原函數的傳回值

def is_false(value):
    return value is False

@retry(stop=stop_after_attempt(3),
       retry_error_callback=return_last_value,
       retry=retry_if_result(is_false))
def test_retry():
    print("等待重試中...")
    return False

print(test_retry())
           

輸出如下

等待重試中...
等待重試中...
等待重試中...
執行回調函數
False           

摘自黑魔法手冊