Module slack_sdk.http_retry.builtin_handlers
Expand source code
import random
import time
from http.client import RemoteDisconnected
from typing import Optional, List, Type
from urllib.error import URLError
from slack_sdk.http_retry.interval_calculator import RetryIntervalCalculator
from slack_sdk.http_retry.state import RetryState
from slack_sdk.http_retry.request import HttpRequest
from slack_sdk.http_retry.response import HttpResponse
from slack_sdk.http_retry.handler import RetryHandler, default_interval_calculator
class ConnectionErrorRetryHandler(RetryHandler):
"""RetryHandler that does retries for connectivity issues."""
def __init__(
self,
max_retry_count: int = 1,
interval_calculator: RetryIntervalCalculator = default_interval_calculator,
error_types: List[Type[Exception]] = [
# To cover URLError: <urlopen error [Errno 104] Connection reset by peer>
URLError,
ConnectionResetError,
RemoteDisconnected,
],
):
super().__init__(max_retry_count, interval_calculator)
self.error_types_to_do_retries = error_types
def _can_retry(
self,
*,
state: RetryState,
request: HttpRequest,
response: Optional[HttpResponse] = None,
error: Optional[Exception] = None,
) -> bool:
if error is None:
return False
if isinstance(error, URLError):
if response is not None:
return False # status 40x
for error_type in self.error_types_to_do_retries:
if isinstance(error, error_type):
return True
return False
class RateLimitErrorRetryHandler(RetryHandler):
"""RetryHandler that does retries for rate limited errors."""
def _can_retry(
self,
*,
state: RetryState,
request: HttpRequest,
response: Optional[HttpResponse] = None,
error: Optional[Exception] = None,
) -> bool:
return response is not None and response.status_code == 429
def prepare_for_next_attempt(
self,
*,
state: RetryState,
request: HttpRequest,
response: Optional[HttpResponse] = None,
error: Optional[Exception] = None,
) -> None:
if response is None:
raise error
state.next_attempt_requested = True
retry_after_header_name: Optional[str] = None
for k in response.headers.keys():
if k.lower() == "retry-after":
retry_after_header_name = k
break
duration = 1
if retry_after_header_name is None:
# This situation usually does not arise. Just in case.
duration += random.random()
else:
duration = int(response.headers.get(retry_after_header_name)[0]) + random.random()
time.sleep(duration)
state.increment_current_attempt()
class ServerErrorRetryHandler(RetryHandler):
"""RetryHandler that does retries for server errors."""
def __init__(
self,
max_retry_count: int = 1,
interval_calculator: RetryIntervalCalculator = default_interval_calculator,
):
super().__init__(max_retry_count, interval_calculator)
def _can_retry(
self,
*,
state: RetryState,
request: HttpRequest,
response: Optional[HttpResponse] = None,
error: Optional[Exception] = None,
) -> bool:
return response is not None and response.status_code in [500, 503]
Classes
class ConnectionErrorRetryHandler (max_retry_count: int = 1, interval_calculator: RetryIntervalCalculator = <slack_sdk.http_retry.builtin_interval_calculators.BackoffRetryIntervalCalculator object>, error_types: List[Type[Exception]] = [<class 'urllib.error.URLError'>, <class 'ConnectionResetError'>, <class 'http.client.RemoteDisconnected'>])
-
RetryHandler that does retries for connectivity issues.
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 ConnectionErrorRetryHandler(RetryHandler): """RetryHandler that does retries for connectivity issues.""" def __init__( self, max_retry_count: int = 1, interval_calculator: RetryIntervalCalculator = default_interval_calculator, error_types: List[Type[Exception]] = [ # To cover URLError: <urlopen error [Errno 104] Connection reset by peer> URLError, ConnectionResetError, RemoteDisconnected, ], ): super().__init__(max_retry_count, interval_calculator) self.error_types_to_do_retries = error_types def _can_retry( self, *, state: RetryState, request: HttpRequest, response: Optional[HttpResponse] = None, error: Optional[Exception] = None, ) -> bool: if error is None: return False if isinstance(error, URLError): if response is not None: return False # status 40x for error_type in self.error_types_to_do_retries: if isinstance(error, error_type): return True return False
Ancestors
Class variables
var interval_calculator : RetryIntervalCalculator
var max_retry_count : int
class RateLimitErrorRetryHandler (max_retry_count: int = 1, interval_calculator: RetryIntervalCalculator = <slack_sdk.http_retry.builtin_interval_calculators.BackoffRetryIntervalCalculator object>)
-
RetryHandler that does retries for rate limited errors.
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 RateLimitErrorRetryHandler(RetryHandler): """RetryHandler that does retries for rate limited errors.""" def _can_retry( self, *, state: RetryState, request: HttpRequest, response: Optional[HttpResponse] = None, error: Optional[Exception] = None, ) -> bool: return response is not None and response.status_code == 429 def prepare_for_next_attempt( self, *, state: RetryState, request: HttpRequest, response: Optional[HttpResponse] = None, error: Optional[Exception] = None, ) -> None: if response is None: raise error state.next_attempt_requested = True retry_after_header_name: Optional[str] = None for k in response.headers.keys(): if k.lower() == "retry-after": retry_after_header_name = k break duration = 1 if retry_after_header_name is None: # This situation usually does not arise. Just in case. duration += random.random() else: duration = int(response.headers.get(retry_after_header_name)[0]) + random.random() time.sleep(duration) state.increment_current_attempt()
Ancestors
Class variables
var interval_calculator : RetryIntervalCalculator
var max_retry_count : int
Methods
def prepare_for_next_attempt(self, *, state: RetryState, request: HttpRequest, response: Optional[HttpResponse] = None, error: Optional[Exception] = None) ‑> None
-
Expand source code
def prepare_for_next_attempt( self, *, state: RetryState, request: HttpRequest, response: Optional[HttpResponse] = None, error: Optional[Exception] = None, ) -> None: if response is None: raise error state.next_attempt_requested = True retry_after_header_name: Optional[str] = None for k in response.headers.keys(): if k.lower() == "retry-after": retry_after_header_name = k break duration = 1 if retry_after_header_name is None: # This situation usually does not arise. Just in case. duration += random.random() else: duration = int(response.headers.get(retry_after_header_name)[0]) + random.random() time.sleep(duration) state.increment_current_attempt()
class ServerErrorRetryHandler (max_retry_count: int = 1, interval_calculator: RetryIntervalCalculator = <slack_sdk.http_retry.builtin_interval_calculators.BackoffRetryIntervalCalculator object>)
-
RetryHandler that does retries for server errors.
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 ServerErrorRetryHandler(RetryHandler): """RetryHandler that does retries for server errors.""" def __init__( self, max_retry_count: int = 1, interval_calculator: RetryIntervalCalculator = default_interval_calculator, ): super().__init__(max_retry_count, interval_calculator) def _can_retry( self, *, state: RetryState, request: HttpRequest, response: Optional[HttpResponse] = None, error: Optional[Exception] = None, ) -> bool: return response is not None and response.status_code in [500, 503]
Ancestors
Class variables
var interval_calculator : RetryIntervalCalculator
var max_retry_count : int