Update Tool and Documentation

[DMarinhoCodacy]

No description provided.

[codacy-production]

Up to standards ✅

🟢 Issues 2 minor

Results:
2 new issues

Category	Results
Documentation	2 minor

View in Codacy

🟢 Metrics 112 complexity · 0 duplication

Metric	Results
Complexity	112
Duplication	0

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

_{TIP This summary will be updated as you push new changes.}

[codacy-production]

Pull Request Overview

The overhaul of the Bandit documentation generation system is currently not up to Codacy standards. While the transition to a source-extraction script improves long-term maintainability, the current implementation of the truncation logic (3-line limit) breaks documentation content, resulting in incomplete sentences and missing syntax across numerous pattern descriptions (e.g., B101, B113).

Furthermore, the new extract_docs_from_source.py script is a high-risk uncovered complex file with a cyclomatic complexity of 81. This script requires significant refactoring and the addition of unit tests to ensure the extraction process is reliable. Systemic issues regarding missing UTF-8 encoding in file operations and redundant docstring extraction in blacklist files should also be addressed before this PR is merged.

About this PR

• There is a systemic pattern of missing explicit UTF-8 encoding when performing file I/O operations in the extraction script, which can lead to character corruption or crashes in non-UTF-8 environments.
• No PR description was provided to explain the significant overhaul of the documentation logic, transitioning from HTML-based extraction to direct source-code parsing.

Test suggestions

• Verify that extract_docs_from_source.py correctly parses both single-pattern plugin files and multi-pattern blacklist files.
• Verify that the extraction script correctly maps Bandit internal severity strings (High/Medium/Low) to Codacy levels (Error/Warning/Info).
• Verify that the 3-line truncation logic in the extraction script does not result in broken sentences or syntax errors in the documentation.
• Implement automated unit test coverage for the extraction logic in scripts/extract_docs_from_source.py to mitigate risks associated with high cyclomatic complexity (81).

Prompt proposal for missing tests

Consider implementing these tests if applicable:
1. Verify that extract_docs_from_source.py correctly parses both single-pattern plugin files and multi-pattern blacklist files.
2. Verify that the extraction script correctly maps Bandit internal severity strings (High/Medium/Low) to Codacy levels (Error/Warning/Info).
3. Verify that the 3-line truncation logic in the extraction script does not result in broken sentences or syntax errors in the documentation.
4. Implement automated unit test coverage for the extraction logic in scripts/extract_docs_from_source.py to mitigate risks associated with high cyclomatic complexity (81).

_{TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback}