Pylint alerts corrections as part of an intervention experiment 398 #399
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
Catching Exception might hide unexpected exceptions, like those that might be raised due to future modification.
Therefore, it is recommended to narrow the exceptions.
The method verify_signature of class Signer catches exception in line 233.The try section just calls base64_decode from encoding.py, which in line 37
except (TypeError, ValueError) as e:
raise BadData("Invalid base64-encoded data") from e
raises BadData instead of TypeError and ValueError.Note that binascii.Error is not translated and might be raised. https://docs.python.org/3/library/base64.html#base64.b64decode
I therefore replaced catching Exception in catching (BadData, base64.binascii.Error)
Catching Exception might hide unexpected exceptions, like those that might be raised due to future modification.
Therefore, it is recommended to narrow the exceptions.
The method unsign of class TimestampSigner catches exception in line 116.The try section just calls bytes_to_int(base64_decode(ts_bytes)) from encoding.py.base64_decode in line 37
except (TypeError, ValueError) as e:
raise BadData("Invalid base64-encoded data") from e
raises BadData instead of TypeError and ValueError.
Note that binascii.Error is not translated and might be raised. https://docs.python.org/3/library/base64.html#base64.b64decode
I therefore replaced catching Exception in catching (BadData, base64.binascii.Error)
https://stackoverflow.com/questions/43560936/python-how-to-catch-this-error-cant-source-error-name-binascii-error/43561287
bytes_to_int, also from encoding.py does not seem to raise exceptions.
The error is not found and fails the CI/CD I thought that the used library is https://docs.python.org/3/library/base64.html#base64.b64decode Removing to make the CI/CD pass again. typing: commands[0]> mypy src/itsdangerous/signer.py:233: error: Module has no attribute "binascii" [attr-defined] except (BadData, base64.binascii.Error): ^~~~~~~~~~~~~~~ src/itsdangerous/timed.py:116: error: Module has no attribute "binascii" [attr-defined] except (BadData, base64.binascii.Error): ^~~~~~~~~~~~~~~ Found 2 errors in 2 files (checked 8 source files)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Makes the interventions describe in intervention issue.
The experiment is described here.
Each intervention was done in a dedicated commit with a message explaining it.
However, note that the original code and fix are very similar.