feat: Add sentinel value to allow per-request infinite timeout in API queries#900
Merged
achimnol merged 8 commits intoaio-libs:mainfrom Sep 23, 2024
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #900 +/- ##
==========================================
+ Coverage 80.99% 81.10% +0.10%
==========================================
Files 24 24
Lines 1426 1434 +8
Branches 255 256 +1
==========================================
+ Hits 1155 1163 +8
Misses 177 177
Partials 94 94 ☔ View full report in Codecov by Sentry. |
3 tasks
achimnol
approved these changes
Sep 23, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Sentinelsingleton value to allowNone(infinite timeout) arguments in theDocker._query()andDocker._do_query()based APIs.timeoutparameter toDockerImages.pull()method.Are there changes in behavior for the user?
Users can now pass a float or
Noneto thetimeoutparameter in the pull() API.Previously,
Nonemeant 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
changesfolder<issue_id>.<type>for example (588.bug)issue_idchange 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.