Make pylint overgeneral-exceptions check actually work. #447
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
This disable "broad-exception-raised" for some specific instances of "raise Exception" which don't have an obvious better more specific exception. This allows the broad-exception-raised pylintrc misconfiguration to be fixed without breaking the build.
This allows re-enabling the pylint check for broad exceptions. We pick LookupError because that is more specific than Exception and it seems to roughly match the semantic. It is possible serializers.ValidationError might be more appropriate.
This allows enabling pylint check for broad exceptions. We pick EnvironmentError because it is more specific than Exception and seems to match the semantic. Something even more specific might be more appropriate.
Before this change, we see the following messages when running `make lint`:
pylint: Command line or configuration file:1: UserWarning: 'BaseException' is not a proper value for the 'overgeneral-exceptions' option. Use fully qualified name (maybe 'builtins.BaseException' ?) instead. This will cease to be checked at runtime when the configuration upgrader is released.
pylint: Command line or configuration file:1: UserWarning: 'Exception' is not a proper value for the 'overgeneral-exceptions' option. Use fully qualified name (maybe 'builtins.Exception' ?) instead. This will cease to be checked at runtime when the configuration upgrader is released.
pylint: Command line or configuration file:1: UserWarning: 'StandardError' is not a proper value for the 'overgeneral-exceptions' option. Use fully qualified name (maybe 'builtins.StandardError' ?) instead. This will cease to be checked at runtime when the configuration upgrader is released.
This change resolves this and broad exceptions are effectively caught.
schtibe
approved these changes
Aug 13, 2024
| @@ -171,7 +171,7 @@ def _get_boto_access_kwargs(s3_bucket: AVAILABLE_S3_BUCKETS = AVAILABLE_S3_BUCKE | |||
| needed_env_vars = ['AWS_ROLE_ARN', 'AWS_WEB_IDENTITY_TOKEN_FILE'] | |||
| for env_var in needed_env_vars: | |||
| if env_var not in os.environ: | |||
| raise Exception( | |||
| raise EnvironmentError( | |||
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.
This fixes a bug in the pylintrc configuration. This also "fix" some broad exceptions either by using more specific ones or by disabling the check when I couldn't quickly find a more appropriate exception.