pylint: refactor config to reduce noise #159
Merged
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
This commit inverts the behavior for pylint checks. Previously, we started with all checks enabled and then disabled some we didn't want. Now we'll instead start with all checks *disabled* and enable those we *do* want. The reasons for this include: - pylint output is far too noisy right now, meaning that the output is generally ignored except for errors. It would be good to make it more useful by cutting down on the number of checks. - pylint adds new checks regularly. If all checks are enabled by default, this adds to the maintenance overhead for us to keep our dependencies continuously up-to-date, since it's more likely that a pylint update will require code changes in order to pass CI or to avoid more noise. - the most valuable pylint checks, such as dangerous-default-value, were implemented long ago and are enabled. By comparison, new pylint checks being added these days are more likely to be opinionated recommendations which are less valuable, so we shouldn't lose much by not enabling them by default.
chandwanitulsi
approved these changes
Jul 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This commit inverts the behavior for pylint checks.
Previously, we started with all checks enabled and then disabled
some we didn't want. Now we'll instead start with all checks
disabled and enable those we do want.
The reasons for this include:
pylint output is far too noisy right now, meaning that the output is
generally ignored except for errors. It would be good to make it more
useful by cutting down on the number of checks.
pylint adds new checks regularly. If all checks are enabled by
default, this adds to the maintenance overhead for us to keep our
dependencies continuously up-to-date, since it's more likely that a
pylint update will require code changes in order to pass CI or to
avoid more noise.
the most valuable pylint checks, such as dangerous-default-value,
were implemented long ago and are enabled. By comparison, new pylint
checks being added these days are more likely to be opinionated
recommendations which are less valuable, so we shouldn't lose much by
not enabling them by default.