Python重试库Tenacity详解(推荐)

什么是Tenacity

Tenacity是一款Python模块，它能够让你轻松地在Python应用程序中实现重试逻辑。这意味着，你可以利用Tenacity重复执行那些可能会失败的操作，例如，网络请求、数据库操作，直到它们成功为止。

Tenacity还支持非常灵活的重试策略，例如通过时间间隔、指定重试次数等方式，以尽可能地确保操作成功。

安装Tenacity

你可以使用 pip 包管理器来安装 Tenacity 模块，只需要在命令行中执行以下命令即可：

pip install tenacity

如何使用Tenacity

使用Tenacity有两个关键步骤：

1. 定义重试策略
2. 使用重试策略执行代码

定义重试策略

定义重试策略的方式是使用tenacity.retry()装饰器。这个装饰器可以应用在函数或方法上，让被装饰的函数或方法具备自动重试的能力。

Tenacity支持许多不同的重试策略参数，如下所示：

• wait: 表示具体的等待时间间隔。默认为1秒。
• stop: 用于设置重试停止的条件。可以是一个数字（重试次数），也可以是一个函数（停止条件函数）。
• retry: 用于指定要重试的异常或其它异常组。
• reraise: 用于在达到重试次数之后是否抛出异常。
• before_retry: 用于在每次重试之前执行的函数。
• after_retry:用于在每次重试之后执行的函数。

这里以几个示例来介绍如何使用这些参数来定制 Tenacity 的重试策略。

示例1: 等待一段时间再重试

以下代码将利用Tenacity，等待2秒钟，然后尝试重试一个函数。

import tenacity

@tenacity.retry(wait=tenacity.wait_fixed(2))
def call_api():
    print("调用接口...")
    raise Exception("API调用失败！")

call_api()

输出结果：

调用接口...
调用接口...
调用接口...
调用接口...
...

在上面的代码中，我们将wait参数设置为wait_fixed(2)。这表示，当调用失败时，Tenacity将等待2秒钟之后尝试重新调用该函数。此后每次调用失败后，它将一直等待2秒来重试，直到调用成功或达到之前设置的停止策略为止。

示例2: 指定要重试的异常

在以下代码块中，我们利用 Tenacity 重新定义一个连接 MySQL 数据库的重试策略：

import mysql.connector
import tenacity

@tenacity.retry(retry=mysql.connector.errors.InterfaceError)
def connect_mysql():
    print("尝试连接到MySQL...")
    raise mysql.connector.errors.InterfaceError("无法连接到MySQL！")

connect_mysql()

输出结果：

尝试连接到MySQL...
尝试连接到MySQL...
尝试连接到MySQL...
尝试连接到MySQL...
...

在上面的代码中，我们使用了retry=mysql.connector.errors.InterfaceError来指定只有当连接 MySQL 出错时才进行尝试。这里使用的重试策略是Tenacity默认的线性等待策略，每次等待的时间间隔默认为1秒，直到达到停止策略为止。

使用重试策略执行代码

使用Tenacity的重试策略对代码进行重试是非常简单的。定义好策略之后，只需要象普通函数一样调用即可：

call_api()

如果代码重试超过预设的次数，会抛出一个tenacity.RetryError异常：

Retrying call_api: RetryError: RetryError[Retry(total=3, last=None)]: Exceeded maximum number of retries

这个异常指定了尝试的次数，以及上一次的异常。如果你需要自定义异常，可以在retry参数中指定。

以上就是使用Tenacity的基本知识，希望可以帮助到你。