retrying 是一个很好用的关于重试的Python包,可以用来自动重试一些可能会运行失败的程序段。
我们在写一些程序的时候,会去调用一些外部资源、组件,这些外部程序对我们来说是不可控的,所以它们不可用、运行失败都是正常的事情,尤其是在网络上多个服务交互的时候,在写程序的时候一定要考虑调用外部程序会失败的情况。
retrying 就是一个可以用来应对上述问题的工具,可以在 PyPi 上获得。
retrying 提供一个装饰器函数 retry ,被装饰的函数就会在运行失败的条件下重新执行,默认只要一直报错就会不断重试,看一下下面的例子:
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 函数,那么直到 random.randint 返回 5 ,它才会执行结束,否则会一直重新执行。
retry 还可以接受一些参数,这个从源码中Retrying类的初始化函数可以看到可选的参数:
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 :用来设定最大的尝试次数,超过该次数就停止重试
stop_max_delay :比如设置成10000,那么从被装饰的函数开始执行的时间点开始,到函数成功运行结束或者失败报错中止的时间点,只要这段时间超过10秒,函数就不会再执行了
wait_fixed :设置在两次retrying之间的停留时间
wait_random_min 和 wait_random_max :用随机的方式产生两次retrying之间的停留时间
wait_exponential_multiplier 和 wait_exponential_max :以指数的形式产生两次retrying之间的停留时间,产生的值为 2^previous_attempt_number * wait_exponential_multiplier ,previous_attempt_number是前面已经retry的次数,如果产生的这个值超过了wait_exponential_max的大小,那么之后两个retrying之间的停留值都为wait_exponential_max。这个设计迎合了 exponential backoff 算法,可以减轻阻塞的情况。
我们可以指定要在出现哪些异常的时候再去retry,这个要用 retry_on_exception 传入一个函数对象:
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() 在执行 read_a_file 函数的过程中,如果报出异常,那么这个异常会以形参 exception 传入 retry_if_io_error 函数中,如果 exception 是 IOError 那么就进行retry,如果不是就停止运行并抛出异常。
我们还可以指定要在得到哪些结果的时候去retry,这个要用 retry_on_result 传入一个函数对象:
def retry_if_result_none(result): return result is None @retry(retry_on_result=retry_if_result_none) def get_result(): return None 在执行get_result成功后,会将函数的返回值通过形参 result 的形式传入 retry_if_result_none 函数中,如果返回值是 None 那么就进行retry,否则就结束并返回函数值。
Get back up and try again: retrying in Python
retrying