PyCQA/bandit

config file as described in README.rst does not work

Open

#317 opened on Jun 18, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (5,660 stars) (559 forks)batch import
buggood first issue

Description

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

  1. create .bandit file with content:
[bandit]
tests: B101,B102,B301
  1. run bandit -c .bandit -r module/
  2. get error: [main] ERROR .bandit : Error parsing file.

Expected behavior working as described in readme

Bandit version

bandit 1.4.0

Additional context Docs say it should be YAML and not INI. https://bandit.readthedocs.io/en/latest/config.html

Contributor guide

Tech stack
python
Domain
security
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic Python knowledgefamiliarity with config file formats
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the config file parsing logic in Bandit, likely in the `bandit/config` module or similar. The issue indicates that the README describes using an INI style config but the docs say YAML is expected. Fix the parser to support the documented format or update the documentation to be consistent. Check existing comments for further context.