Add the option to ignore by block name, instead of by module #47
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
rubik
requested changes
May 1, 2022
xenon/__init__.py
Outdated
| @@ -36,6 +36,9 @@ def parse_args(): | |||
| help='Comma separated list of patterns to ignore. If ' | |||
| 'they are directories, Xenon won\'t even descend into ' | |||
| 'them') | |||
| parser.add_argument('-ib', '--ignore-blocks', metavar='<str>', dest='ignore_blocks', | |||
There was a problem hiding this comment.
I'd like to keep the convention that short options have a single letter only. Let's pick a letter that is currently unused.
|
Thank you for your contribution! I find this addition quite useful. Two things are necessary before I can merge it:
|
rubik
reviewed
Sep 3, 2022
|
|
||
| for block_to_ignore in args.ignore_blocks.split(','): | ||
| module_name, block_name = block_to_ignore.split(':') | ||
| blocks_to_ignore[module_name.strip()].append(block_name.strip()) |
There was a problem hiding this comment.
Let's use defaultdict(set) and .add, since this is used to check for existence. For big codebases it'll make a difference as membership checks with set are an O(1) operation as opposed to O(n) with lists.
| @@ -34,6 +36,24 @@ def analyze(args, logger): | |||
| return find_infractions(args, logger, results), results | |||
|
|
|||
|
|
|||
| def build_blocks_to_ignore(args): | |||
There was a problem hiding this comment.
This functionality should have at least one unit test.
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.
I want to use xenon to prevent developers in my organization from adding new bad blocks, but still don't fail for existing bad blocks. Ignore/Exclude only allows to exclude by module, this isn't specific enough for us.