Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions obstore/python/obstore/_store/_client.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class ClientConfig(TypedDict, total=False):

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

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

Expand All @@ -52,8 +53,19 @@ class ClientConfig(TypedDict, total=False):
introduces significant vulnerabilities, and should only be used
as a last resort or for testing
"""

connect_timeout: str | timedelta
"""Timeout for only the connect phase of a Client"""
"""Set a timeout for only the connect phase of a Client.

This is the time allowed for the client to establish a connection
and if the connection is not established within this time,
the client returns a timeout error.

Timeout errors are retried, subject to the `RetryConfig`.

Default is 5 seconds.
"""

default_content_type: str
"""Default [`CONTENT_TYPE`] for uploads.

Expand Down Expand Up @@ -108,10 +120,15 @@ class ClientConfig(TypedDict, total=False):

"""HTTP proxy to use for requests."""
timeout: str | timedelta
"""Request timeout.
"""Set timeout for the overall request

The timeout starts from when the request starts connecting until the
response body has finished. If the request does not complete within the
timeout, the client returns a timeout error.

Timeout errors are retried, subject to the `RetryConfig`.

The timeout is applied from when the request starts connecting until the
response body has finished.
Default is 30 seconds.
"""
user_agent: str
"""[User-Agent] header to be used by this client.
Expand Down
Loading