前言

在編程的時候,我們難免會遇到一些不可靠的情況,比如網(wǎng)絡請求失敗,數(shù)據(jù)庫連接超時等等。這些不確定性會讓我們的程序容易出現(xiàn)各種錯誤和異常。那么如何來增加程序的容錯性和健壯性呢?

可能大多數(shù)人會想到使用try  except來進行異常捕捉進行失敗重試(Retry)。雖然try-escept一個非常常見和有效的方式來增強程序穩(wěn)定性，但是可能一不小心就會造成棧溢出。

所以接下來我就來介紹一個另外的一個專門用于失敗重試的庫：retrying。

定義

在Python生態(tài)中,retrying庫提供了非常便捷的裝飾器和函數(shù)來幫助我們輕松添加失敗重試機制。它可以自定義重試策略、停止條件、等待間隔等,對各種異常進行捕捉處理。使用retrying可以大大減少我們重復編寫失敗重試輪詢的代碼量。

1.下載retrying

pip install retrying

2.無參數(shù)重試

我們可以直接在函數(shù)上使用裝飾器@retry來進行失敗重試

import retrying
@retry
def func():
    for item in range(0,100):
        result=item / 0
        print(result)
        return result

func()

但是這種方式并不建議使用，就像上面的代碼，我們都知道0作為除數(shù)就會報錯，在上面的func函數(shù)中，因為加了@retry裝飾器進行失敗重試，這樣就就會進入一個死循環(huán)一直失敗一直重試。

所以我們在進行失敗重試的時候最好是需要加上一些參數(shù)來限制失敗重試。

3.有參數(shù)重試

(1) stop_max_attempt_number

在retry中傳入stop_max_attempt_number參數(shù)后可以指定失敗重試的次數(shù)

@retry(stop_max_attempt_number=2)
def func():
    print(f"記錄失敗重試")
    for item in range(0,100):
        result=item / 0
        print(result)
        return result

func()

因為這里我們指定了失敗后進行兩次重試，如果重試執(zhí)行兩次后還是報錯則結(jié)束重試，將錯誤信息拋出來。

(2) wait_fixed傳入wati_fixed后，可以指定重試的時間

from retrying import retry
import time

# 設置三秒重試一次
@retry(wait_fixed=3000)  
def func():
    print(f"記錄失敗重試:",time.strftime("%Y-%m-%d %H:%M:%S"))

    result=1 / 0
    print(result)
    return result

func()

配置重試間隔時間后，成語遇到執(zhí)行失敗或者報錯后，就會根據(jù)設置的重試時間去進行重試執(zhí)行

(3) wait_random_min和wait_random_max

通常wait_random_min和wait_random_max是一起搭配使用的，可以設置一個重試等待的時間，然后會在設置的時間區(qū)間內(nèi)隨機取一個等待時間進行重試

from retrying import retry
import time


@retry(wait_random_min=1000,wait_random_max=9000)
def func():
    print(f"記錄失敗重試:",time.strftime("%Y-%m-%d %H:%M:%S"))

    result=1 / 0
    print(result)
    return result

func()

(4) wait_exponential_multiplier和wait_exponential_max

官方解釋為：以指數(shù)的形式產(chǎn)生兩次retrying之間的停留時間, 產(chǎn)生的值為2^previous_attempt_number * wait_exponential_multiplier, previous_attempt_number是前面已經(jīng)retry的次數(shù), 如果產(chǎn)生的這個值超過了wait_exponential_max的大小, 那么之后兩個retrying之間的停留值都為wait_exponential_max

通俗來點講就是每次重試的時間以wait_exponential_multiplier設置的值2，如果重試后還是失敗則繼續(xù)2，直到最后的值等于或則超過wait_exponential_max設置的值后，后面的每一次重試等待時間都是wait_exponential_max設置的值

from retrying import retry
import time

@retry(wait_exponential_multiplier=1000,wait_exponential_max=10000)
def func():
    print(f"記錄失敗重試:",time.strftime("%Y-%m-%d %H:%M:%S"))

    result=1 / 0
    print(result)
    return result

func()

(5)wait_func

在前面介紹的參數(shù)都是如何配置失敗沖重試的等待時間或者重試次數(shù)之類的，但是我們不能時時刻刻盯著程序，在程序代碼發(fā)生錯誤時我們應該要進行發(fā)送短信或者郵件之類的提醒才行

在這里就可以使用到wait_func參數(shù)，它接收一個可執(zhí)行函數(shù)，返回一個具體的間隔時間數(shù)值，單位ms。接收的函數(shù)須接收兩個參數(shù)：attempt_number當前運行次數(shù)，delay_since_first_attempt_ms當前重試機制運行時間(單位ms)

from retrying import retry
import time


def func_demo(attempt_number,delay_since_first_attempt_ms):
    print("函數(shù)運行失敗后運行該函數(shù)")

    if attempt_number == 5:
        print("已經(jīng)重試失敗五次了，開始準備發(fā)送提醒")

    if attempt_number == 10:
        print("已經(jīng)重試失敗超10次了，發(fā)送郵件給相關(guān)人員緊急處理")

    if attempt_number >10:
        print("重試時間過長，做一些其他臨時方案進行補救")

    # return一個重試的時間
    return 2000


@retry(wait_func=func_demo)
def func():
    print(f"記錄失敗重試:",time.strftime("%Y-%m-%d %H:%M:%S"))

    result=1 / 0

    return result

func()

使用wait_func通過調(diào)用其他可執(zhí)行的函數(shù)，我們可以借助它來做一些臨時的補救措施，避免程序一直無法運行而產(chǎn)生的影響。

(6) 其他參數(shù)

在retry中還存在有很多參數(shù)，有興趣的小伙伴可以去詳細了解下

• stop_max_attempt_number：在停止之前嘗試的最大次數(shù)，最后一次如果還是有異常則會拋出異常，停止運行，默認為5次
• stop_max_delay：最大延遲時間，大概意思就是：如果調(diào)用的函數(shù)出現(xiàn)異常，那么就會重復調(diào)用這個函數(shù)，最大調(diào)用時間，默認為100毫秒
• wait_fixed：兩次調(diào)用方法期間停留時長, 如果出現(xiàn)異常則會一直重復調(diào)用，默認 1000毫秒
• wait_random_min：在兩次調(diào)用方法停留時長，停留最短時間，默認為0
• wait_random_max：在兩次調(diào)用方法停留時長，停留最長時間，默認為1000毫秒
• wait_incrementing_increment：每調(diào)用一次則會增加的時長，默認 100毫秒
• wait_exponential_multiplier和wait_exponential_max：以指數(shù)的形式產(chǎn)生兩次「retrying」之間的停留時間，產(chǎn)生的值為2^previous_attempt_number * wait_exponential_multiplier，previous_attempt_number是前面已經(jīng)「retry」的次數(shù)，如果產(chǎn)生的這個值超過了wait_exponential_max的大小，那么之后兩個「retrying」之間的停留值都為wait_exponential_max
• retry_on_exception: 指定一個函數(shù)，如果此函數(shù)返回指定異常，則會重試，如果不是指定的異常則會退出
• retry_on_result：指定一個函數(shù)，如果指定的函數(shù)返回True，則重試，否則拋出異常退出
• wrap_exception：參數(shù)設置為True/False，如果指定的異常類型，包裹在RetryError中，會看到RetryError和程序拋的Exception error
• stop_func: 每次拋出異常時都會執(zhí)行的函數(shù)，如果和stop_max_delay、stop_max_attempt_number配合使用，則后兩者會失效 (指定的stop_func會有兩個參數(shù)：attempts, delay)
• wait_func：和stop_func用法差不多。