Module slack_sdk.http_retry.handler

RetryHandler interface. You can pass an array of handlers to customize retry logics in supported API clients.

Classes

class RetryHandler (max_retry_count: int = 1,
interval_calculator: RetryIntervalCalculator = <slack_sdk.http_retry.builtin_interval_calculators.BackoffRetryIntervalCalculator object>)

RetryHandler interface. You can pass an array of handlers to customize retry logics in supported API clients.

RetryHandler interface.

Args

max_retry_count

The maximum times to do retries

interval_calculator

Pass an interval calculator for customizing the logic

Expand source code

class RetryHandler:
    """RetryHandler interface.
    You can pass an array of handlers to customize retry logics in supported API clients.
    """

    max_retry_count: int
    interval_calculator: RetryIntervalCalculator

    def __init__(
        self,
        max_retry_count: int = 1,
        interval_calculator: RetryIntervalCalculator = default_interval_calculator,
    ):
        """RetryHandler interface.

        Args:
            max_retry_count: The maximum times to do retries
            interval_calculator: Pass an interval calculator for customizing the logic
        """
        self.max_retry_count = max_retry_count
        self.interval_calculator = interval_calculator

    def can_retry(
        self,
        *,
        state: RetryState,
        request: HttpRequest,
        response: Optional[HttpResponse] = None,
        error: Optional[Exception] = None,
    ) -> bool:
        if state.current_attempt >= self.max_retry_count:
            return False
        return self._can_retry(
            state=state,
            request=request,
            response=response,
            error=error,
        )

    def _can_retry(
        self,
        *,
        state: RetryState,
        request: HttpRequest,
        response: Optional[HttpResponse] = None,
        error: Optional[Exception] = None,
    ) -> bool:
        raise NotImplementedError()

    def prepare_for_next_attempt(
        self,
        *,
        state: RetryState,
        request: HttpRequest,
        response: Optional[HttpResponse] = None,
        error: Optional[Exception] = None,
    ) -> None:
        state.next_attempt_requested = True
        duration = self.interval_calculator.calculate_sleep_duration(state.current_attempt)
        time.sleep(duration)
        state.increment_current_attempt()

Subclasses

• ConnectionErrorRetryHandler
• RateLimitErrorRetryHandler
• ServerErrorRetryHandler

Class variables

var interval_calculator : RetryIntervalCalculator

The type of the None singleton.

var max_retry_count : int

The type of the None singleton.

Methods

def can_retry(self,
*,
state: RetryState,
request: HttpRequest,
response: HttpResponse | None = None,
error: Exception | None = None) ‑> bool

def prepare_for_next_attempt(self,
*,
state: RetryState,
request: HttpRequest,
response: HttpResponse | None = None,
error: Exception | None = None) ‑> None