Update typing hints of timeouts to allow passing floats #234
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.
The type hint for execute_timeout are incorrect; the call is ultimately passed to
asyncio.wait_for
which supports passing:int
; interpreted as secondsfloat
; interpreted as<seconds>.<milliseconds>
.None
; which results in blocking foreverThis commit fixes the type hint and updates the docs to inform the reader what results from passing in
None
.My main concern about this change is not being clear why it was chosen to specify seconds as though they're ints; it may be that this change now forever subscribes this API to being compatible with
asyncio.wait_for
- and it's not clear to me if that is your overall intent.