Check whether the return value from RateLimit.from_http() is None
#207
Conversation
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
Check if rate_limit is a valid object rather than evaluating it as a bool when deciding whether to raise a RateLimit exception or not,
brettcannon
requested changes
Jan 4, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #207 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 9 9
Lines 471 471
Branches 87 87
=========================================
Hits 471 471 ☔ View full report in Codecov by Sentry. |
RateLimit.from_http() is None
Collaborator
|
You're right about the bug! Slight code tweak to your PR and it's failing linting. |
Co-authored-by: Brett Cannon <[email protected]>
Author
|
@brettcannon Thanks, added the suggestion! |
brettcannon
requested changes
Jan 12, 2024
Collaborator
brettcannon
left a comment
There was a problem hiding this comment.
I just realized there isn't a test for this. 😅 Could you add one?
Member
|
We also need the changelog entry for this bug fix. |
Member
|
@Kjeld-P still interested in updating your PR with unit tests as requested? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
In handling error-responses from the server the code checks if it's possible to create a rate limit object from the headers through
RateLimit.from_http(headers). This function returns an object if rate limit info was found, and None otherwise.The next line of code wants to check if this value was not none, but does not do so explicitly:
if rate_limit. This causes python to evaluate it as a boolean and callRateLimit.__bool__. This will only returnTrueifself.remaining > 0, which would not be the case if the rate-limit was indeed exceeded.The proposed fix simply explicitly checks if the returned
RateLimitobject is notNone.