Skip to content

Configuration

obstore.store.ClientConfigKey module-attribute 

ClientConfigKey = Literal[
    "allow_http",
    "allow_invalid_certificates",
    "connect_timeout",
    "default_content_type",
    "http1_only",
    "http2_keep_alive_interval",
    "http2_keep_alive_timeout",
    "http2_keep_alive_while_idle",
    "http2_only",
    "pool_idle_timeout",
    "pool_max_idle_per_host",
    "proxy_url",
    "timeout",
    "user_agent",
    "ALLOW_HTTP",
    "ALLOW_INVALID_CERTIFICATES",
    "CONNECT_TIMEOUT",
    "DEFAULT_CONTENT_TYPE",
    "HTTP1_ONLY",
    "HTTP2_KEEP_ALIVE_INTERVAL",
    "HTTP2_KEEP_ALIVE_TIMEOUT",
    "HTTP2_KEEP_ALIVE_WHILE_IDLE",
    "HTTP2_ONLY",
    "POOL_IDLE_TIMEOUT",
    "POOL_MAX_IDLE_PER_HOST",
    "PROXY_URL",
    "TIMEOUT",
    "USER_AGENT",
]

Allowed client configuration keys

Either lower case or upper case strings are accepted.

  • "allow_http": Allow non-TLS, i.e. non-HTTPS connections.

  • "allow_invalid_certificates": Skip certificate validation on https connections.

    Warning

    You should think very carefully before using this method. If invalid certificates are trusted, any certificate for any site will be trusted for use. This includes expired certificates. This introduces significant vulnerabilities, and should only be used as a last resort or for testing

  • "connect_timeout": Timeout for only the connect phase of a Client

  • "default_content_type": default CONTENT_TYPE for uploads
  • "http1_only": Only use http1 connections.
  • "http2_keep_alive_interval": Interval for HTTP2 Ping frames should be sent to keep a connection alive.
  • "http2_keep_alive_timeout": Timeout for receiving an acknowledgement of the keep-alive ping.
  • "http2_keep_alive_while_idle": Enable HTTP2 keep alive pings for idle connections
  • "http2_only": Only use http2 connections
  • "pool_idle_timeout": The pool max idle timeout. This is the length of time an idle connection will be kept alive.
  • "pool_max_idle_per_host": maximum number of idle connections per host.
  • "proxy_url": HTTP proxy to use for requests.
  • "timeout": Request timeout. The timeout is applied from when the request starts connecting until the response body has finished.
  • "user_agent": User-Agent header to be used by this client.

obstore.store.BackoffConfig

Bases: TypedDict

Exponential backoff with jitter

See aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/

base instance-attribute 

base: int | float

The base of the exponential to use

init_backoff instance-attribute 

init_backoff: timedelta

The initial backoff duration

max_backoff instance-attribute 

max_backoff: timedelta

The maximum backoff duration

obstore.store.RetryConfig

Bases: TypedDict

The configuration for how to respond to request errors

The following categories of error will be retried:

  • 5xx server errors
  • Connection errors
  • Dropped connections
  • Timeouts for safe / read-only requests

Requests will be retried up to some limit, using exponential backoff with jitter. See BackoffConfig for more information

backoff instance-attribute 

backoff: BackoffConfig

The backoff configuration

max_retries instance-attribute 

max_retries: int

The maximum number of times to retry a request

Set to 0 to disable retries

retry_timeout instance-attribute 

retry_timeout: timedelta

The maximum length of time from the initial request after which no further retries will be attempted

This not only bounds the length of time before a server error will be surfaced to the application, but also bounds the length of time a request's credentials must remain valid.

As requests are retried without renewing credentials or regenerating request payloads, this number should be kept below 5 minutes to avoid errors due to expired credentials and/or request payloads