Add notes-rgx option for fixme checker #3394
Merged
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
PCManticore
reviewed
Feb 11, 2020
There was a problem hiding this comment.
Hey @BennyTheSen Solid effort! Overall it looks great, but left a couple of comments to be addressed before we can merge this in.
doc/whatsnew/2.5.rst
Outdated
| @@ -82,3 +82,5 @@ separated list of regexes, that if a name matches will be always marked as a bla | |||
| * Add new --fail-under flag for setting the threshold for the score to fail overall tests. If the score is over the fail-under threshold, pylint will complete SystemExit with value 0 to indicate no errors. | |||
|
|
|||
| * Add a new check (non-str-assignment-to-dunder-name) to ensure that only strings are assigned to ``__name__`` attributes | |||
|
|
|||
| * Add a new option ``notes-rgx`` to make fixme warnings more flexible | |||
There was a problem hiding this comment.
Let's mention here that either notes-rgx or notes can be used.
pylint/checkers/misc.py
Outdated
| { | ||
| "type": "string", | ||
| "metavar": "<regexp>", | ||
| "default": ("a^"), |
There was a problem hiding this comment.
This should not have a default. Let's remove it from line 102.
pylintrc
Outdated
| @@ -103,6 +103,8 @@ logging-modules=logging | |||
| # List of note tags to take in consideration, separated by a comma. | |||
| notes=FIXME,XXX,TODO | |||
|
|
|||
| # Regular expression of note tags to take in consideration. | |||
| notes-rgx=a^ | |||
There was a problem hiding this comment.
This needs to be removed.
| @@ -18,6 +18,15 @@ def function(): | |||
| #FIXME: no space after hash | |||
| # +1: [fixme] | |||
| #todo: no space after hash | |||
|
|
|||
| # +1: [fixme] | |||
There was a problem hiding this comment.
These are some nice tests!
BennyTheSen
force-pushed
the
feature/notes-rgx
branch
from
a2aefba
to
a1be981
Compare
|
Hey @PCManticore thanks for the input, I resolved your comments. |
|
Thanks a lot @BennyTheSen ! |
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.
Steps
doc/whatsnew/<current release.rst>.Description
This PR adds the option
notes-rgxwhich can be used to flag the fixme warnings more flexible with a regex.Also extends the fixme functional test to include the
notesand thenotes-rgxoptionType of Changes
Related Issue