Improve type annotation for backoff.expo #176
Merged
Conversation
This file contains 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
`backoff.expo` accepts floats. Most usage in our codebase has a floating point `factor`. If we want to preserve exact inference in cases where the return type is `Generator[int, Any, None` we could use an overload (TypeVar could work, but would be a little worse for cases involving defaults).
hauntsaninja
commented
Oct 3, 2022
|
Thank you! This is merged and will be released shortly in backoff v2.2.0. I ended up changing a couple of other wait generators to hint float because they too work fine with int or float. |
cdce8p
reviewed
Oct 5, 2022
| base: float = 2, | ||
| factor: float = 1, | ||
| max_value: Optional[float] = None | ||
| ) -> Generator[Optional[float], Any, None]: |
There was a problem hiding this comment.
This unfortunately broke the typing for _WaitGenerator. I.e. you can no longer do backoff.on_exception(backoff.expo, ...) without a type error, in v2.2.0.
Line 44 in 9a20a7f
/CC: @bgreen-litl
There was a problem hiding this comment.
@cdce8p I'm not sure what you mean. Unit tests and manual tests are working for me...
There was a problem hiding this comment.
@cdce8p @calpaterson Should be fixed in backoff 2.2.1. Let me know if you find otherwise
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
backoff.expoaccepts floats. Most usage in our codebase has a floating pointfactor. If we want to preserve exact inference in cases where the return type isGenerator[int, Any, Nonewe could use an overload (TypeVar could work, but would be a little worse for cases involving defaults).We also had an instance where someone used
backoff.expodirectly in a loop, expecting it to yield floats. This ran into issues because of the initial None yield.