摘要

为了避免由于一些网络或等其他不可控因素，而引起系统调用的功能性问题。比如在发送请求时，会因为网络不稳定，往往会有请求超时的问题。这种情况下，我们通常会在代码中加入重试的代码。重试的代码本身不难实现，但如何写得优雅、易用，是我们要考虑的问题。

这里要给大家介绍的是一个第三方库 -Tenacity （标题中的重试机制并并不准确，它不是 Python 的内置模块，因此并不能称之为机制），它实现了几乎我们可以使用到的所有重试场景，比如：

在什么情况下才进行重试？
重试几次呢?
重试多久后结束？
每次重试的间隔多长呢？
重试失败后的回调？

一、Tenacity的安装

pip install tenacity

二、Tenacity应用场景

2.1 无条件重试，重试之间无间隔

from tenacity import retry
 
@retry
def test_retry():
    print("等待重试，重试无间隔执行...")
    raise Exception
 
test_retry()

if __name__ == '__main__':
    test_retry()

from tenacity import retry, wait_fixed
 
@retry(wait=wait_fixed(2))
def test_retry():
    print("等待重试...")
    raise Exception
 
test_retry()

if __name__ == '__main__':
    test_retry()

2.2 设置停止基本条件

如果执行过程中发生Exception，就会重试，且函数最多重试7次

from tenacity import retry, stop_after_attempt
 
@retry(stop=stop_after_attempt(7))
def test_retry():
    print("等待重试...")
    raise Exception
 
test_retry()

if __name__ == '__main__':
    test_retry()

重试 10 秒后不再重试

from tenacity import retry, stop_after_delay
 
@retry(stop=stop_after_delay(10))
def test_retry():
    print("等待重试...")
    raise Exception
 
test_retry()

if __name__ == '__main__':
    test_retry()

或者上面两个条件满足一个就结束重试

from tenacity import retry, stop_after_delay, stop_after_attempt
 
@retry(stop=(stop_after_delay(10) | stop_after_attempt(7)))
def test_retry():
    print("等待重试...")
    raise Exception
 
test_retry()

if __name__ == '__main__':
    test_retry()

2.3 设置何时进行重试

在出现特定错误/异常（比如请求超时）的情况下，再进行重试。

from requests import exceptions
from tenacity import retry, retry_if_exception_type
 
@retry(retry=retry_if_exception_type(exceptions.Timeout))
def test_retry():
    print("等待重试...")
    raise exceptions.Timeout
 
test_retry()

if __name__ == '__main__':
    test_retry()

在满足自定义条件时，再进行重试。如下示例，当 test_retry 函数返回值为 False 时，再进行重试

from tenacity import retry, stop_after_attempt, retry_if_result
 
def is_false(value):
    return value is False
 
@retry(stop=stop_after_attempt(3),retry=retry_if_result(is_false))
def test_retry():
    return False
 
test_retry()

if __name__ == '__main__':
    test_retry()

实战代码中利用retry的函数来实现基本的逻辑，同时增加了超时设置

import time
from tenacity import retry, retry_if_result, wait_fixed

max_time = 60

def get_vv_clone_status():
    return "unknow"

def is_false(value):
    return value is False

@retry(wait=wait_fixed(10), retry=retry_if_result(is_false))
def check_clone_ststus(start_time):
    # 如果超时
    if (time.time() - start_time) > max_time:
        raise Exception("check clone status time out")
    else:
        # 获取状态结果
        status = get_vv_clone_status()
        print(status)
        # 判断时候需要重试
        if "clone" == status:
            return True
        else:
            print("vv node is cloing…………")
            return False

def is_clone(value):
    print(f"value={value}")
    if value is "clone":
        return False
    else:
        return True

@retry(wait=wait_fixed(10), retry=retry_if_result(is_clone))
def check_clone_ststusV2(start_time):
    # 如果超时
    if (time.time() - start_time) > max_time:
        raise Exception("check clone status time out")
    else:
        # 获取状态结果
        status = get_vv_clone_status()
        print(status)
        return status

def vv_clone():
    # 检查状态

    # 发送clone request

    # 检查是否克隆完成
    check_clone_result = check_clone_ststusV2(start_time=time.time())
    if check_clone_result is True:
        print("clone success")
    else:
        print("clone failed")

if __name__ == '__main__':
    vv_clone()

2.4 重试后错误重新抛出

当出现异常后，tenacity 会进行重试，若重试后还是失败，默认情况下，往上抛出的异常会变成 RetryError，而不是最根本的原因。因此可以加一个参数（reraise=True），使得当重试失败后，往外抛出的异常还是原来的那个。

from tenacity import retry, stop_after_attempt
 
@retry(stop=stop_after_attempt(7), reraise=True)
def test_retry():
    print("等待重试...")
    raise Exception
 
test_retry()

if __name__ == '__main__':
    test_retry()

2.5 设置回调函数

当最后一次重试失败后，可以执行一个回调函数。

from tenacity import *
 
def return_last_value(retry_state):
    print("执行回调函数")
    return retry_state.outcome.result()  # 表示返回原函数的返回值
 
def is_false(value):
    return value is False
 
@retry(stop=stop_after_attempt(3),
       retry_error_callback=return_last_value,
       retry=retry_if_result(is_false))
def test_retry():
    print("等待重试中...")
    return False
 
if __name__ == '__main__':
    test_retry()
------------------------------------------------------------------
等待重试中...
等待重试中...
等待重试中...
执行回调函数
False

Python——Tenacity重试架包的用法

摘要