Documentação

Tentativas

Configure tentativas com RetryPolicy — número de tentativas, status repetíveis, backoff e tratamento de cabeçalhos de tentativa.

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,
)

Configuração do comportamento de tentativas do SDK.

Exemplos:

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

Número máximo de tentativas após a tentativa inicial; 0 desabilita as tentativas.

backoff_initial

class-attribute instance-attribute

backoff_initial: float = 0.5

Primeiro atraso de backoff em segundos, dobrado a cada tentativa até backoff_max; zero desabilita o backoff.

backoff_max

class-attribute instance-attribute

backoff_max: float = 5.0

Atraso máximo de backoff em segundos; zero desabilita o backoff.

backoff_jitter

class-attribute instance-attribute

backoff_jitter: float = 0.25

Fração de cada atraso de backoff subtraída aleatoriamente, entre 0 e 1.

http_statuses

class-attribute instance-attribute

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

Códigos de status HTTP que são repetidos.

respect_retry_after

class-attribute instance-attribute

respect_retry_after: bool = True

Se deve respeitar os cabeçalhos de resposta Retry-After e retry-after-ms.

api_connection_error

class-attribute instance-attribute

api_connection_error: bool = True

Se deve repetir TypeSafeAPIConnectionError, gerado quando a requisição não consegue alcançar ou ler do servidor.

api_timeout_error

class-attribute instance-attribute

api_timeout_error: bool = True

Se deve repetir TypeSafeAPITimeoutError, gerado quando a requisição excede seu tempo limite.

exceptions

class-attribute instance-attribute

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

Tipos de exceção adicionais que disparam uma tentativa, além das regras internas.

predicate

class-attribute instance-attribute

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

Um predicado opcional chamado com a exceção gerada; retornar True dispara uma tentativa além das outras regras.

timeout

class-attribute instance-attribute

timeout: float | None = 30.0

Orçamento total de tentativas em segundos por chamada do SDK, incluindo a tentativa inicial e os atrasos; None desabilita o limite.

Para antes de uma tentativa cujo atraso alcançaria ou excederia o orçamento, relançando o último erro.