Python第三方库的retrying

Python第三方库的retrying

retrying是一个python的重试包，可以用来自动重试一些可能运行失败的程序段，retrying提供一个装饰器函数retry，被装饰的函数就会在运行失败的情况下重新执行，默认只要一直报错就会不断重试。

import random
from retrying import retry


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


if __name__ == '__main__':
    print(do_something_unreliable())

stop_max_attempt_number: 用来设定最大的尝试次数，超过该次数就会停止

from retrying import retry


@retry(stop_max_attempt_number=3)
def do_something():
    print('Retry')
    raise IOError("Retry")


if __name__ == '__main__':
    do_something()

stop_max_delay: 从被装饰的函数开始执行的时间点开始到函数成功运行结束或失败报错中止的时间点。单位：毫秒

from retrying import retry
@retry(wait_fixed=1000)
def do_something():
    print('Retry')
    raise IOError("Retry")
do_something()

wait_fixed: 设置在两次retrying之间的停留时间 毫秒

wait_random_min：两次retrying之间的停留最短时间

wait_random_max：两次retrying之间的停留最长时间

wait_incrementing_increment：每调用一次则会增加的时长，默认 100毫秒

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.

from retrying import retry
@retry(wait_exponential_multiplier=100, wait_exponential_max=10000)
def do_something():
    print('Retry')
    raise IOError("Retry")
do_something()

retry_on_exception

指定一个函数，如果此函数返回指定异常，则会重试，如果不是指定的异常则会退出

指定异常类型，指定的异常类型会重试，不指定的类型，会直接异常退出，wrap_exception参数设置为True，则其他类型异常，或包裹在RetryError中，会看到RetryError和程序抛的Exception error

def retry_if_io_error(exception):
    print("---------------------------")
    return isinstance(exception, FileNotFoundError)

@retry(retry_on_exception=retry_if_io_error)
def this_maybe_has_error():
    try:
        print("test")
        with open("aa.txt", 'r') as f:
            f.readlines()
    except FileNotFoundError as e:
        raise FileNotFoundError
this_maybe_has_error()

此时会一直重试。

retry_on_result

指定一个函数，如果指定的函数返回True，则重试，否则抛出异常退出

指定要在得到哪些结果的时候去retry，retry_on_result传入一个函数对象,在执行get_result成功后，会将函数的返回值通过形参result的形式传入retry_if_result_none函数中，如果返回值是None那么就进行retry，否则就结束并返回函数值

def retry_if_result_none(result):
    print("retry_if_result_none")
    return result is None

@retry(retry_on_result=retry_if_result_none)
def get_result():
    print('Retry forever ignoring Exceptions with no wait if return value is None')
    return None
get_result()

如果retry_if_result_none返回True则会一直循环调用，以上代码会一直循环调用

wrap_exception

参数设置为True/False，如果指定的异常类型，包裹在RetryError中，会看到RetryError和程序抛的Exception error

stop_func

每次抛出异常时都会执行的函数，如果和stop_max_delay、stop_max_attempt_number配合使用，则后两者会失效

指定的stop_func会有两个参数：attempts, delay

def stop_func(attempts, delay):
    print("stop_func %d--->%d" % (attempts,delay))

@retry(stop_max_delay=10, stop_func=stop_func)
def test_stop_func():
    print("test_stop_func")
    raise Exception

test_stop_func()

会一直循环下去，因为top_max_delay 这个参数失效了。

wait_func

和stop_func用法差不多，不多描述

参考文章

传送门

传送门