retrying是一個很好用的關(guān)于重試的Python包,可以用來自動重試一些可能會運行失敗的程序段驱闷。
為什么選擇retrying
我們在寫一些程序的時候,會去調(diào)用一些外部資源、組件,這些外部程序?qū)ξ覀儊碚f是不可控的吓歇,所以它們不可用、運行失敗都是正常的事情檬输,尤其是在網(wǎng)絡(luò)上多個服務(wù)交互的時候,在寫程序的時候一定要考慮調(diào)用外部程序會失敗的情況匈棘。
retrying
retrying就是一個可以用來應(yīng)對上述問題的工具丧慈,可以在PyPi上獲得。
retrying提供一個裝飾器函數(shù)retry主卫,被裝飾的函數(shù)就會在運行失敗的條件下重新執(zhí)行逃默,默認(rèn)只要一直報錯就會不斷重試,看一下下面的例子:
import random?
from retrying import retry
@retry
def have_a_try():?
????if random.randint(0,10) != 5:
????????raise Exception('It's not 5!')
????print 'It's 5!'
如果我們運行have_a_try函數(shù)簇搅,那么直到random.randint返回5完域,它才會執(zhí)行結(jié)束,否則會一直重新執(zhí)行瘩将。
retry還可以接受一些參數(shù)吟税,這個從源碼中Retrying類的初始化函數(shù)可以看到可選的參數(shù):
def__init__(self,
? ? ? ? ? ? ? ? stop=None, wait=None,
? ? ? ? ? ? ? ? stop_max_attempt_number=None,
? ? ? ? ? ? ? ? stop_max_delay=None,
? ? ? ? ? ? ? ? wait_fixed=None,
? ? ? ? ? ? ? ? wait_random_min=None, wait_random_max=None,
? ? ? ? ? ? ? ? wait_incrementing_start=None, wait_incrementing_increment=None,
? ? ? ? ? ? ? ? wait_exponential_multiplier=None, wait_exponential_max=None,
? ? ? ? ? ? ? ? retry_on_exception=None,
? ? ? ? ? ? ? ? retry_on_result=None,
? ? ? ? ? ? ? ? wrap_exception=False,
? ? ? ? ? ? ? ? stop_func=None,
? ? ? ? ? ? ? ? wait_func=None,
? ? ? ? ? ? ? ? wait_jitter_max=None)
stop_max_attempt_number:用來設(shè)定最大的嘗試次數(shù),超過該次數(shù)就停止重試
stop_max_delay:比如設(shè)置成10000姿现,那么從被裝飾的函數(shù)開始執(zhí)行的時間點開始肠仪,到函數(shù)成功運行結(jié)束或者失敗報錯中止的時間點,只要這段時間超過10秒备典,函數(shù)就不會再執(zhí)行了
wait_fixed:設(shè)置在兩次retrying之間的停留時間
wait_random_min和wait_random_max:用隨機的方式產(chǎn)生兩次retrying之間的停留時間
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荤崇。這個設(shè)計迎合了exponential backoff算法,可以減輕阻塞的情況潮针。
我們可以指定要在出現(xiàn)哪些異常的時候再去retry术荤,這個要用retry_on_exception傳入一個函數(shù)對象:
def retry_if_io_error(exception):
????return isinstance(exception, IOError)
@retry(retry_on_exception=retry_if_io_error)
def read_a_file():
????with open("file","r") as f:
return f.read()
在執(zhí)行read_a_file函數(shù)的過程中,如果報出異常然低,那么這個異常會以形參exception傳入retry_if_io_error函數(shù)中喜每,如果exception是IOError那么就進行retry,如果不是就停止運行并拋出異常雳攘。
我們還可以指定要在得到哪些結(jié)果的時候去retry带兜,這個要用retry_on_result傳入一個函數(shù)對象:
def retry_if_result_none(result):
????return result is None
@retry(retry_on_result=retry_if_result_none)
def get_result():
????return None
在執(zhí)行g(shù)et_result成功后,會將函數(shù)的返回值通過形參result的形式傳入retry_if_result_none函數(shù)中吨灭,如果返回值是None那么就進行retry刚照,否則就結(jié)束并返回函數(shù)值。