Enhancement Proposal: Plugin "assert_used" config-skip snippet #695
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
marianomartinelli
requested review from
ericwb,
ghugo,
lukehinds and
sigmavirus24
as code owners
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 propose a little but hopefully useful change (in my opinion) to the docs about
B101: assert_usedconfig plugin.I struggled a while trying to understand why the skip config snippet wasn't working at all in my project, and it turns out that, as my tests were in nested directories, a wildcard was needed as a prefix for the following rule:
'test_*.py'.Also, as this plugin's
skiprule is mainly used for test files, I believe its worth having a working example for newcomers to bandit.In most cases, tests won't be on the root directory of the project, that's why I propose this change, as it goes hand by hand with real test-scaffolding scenarios.
Thanks for this amazing project!