python-retrying

retrying 是一个很好用的关于重试的 Python 包，可以用来自动重试一些可能会运行失败的程序段。

我们在写一些程序的时候，会去调用一些外部资源、组件，这些外部程序对我们来说是不可控的，所以它们不可用、运行失败都是正常的事情，尤其是在网络上多个服务交互的时候，在写程序的时候一定要考虑调用外部程序会失败的情况。

retrying

retrying 就是一个可以用来应对上述问题的工具，可以在 [PyPi](retrying · PyPI) 上获得。
retrying 提供一个装饰器函数 retry，被装饰的函数就会在运行失败的条件下重新执行，默认只要一直报错就会不断重试，看一下下面的例子：

import random
from retrying import retry

@retry
def do_something_unreliable():
    if random.randint(0, 10) > 1:
        raise IOError("Broken sauce, everything is hosed!!!111one")
    else:
        return "Awesome sauce!"

print do_something_unreliable()

如果运行 do_something_unreliable 函数，直到 random.randint 返回 1，它才会执行结束，否则会一直重新执行。

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

    self._stop_max_attempt_number = 5 if stop_max_attempt_number is None else stop_max_attempt_number
    self._stop_max_delay = 100 if stop_max_delay is None else stop_max_delay
    self._wait_fixed = 1000 if wait_fixed is None else wait_fixed
    self._wait_random_min = 0 if wait_random_min is None else wait_random_min
    self._wait_random_max = 1000 if wait_random_max is None else wait_random_max
    self._wait_incrementing_start = 0 if wait_incrementing_start is None else wait_incrementing_start
    self._wait_incrementing_increment = 100 if wait_incrementing_increment is None else wait_incrementing_increment
    self._wait_exponential_multiplier = 1 if wait_exponential_multiplier is None else wait_exponential_multiplier
    self._wait_exponential_max = MAX_WAIT if wait_exponential_max is None else wait_exponential_max
    self._wait_jitter_max = 0 if wait_jitter_max is None else wait_jitter_max

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，否则就结束并返回函数值。

陈鹏的博客

python-retrying

retrying

参考资料