原文链接

动机

很多时候，我们都喜欢为代码加入retry功能。比如oauth验证，有时候网络不太灵，我们希望多试几次。

这些retry应用的场景看起来不同，其实又很类似。都是判断代码是否正常运行，如果不是则重新开始。

那么，有没有一种通用的办法来实现呢？

简介

Tenacity¹是一个通用的retry库，简化为任何任务加入重试的功能。

它还包含如下特性:

• 通用的装饰器API
• 可以设定重试停止的条件（比如设定尝试次数）
• 可以设定重试间的等待时间（比如在尝试之间使用幂数级增长的wait等待）
• 自定义在哪些Exception进行重试
• 自定义在哪些返回值的情况进行重试
• 协程的重试

用法
基本用法

from tenacity import *

# 基础的用法，会一直重试下去，直到函数没有抛出异常，正常返回值
@retry
def never_give_up_never_surrender():
    print("一直重试，忽略exceptions，重试间没有等待时间")
    raise Exception

何时停止

让我们加入停止的条件.

例如，在达到尝试次数后停下来:

@retry(stop=stop_after_attempt(7))
def stop_after_7_attempts():
    print("尝试7次后停下")
    raise Exception

在10秒后，如果仍然没有成功，则停下:

@retry(stop=stop_after_delay(10))
def stop_after_10_s():
    print("10秒后停止")
    raise Exception

可以使用|操作符，来组合多种条件:

@retry(stop=(stop_after_delay(10) | stop_after_attempt(5)))
def stop_after_10_s_or_5_retries():
    print("10秒后，或者尝试5次后，停下来")
    raise Exception

尝试间的等待

很多事并不是越快越好。所以，让我们在重试的尝试之间加入一些间隔时间:

@retry(wait=wait_fixed(2))
def wait_2_s():
    print("每次重试间都有2秒间隔")
    raise Exception

间隔可以是随机的:

@retry(wait=wait_random(min=1, max=2))
def wait_random_1_to_2_s():
    print("重试间隔1-2秒")
    raise Exception

还可以加入指数曲线形式的间隔:

@retry(wait=wait_exponential(multiplier=1, min=4, max=10))
def wait_exponential_1():
    print("开始的时候等待 2^x * 1 秒，最少等待4秒，最多10秒，之后都是等待10秒")
    raise Exception

多核在竞争一个共享的资源，使用指数间隔可以将冲突最小化:

@retry(wait=wait_random_exponential(multiplier=1, max=60))
def wait_exponential_jitter():
    print("随机等待 2^x * 1 秒，最多60秒，之后都是等待60秒")
    raise Exception

可以自定义每次等待时长:

@retry(wait=wait_chain(*[wait_fixed(3) for i in range(3)] +
                           [wait_fixed(7) for i in range(2)] +
                           [wait_fixed(9)]))
def wait_fixed_chained():
    print("前三次等待3秒，后两次等待7秒，最后一次等待9秒")
    raise Exception

何时retry

默认情况下，只有函数抛出异常时才会retry。

你可以设置在制定的异常才进行retry：

@retry(retry=retry_if_exception_type(IOError))
def might_io_error():
    print("只有在IOError的时候进行retry，其它时候照常抛出错误")
    raise Exception

可以在判断返回值是否是需要的情况下进行retry:

def is_none_p(value):
        return value is None

@retry(retry=retry_if_result(is_none_p))
def might_return_none():
    print("因为返回值是None，所以这个函数会一直retry")
        
# 这样写也是可以的，不用修改原来的代码
retry_version_func = retry(retry=retry_if_result(is_none_p))(might_return_none)    

当然，这里也可以组合多个条件:

def is_none_p(value):
    return value is None

@retry(retry=(retry_if_result(is_none_p) | retry_if_exception_type()))
def might_return_none():
    print("在抛出任何异常，或者返回值是None的情况下，进行retry")

其它

在函数体内，你可以手动抛出TryAgain错误，进行重试:

@retry
def do_something():
   result = something_else()
   if result == 23:
      raise TryAgain

通过参数reraise=True，可以抛出函数最后一次抛出的异常。如果没有设定，会抛出RetryError:

@retry(reraise=True, stop=stop_after_attempt(3))
def raise_my_exception():
    raise MyException("Fail")

try:
    raise_my_exception()
except MyException:
    print('MyException会被抛出')

在重试的前后，记录日志:

import logging

logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)

logger = logging.getLogger(__name__)

# 重试前记录
@retry(stop=stop_after_attempt(3), before=before_log(logger, logging.DEBUG))
def raise_my_exception():
    raise MyException("Fail")
    
# 重试后记录
@retry(stop=stop_after_attempt(3), after=after_log(logger, logging.DEBUG))
def raise_my_exception():
    raise MyException("Fail")

你可以获取retry的相关统计数据:

@retry(stop=stop_after_attempt(3))
def raise_my_exception():
    raise MyException("Fail")

try:
    raise_my_exception()
except Exception:
    pass

print(raise_my_exception.retry.statistics)

热度分析

这个库已经6岁了，截止2019.5.4日已累计获取1478star, 75fork.
源码分析

这个库在代码和项目方面都是典范，同时API设计的也是相当漂亮。

这个库对python装饰器的用法已经炉火纯青，基本所有的情景都有用到。有兴趣的同学可以通过下面几个点去看：

• retry装饰器为什么可以无参数版本/有参数版本混合使用
• retry装饰器为什么可以作用函数和方法
• retry装饰器为什么可以作用于asyncio协程，tornado协程，普通函数