Документация

Повторы

Настройка повторов с помощью RetryPolicy: число попыток, повторяемые статусы, backoff и обработка заголовков повторов.

typesafe_sdk.RetryPolicy

dataclass

RetryPolicy(
    max_retries: int = 2,
    backoff_initial: float = 0.5,
    backoff_max: float = 5.0,
    backoff_jitter: float = 0.25,
    http_statuses: set[int] = (
        lambda: {408, 429, *range(500, 600)}
    )(),
    respect_retry_after: bool = True,
    api_connection_error: bool = True,
    api_timeout_error: bool = True,
    exceptions: set[
        type[BaseException]
    ] = set(),
    predicate: Callable[[BaseException], bool]
    | None = None,
    timeout: float | None = 30.0,
)

Конфигурация поведения SDK при повторах.

Примеры:

from typesafe_sdk import RetryPolicy, TypeSafeClient

client = TypeSafeClient(
    retry=RetryPolicy(
        max_retries=3, timeout=10.0, http_statuses={429, 500, 502, 503, 504}
    )
)

max_retries

class-attribute instance-attribute

max_retries: int = 2

Максимальное число повторов после первой попытки; 0 отключает повторы.

backoff_initial

class-attribute instance-attribute

backoff_initial: float = 0.5

Первая задержка backoff в секундах, удваивается с каждой попыткой вплоть до backoff_max; ноль отключает backoff.

backoff_max

class-attribute instance-attribute

backoff_max: float = 5.0

Максимальная задержка backoff в секундах; ноль отключает backoff.

backoff_jitter

class-attribute instance-attribute

backoff_jitter: float = 0.25

Доля каждой задержки backoff, случайно вычитаемая, от 0 до 1.

http_statuses

class-attribute instance-attribute

http_statuses: set[int] = field(
    default_factory=lambda: {
        408,
        429,
        *range(500, 600),
    }
)

Коды состояния HTTP, при которых выполняется повтор.

respect_retry_after

class-attribute instance-attribute

respect_retry_after: bool = True

Учитывать ли заголовки ответа Retry-After и retry-after-ms.

api_connection_error

class-attribute instance-attribute

api_connection_error: bool = True

Повторять ли при TypeSafeAPIConnectionError, который возникает, когда запрос не может достичь сервера или прочитать из него ответ.

api_timeout_error

class-attribute instance-attribute

api_timeout_error: bool = True

Повторять ли при TypeSafeAPITimeoutError, который возникает, когда запрос превышает свой таймаут.

exceptions

class-attribute instance-attribute

exceptions: set[type[BaseException]] = field(
    default_factory=set
)

Дополнительные типы исключений, которые запускают повтор помимо встроенных правил.

predicate

class-attribute instance-attribute

predicate: (
    Callable[[BaseException], bool] | None
) = None

Необязательный предикат, вызываемый с возникшим исключением; возврат True запускает повтор вдобавок к остальным правилам.

timeout

class-attribute instance-attribute

timeout: float | None = 30.0

Общий бюджет повторов в секундах на один вызов SDK, включая первую попытку и задержки; None отключает ограничение.

Останавливается перед повтором, задержка которого достигла бы бюджета или превысила его, и повторно возбуждает последнюю ошибку.