feat: Add sentinel value to allow per-request infinite timeout in API queries #900
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do these changes do?
Sentinel
singleton value to allowNone
(infinite timeout) arguments in theDocker._query()
andDocker._do_query()
based APIs.timeout
parameter toDockerImages.pull()
method.Are there changes in behavior for the user?
Users can now pass a float or
None
to thetimeout
parameter in the pull() API.Previously,
None
meant the fallback to the session-configured default timeout, and thus users could not set the infinite timeout for specific API queries like pulling.If the user code has not set any timeout argument, they will work as the same: falling back to the session-level timeout.
If the user code has deliberately set the timeout to
None
, their semantics are changed from the fallback session-level timeouts to individually set infinite timeouts ignoring the session-level timeout.Checklist
changes
folder<issue_id>.<type>
for example (588.bug)issue_id
change it to the pr id after creating the pr.feature
: Signifying a new feature..bugfix
: Signifying a bug fix..doc
: Signifying a documentation improvement..removal
: Signifying a deprecation or removal of public API..misc
: A ticket has been closed, but it is not of interest to users.