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

fix the documentation file README.rst #533

Merged
merged 1 commit into from
Aug 30, 2019
Merged

fix the documentation file README.rst #533

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 9 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,8 +342,8 @@ string, import, etc).
Tests are executed by the ``BanditNodeVisitor`` object as it visits each node
in the AST.

Test results are maintained in the ``BanditResultStore`` and aggregated for
output at the completion of a test run.
Test results are managed in the ``Manager`` and aggregated for
output at the completion of a test run through the method `output_result` from ``Manager`` instance.


Writing Tests
Expand Down Expand Up @@ -378,12 +378,14 @@ Bandit will load plugins from two entry-points:
- `bandit.formatters`
- `bandit.plugins`

Formatters need to accept 4 things:
Formatters need to accept 5 things:

- `result_store`: An instance of `bandit.core.BanditResultStore`
- `file_list`: The list of files which were inspected in the scope
- `scores`: The scores awarded to each file in the scope
- `excluded_files`: The list of files that were excluded from the scope
manager, fileobj, sev_level, conf_level, lines=-1
- `manager`: An instance of `bandit manager`
- `fileobj`: output file object
- `sev_level` : Filtering severity level
- `conf_level`: Filtering confidence level
- `lines=-1`: Number of lines to report

Plugins tend to take advantage of the `bandit.checks` decorator which allows
the author to register a check for a particular type of AST node. For example
Expand Down