# SPDX-FileCopyrightText: 2022-present deepset GmbH # # SPDX-License-Identifier: Apache-2.0 import logging from typing import List, Optional import requests from tenacity import after_log, before_log, retry, retry_if_exception_type, stop_after_attempt, wait_exponential logger = logging.getLogger(__file__) def request_with_retry( attempts: int = 3, status_codes_to_retry: Optional[List[int]] = None, **kwargs ) -> requests.Response: """ Executes an HTTP request with a configurable exponential backoff retry on failures. Usage example: ```python from haystack.utils import request_with_retry # Sending an HTTP request with default retry configs res = request_with_retry(method="GET", url="https://example.com") # Sending an HTTP request with custom number of attempts res = request_with_retry(method="GET", url="https://example.com", attempts=10) # Sending an HTTP request with custom HTTP codes to retry res = request_with_retry(method="GET", url="https://example.com", status_codes_to_retry=[408, 503]) # Sending an HTTP request with custom timeout in seconds res = request_with_retry(method="GET", url="https://example.com", timeout=5) # Sending an HTTP request with custom authorization handling class CustomAuth(requests.auth.AuthBase): def __call__(self, r): r.headers["authorization"] = "Basic " return r res = request_with_retry(method="GET", url="https://example.com", auth=CustomAuth()) # All of the above combined res = request_with_retry( method="GET", url="https://example.com", auth=CustomAuth(), attempts=10, status_codes_to_retry=[408, 503], timeout=5 ) # Sending a POST request res = request_with_retry(method="POST", url="https://example.com", data={"key": "value"}, attempts=10) # Retry all 5xx status codes res = request_with_retry(method="GET", url="https://example.com", status_codes_to_retry=list(range(500, 600))) ``` :param attempts: Maximum number of attempts to retry the request. :param status_codes_to_retry: List of HTTP status codes that will trigger a retry. When param is `None`, HTTP 408, 418, 429 and 503 will be retried. :param kwargs: Optional arguments that `request` accepts. :returns: The `Response` object. """ if status_codes_to_retry is None: status_codes_to_retry = [408, 418, 429, 503] @retry( reraise=True, wait=wait_exponential(), retry=retry_if_exception_type((requests.HTTPError, TimeoutError)), stop=stop_after_attempt(attempts), before=before_log(logger, logging.DEBUG), after=after_log(logger, logging.DEBUG), ) def run(): timeout = kwargs.pop("timeout", 10) res = requests.request(**kwargs, timeout=timeout) if res.status_code in status_codes_to_retry: # We raise only for the status codes that must trigger a retry res.raise_for_status() return res res = run() # We raise here too in case the request failed with a status code that # won't trigger a retry, this way the call will still cause an explicit exception res.raise_for_status() return res