Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Corrected documentation on configuration #868

Merged
merged 4 commits into from
Apr 24, 2022
Merged

Corrected documentation on configuration #868

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e4de402
.bandit is INI file
a-takahashi223 Mar 31, 2022
a7bd46a
Describe how to make Bandit read an INI file
a-takahashi223 Apr 1, 2022
c4b2d52
Remove descriptions about "profile"
a-takahashi223 Apr 1, 2022
2d6cd55
Revert "Remove descriptions about "profile""
a-takahashi223 Apr 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 10 additions & 6 deletions doc/source/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Configuration
Bandit Settings
---------------

Projects may include a YAML file named `.bandit` that specifies command line
Projects may include an INI file named `.bandit` that specifies command line
arguments that should be supplied for that project. The currently supported
arguments are:

Expand All @@ -14,21 +14,25 @@ arguments are:
- skips: comma separated list of tests to skip
- tests: comma separated list of tests to run

To use this, put a YAML file named `.bandit` in your project's directory.
To use this, put an INI file named `.bandit` in your project's directory.
Command line arguments must be in `[bandit]` section.
For example:

::

[bandit]
exclude: /test

::

tests:
- B101
- B102
- B301
[bandit]
tests = B101,B102,B301


Note that Bandit will look for `.bandit` file only if it is invoked with `-r` option.
If you do not use `-r` or the INI file's name is not `.bandit`, you can specify
the file's path explicitly with `--ini` option.

Exclusions
----------
In the event that a line of code triggers a Bandit issue, but that the line
Expand Down