PYTHON 幫助

在 Python 中使用 Tenacity 重试功能

發佈 2024年7月1日

在使用 Python 程式語言開發強大且有韌性的程式時，通常需要優雅地處理臨時錯誤，特別是在使用外部服務或網路操作時。這就是強大的 Python 通用重試庫 Tenacity 派上用場的地方。開發人員可以通過將 Tenacity 與 IronPDF 結合來提高其 PDF 生成操作的可靠性和穩健性，這是一個功能豐富的框架，用於在 Python 應用中創建 PDF 文件。

Tenacity 提供了一個可調整且可定制的結構，用於重試由於暫時性問題（如網絡故障、超時或服務中斷）可能失敗或引發異常的任務。Tenacity 通過其用戶友好的 API 和廣泛的功能集，使重試邏輯的開發更加簡單，讓開發人員專注於創造可靠的系統，而不是擔心短暫的故障。

在這篇文章中，我們將討論將 Tenacity 庫與 IronPDF 整合的優勢，展示實用範例，並提供有關如何在 Python 應用程式中建立可靠的 PDF 生成流程的建議。開發人員可以通過將 Tenacity 的強大功能與 IronPDF 結合使用，大幅提升其應用程式的穩健性和可靠性，同時為用戶提供高質量的 PDF 文件。

基於裝飾器的重試

Tenacity 允許程式設計師使用 Python 裝飾器為函數或方法添加重試邏輯。因此，在不更改原始程式碼的情況下，為特定操作添加重試行為變得簡單。

可定制的重试計劃

Tenacity 提供多個可調參數來指定重試計劃。重試的最大次數、重試之間的間隔以及應在何種情況下進行重試，這些都可以由開發人員自訂。

指数退避

Tenacity 支援指數退避，這是一種流行的當前重試調用技術，在每次嘗試的重試次數增加時，重試之間的間隔以指數方式增長。透過這樣做，您可以在流量大或擁塞時避免向目標服務發送過多請求。

抖动和随机性

Tenacity 提供選項來在重試延遲中引入抖動和隨機性，以防止同步問題和雷聲群效應。這可以通過將重試嘗試分散在不同時間來減少多個客戶端同時重試的可能性。

重試條件和例外狀況

根據操作的返回值或引發的任何異常，開發人員可以創建獨特的重試條件。這使得可以精確地調節何時以及在何種條件下應進行重試。

超時與截止日期

Tenacity 促進了一般操作時間限制和截止日期的設置，保證重試的嘗試不會無限進行，如果操作超過預定閾值，最終將被終止。

與流行的 Python 框架整合

Flask、Django 和 Celery 只是 Tenacity 能輕鬆互動的幾個框架。這使開發人員能夠輕鬆地為背景操作、網路端點或系統的任何其他部分新增重試邏輯。

創建和配置 Tenacity

指数退避

from tenacity import wait_exponential

# Exponential backoff sleeping
@retry(wait=wait_exponential(multiplier=1, min=1, max=10))
def my_function():
    ...

from tenacity import wait_exponential

# Exponential backoff sleeping
@retry(wait=wait_exponential(multiplier=1, min=1, max=10))
def my_function():
    ...

PYTHON

multiplier：為了延長重試之間的間隔，請使用指數倍數。
min: 試驗間最短的時間。
max：嘗試次數之間的最長間隔。

隨機抖動

from tenacity import wait_random

@retry(wait=wait_random(min=1, max=10))
def my_function():
    ...

from tenacity import wait_random

@retry(wait=wait_random(min=1, max=10))
def my_function():
    ...

PYTHON

min：試驗之間間隔數的最小任意限制。
max: 在嘗試次數之間的間隔數量的最大任意限制。

自定重試條件

異常自訂重試

from tenacity import retry_if_exception_type

# Coroutines retry code block, exceptions customize retrying
@retry(retry=retry_if_exception_type(ConnectionError))
def my_function():
    ...

from tenacity import retry_if_exception_type

# Coroutines retry code block, exceptions customize retrying
@retry(retry=retry_if_exception_type(ConnectionError))
def my_function():
    ...

PYTHON

僅在引發例外類型事件時再嘗試。(在這種情況下，ConnectionError)提供錯誤訊息。

根據返回值重試

from tenacity import retry_if_result

# Retry forever ignoring exceptions code block
@retry(retry=retry_if_result(lambda result: result is None))
def my_function():
    ...

from tenacity import retry_if_result

# Retry forever ignoring exceptions code block
@retry(retry=retry_if_result(lambda result: result is None))
def my_function():
    ...

PYTHON

只有當該方法返回 None 時才重新嘗試。

停止條件

from tenacity import stop_after_delay

@retry(stop=stop_after_delay(30))
def my_function():
    ...

from tenacity import stop_after_delay

@retry(stop=stop_after_delay(30))
def my_function():
    ...

PYTHON

在預定的時間之後(例如，30秒)，停止嘗試。

重試回呼

from tenacity import after_log

# Custom callbacks
@retry(after=after_log(logger, logging.DEBUG))
def my_function():
    ...

from tenacity import after_log

# Custom callbacks
@retry(after=after_log(logger, logging.DEBUG))
def my_function():
    ...

PYTHON

附加到函數上的重試屬性及其嘗試應使用指定的記錄器記錄。(像 logger)並提高特定日誌級別(如 DEBUG).

入門

什麼是 IronPDF？

我們可以藉助流行的工具包IronPDF，在程式內創建、編輯和渲染PDF文件。以多種方式處理PDF：您可以將HTML頁面轉換為PDF，向已存在的文檔中添加文字、圖片和形狀，以及從現有文檔中提取文字和圖片。甚至可以從HTML內容、圖片或原始數據創建新的PDF頁面。

IronPDF 非常容易使用，這是它的主要優勢之一。 Python 的用戶友好 API 及其豐富的文件資料，使開發人員可以輕鬆地從專案中開始製作 PDF。 IronPDF還具有兩個特點：速度和效率，使開發人員能夠迅速製作高品質的PDF文件。

IronPDF 的幾個優點：

將圖像、原始數據和HTML轉換為PDF。
從 PDF 文件中刪除圖像和文本。
將標頭、頁尾和浮水印添加到 PDF 文件中。
使用密碼和加密保護 PDF 文件。
能夠電子簽名並完成表單。

安裝庫

在 Python 應用程式中同時使用 Tenacity 和 IronPDF 的第一步是安裝所需的相依項並將這兩個庫整合到您的 PDF 生成工作流程中。

pip install tenacity
pip install ironpdf

在您的 Python 腳本中，從 Tenacity 和 IronPDF 導入所需的模組：

from tenacity import retry, stop_after_attempt, wait_fixed
from IronPdf import IronPdf

from tenacity import retry, stop_after_attempt, wait_fixed
from IronPdf import IronPdf

PYTHON

使用 Tenacity 的 @retry 裝飾器來裝飾您的 PDF 生成方法，並設置重試行為，例如：永久重試：

@retry(
    stop=stop_after_attempt(3),   # Stop retrying after 3 attempts
    wait=wait_fixed(2)            # Wait 2 seconds between retry attempts
)
def generate_pdf(html_content):
    iron_pdf = IronPdf()
    iron_pdf.render_html_as_pdf(html_content)
    iron_pdf.save_as_pdf("output.pdf")

@retry(
    stop=stop_after_attempt(3),   # Stop retrying after 3 attempts
    wait=wait_fixed(2)            # Wait 2 seconds between retry attempts
)
def generate_pdf(html_content):
    iron_pdf = IronPdf()
    iron_pdf.render_html_as_pdf(html_content)
    iron_pdf.save_as_pdf("output.pdf")

PYTHON

@retry(stop=嘗試後停止(3)): 表示在嘗試三次後，該函式應停止重複嘗試呼叫。wait_fixed(2)`: 表示每次重試呼叫嘗試之間應有2秒的暫停時間。

呼叫您的函數來創建PDF並傳遞HTML文本。如果發生異常，Tenacity將根據預設的重試參數自動重試該函數。

try:
    html_content = "<html><body><h1>Hello, IronPDF!</h1></body></html>"
    generate_pdf(html_content)
    print("PDF generated successfully")
except Exception as e:
    print("Failed to generate PDF:", e)

try:
    html_content = "<html><body><h1>Hello, IronPDF!</h1></body></html>"
    generate_pdf(html_content)
    print("PDF generated successfully")
except Exception as e:
    print("Failed to generate PDF:", e)

PYTHON

透過修改重試次數、重試條件和等待條件、重試間隔時間以及重試應發生的情況，您可以進一步調整重試行為。 Tenacity 包含不同的重試方法以及重試和等待條件策略，您可以根據需求微調重試行為。