Improve #1092 #1084 by removing mutable method default arguments#1093
Merged
seratch merged 1 commit intoslackapi:mainfrom Aug 13, 2021
Merged
Improve #1092 #1084 by removing mutable method default arguments#1093seratch merged 1 commit intoslackapi:mainfrom
seratch merged 1 commit intoslackapi:mainfrom
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1093 +/- ##
==========================================
- Coverage 86.19% 86.05% -0.15%
==========================================
Files 110 110
Lines 9932 9932
==========================================
- Hits 8561 8547 -14
- Misses 1371 1385 +14
Continue to review full report at Codecov.
|
seratch
commented
Aug 13, 2021
| error: Optional[Exception] = None, | ||
| ) -> bool: | ||
| return response.status_code == 429 | ||
| return response is not None and response.status_code == 429 |
Contributor
Author
There was a problem hiding this comment.
While running tests, some tests detected a potential error pattern where the response can be None when error is thrown.
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
1 participant
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.
Summary
This pull request corrects a classic Python coding error 🤦 in #1084 #1092 . Passing mutable objects as default value for method arguments is a bad practice. The default value can be cached and can be shared among multiple instances. This pull request eliminates it by setting
Noneto the arguments if nothing is passed.Category (place an
xin each of the[ ])/docs-src(Documents, have you run./docs.sh?)/docs-src-v2(Documents, have you run./docs-v2.sh?)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements (place an
xin each[ ])python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.