aio-libs / aiodocker

Python Docker API client based on asyncio and aiohttp
Other
442 stars 101 forks source link

feat: Add sentinel value to allow per-request infinite timeout in API queries #900

Closed fregataa closed 2 months ago

fregataa commented 2 months ago

What do these changes do?

Are there changes in behavior for the user?

Users can now pass a float or None to the timeout 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

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 81.10%. Comparing base (5148c63) to head (49b51e4). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.