-
-
Notifications
You must be signed in to change notification settings - Fork 603
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Mention exclude_dirs
option available in TOML and YAML
#876
Merged
sigmavirus24
merged 2 commits into
PyCQA:main
from
bittner:docs/explain-exclude-dirs-option
Aug 11, 2022
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just noticed that
tomli
is required if you use apyproject.toml
. In my case our CI didn't break because it was installed via other packages, but a bare install makes it indeed not work.Since the
setup.cfg
file seems to also have an extra foryaml
files:bandit/setup.cfg
Lines 30 to 34 in caae4ee
Should we mention it as well in here? Or does a
.bandit
YAML file work with just installingpip install bandit
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I'm confused. 🤔 Installing the
toml
extra, that's what thepip install bandit[toml]
does. Anything else needed from your point of view in addition to those instructions?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What I mean is that in order to make bandit process a
pyproject.toml
file it needs to be installed viapip install bandit[toml]
. Does it need to be installed viapip install bandit[yaml]
for yaml files? If so, it should probably be in this docs as well.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand! So, "If you want to include TOML support" is not clear enough?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Argh, YAML! Now I understand. Let me verify this locally.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can confirm, the latest version of PyYAML (not the one in requirements.txt) is installed as a dependency when you install Bandit via
pip install bandit
.I'm a bit puzzled: I absolutely can't see in the source code where the dependencies being installed are defined.