feat(rules): implement `flake8-bandit` `S201` (`flask_debug_true`) #7503

mkniewallner · 2023-09-19T00:03:00Z

Part of #1646.

Summary

Implement S201 (flask_debug_true) rule from bandit.

I am fairly new to Rust and Ruff's codebase, so there might be better ways to implement the rule or write the code.

Test Plan

Snapshot test from https://github.com/PyCQA/bandit/blob/1.7.5/examples/flask_debug.py, with a few additions in the "unrelated" part to test a bit more cases.

codspeed-hq · 2023-09-19T00:12:22Z

CodSpeed Performance Report

Merging #7503 will improve performances by 2.29%

_{Comparing mkniewallner:feat/add-flake8-bandit-S201 (7ed0354) with main (40f6456)}

Summary

⚡ 1 improvements
✅ 24 untouched benchmarks

Benchmarks breakdown

	Benchmark	`main`	`mkniewallner:feat/add-flake8-bandit-S201`	Change
⚡	`linter/all-rules[numpy/ctypeslib.py]`	35 ms	34.3 ms	+2.29%

github-actions · 2023-09-19T00:17:48Z

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

charliermarsh

Looks great! Just some minor stuff.

charliermarsh · 2023-09-19T00:19:11Z

crates/ruff/src/codes.rs

@@ -573,6 +573,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> {
        (Flake8Bandit, "110") => (RuleGroup::Unspecified, rules::flake8_bandit::rules::TryExceptPass),
        (Flake8Bandit, "112") => (RuleGroup::Unspecified, rules::flake8_bandit::rules::TryExceptContinue),
        (Flake8Bandit, "113") => (RuleGroup::Unspecified, rules::flake8_bandit::rules::RequestWithoutTimeout),
+        (Flake8Bandit, "201") => (RuleGroup::Unspecified, rules::flake8_bandit::rules::FlaskDebugTrue),


We're now in the habit of adding new rules under RuleGroup::Preview -- mind changing it here?

charliermarsh · 2023-09-19T00:19:34Z

crates/ruff/src/rules/flake8_bandit/rules/flask_debug_true.rs

+/// Checks for uses of `debug=True` in Flask.
+///
+/// ## Why is this bad?
+/// Enabling debug mode shows an interactive debugger in the browser if an error occurs, and allows


It's annoying, but we manually format these to fit 80 characters, since they sometimes get printed to the terminal.

charliermarsh · 2023-09-19T00:20:12Z

crates/ruff/src/rules/flake8_bandit/rules/flask_debug_true.rs

+        return;
+    }
+
+    if let Some(debug_argument) = call.arguments.find_keyword("debug") {


You can reduce one level of indentation by doing:

let Some(debug_argument) = call.arguments.find_keyword("debug") else { return; }; ...

charliermarsh · 2023-09-19T00:20:26Z

crates/ruff/src/rules/flake8_bandit/rules/flask_debug_true.rs

+            return;
+        }
+
+        if let Expr::Name(name) = value.as_ref() {


Same here: can use let-else to reduce indentation.

charliermarsh · 2023-09-19T00:21:06Z

crates/ruff/resources/test/fixtures/flake8_bandit/S201.py

+def main():
+    raise
+
+#bad


For whatever reason, the comment we typically use here is # Errors and then # OK (instead of #okay).

charliermarsh

Thanks!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://docs.astral.sh/ruff) ([source](https://togithub.com/astral-sh/ruff), [changelog](https://togithub.com/astral-sh/ruff/releases)) | `==0.0.290` -> `==0.0.291` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/ruff/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/ruff/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/ruff/0.0.290/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/ruff/0.0.290/0.0.291?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>astral-sh/ruff (ruff)</summary> ### [`v0.0.291`](https://togithub.com/astral-sh/ruff/releases/tag/v0.0.291) [Compare Source](https://togithub.com/astral-sh/ruff/compare/v0.0.290...v0.0.291)  #### What's Changed ##### Deprecations **The `format` command-line argument and configuration option has been renamed to `output-format`.** While Ruff will continue to respect `format` when passed as a command-line argument or configuration option, this backwards-compatible support will be dropped in a future release. See: [astral-sh/ruff#7514. ##### Rules - \[`flake8-bandit`] Implement `S201`: `flask-debug-true` by [@mkniewallner](https://togithub.com/mkniewallner) in [astral-sh/ruff#7503 - \[`flake8-bandit`] Implement `S507`: `ssh_no_host_key_verification` by [@mkniewallner](https://togithub.com/mkniewallner) in [astral-sh/ruff#7528 - \[`flake8-logging`] Implement `LOG002`: `invalid-get-logger-argument` by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#7399 - \[`flake8-logging`] Implement `LOG007`: `exception-without-exc-info` by [@qdegraaf](https://togithub.com/qdegraaf) in [astral-sh/ruff#7410 - \[`refurb`] Implement `FURB140`: `reimplemented-starmap` by [@SavchenkoValeriy](https://togithub.com/SavchenkoValeriy) in [astral-sh/ruff#7253 - \[`refurb`] Implement `FURB148`: `unnecessary-enumerate` by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#7454 - \[`ruff`] Detect `asyncio.get_running_loop` calls in RUF006 by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7562 ##### Settings - Show `--no-X` variants in CLI help by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7504 - Rename `format` option to `output-format` by [@MichaReiser](https://togithub.com/MichaReiser) in [astral-sh/ruff#7514 - Enable tab completion for `ruff rule` by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7560 ##### Bug Fixes - Add padding to prevent some autofix errors by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7461 - Remove parentheses when rewriting assert calls to statements by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7464 - Avoid flagging starred elements in C402 by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7466 - Extend `bad-dunder-method-name` to permit `attrs` dunders by [@tjkuson](https://togithub.com/tjkuson) in [astral-sh/ruff#7472 - Avoid N802 violations for [@overload](https://togithub.com/overload) methods by [@JonathanPlasse](https://togithub.com/JonathanPlasse) in [astral-sh/ruff#7498 - Avoid flagging starred expressions in UP007 by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7505 - Ensure that LOG007 only triggers on `.exception()` calls by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7524 - Use strict sorted and union for NoQA mapping insertion by [@dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#7531 - Avoid inserting imports directly after continuation by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7553 - Add padding in `PERF102` fixes by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7554 - Avoid invalid fix for parenthesized values in F601 by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7559 - Treat `os.error` as an `OSError` alias by [@charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#7582 - Extend `bad-dunder-method-name` to permit `__html__` by [@jaap3](https://togithub.com/jaap3) in [astral-sh/ruff#7492 - Fix stylist indentation with a formfeed by [@konstin](https://togithub.com/konstin) in [astral-sh/ruff#7489 #### New Contributors - [@MicaelJarniac](https://togithub.com/MicaelJarniac) made their first contribution in [astral-sh/ruff#5498 - [@maheshsaripalli9](https://togithub.com/maheshsaripalli9) made their first contribution in [astral-sh/ruff#7552 - [@T-256](https://togithub.com/T-256) made their first contribution in [astral-sh/ruff#7585 **Full Changelog**: astral-sh/ruff@v0.0.290...v0.0.291 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/allenporter/flux-local).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

feat(rules): implement flake8-bandit S201 (flask_debug_true)

2d23862

mkniewallner marked this pull request as ready for review September 19, 2023 00:17

charliermarsh reviewed Sep 19, 2023

View reviewed changes

charliermarsh added the rule Implementing or modifying a lint rule label Sep 19, 2023

mkniewallner added 3 commits September 19, 2023 02:24

feat(rules): move S201 to Preview

c074458

refactor(rules): use let-else

46355ee

test(rules): use consistent wording

7ed0354

charliermarsh approved these changes Sep 19, 2023

View reviewed changes

charliermarsh enabled auto-merge (squash) September 19, 2023 00:39

charliermarsh merged commit c6ba7df into astral-sh:main Sep 19, 2023
14 checks passed

mkniewallner deleted the feat/add-flake8-bandit-S201 branch September 19, 2023 00:53

chenrui333 mentioned this pull request Sep 22, 2023

ruff 0.0.291 Homebrew/homebrew-core#144913

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rules): implement `flake8-bandit` `S201` (`flask_debug_true`) #7503

feat(rules): implement `flake8-bandit` `S201` (`flask_debug_true`) #7503

mkniewallner commented Sep 19, 2023

codspeed-hq bot commented Sep 19, 2023 •

edited

github-actions bot commented Sep 19, 2023 •

edited

charliermarsh left a comment

charliermarsh Sep 19, 2023

charliermarsh Sep 19, 2023

charliermarsh Sep 19, 2023

charliermarsh Sep 19, 2023

charliermarsh Sep 19, 2023

charliermarsh left a comment

feat(rules): implement flake8-bandit S201 (flask_debug_true) #7503

feat(rules): implement flake8-bandit S201 (flask_debug_true) #7503

Conversation

mkniewallner commented Sep 19, 2023

Summary

Test Plan

codspeed-hq bot commented Sep 19, 2023 • edited

CodSpeed Performance Report

Merging #7503 will improve performances by 2.29%

Summary

Benchmarks breakdown

github-actions bot commented Sep 19, 2023 • edited

PR Check Results

Ecosystem

charliermarsh left a comment

Choose a reason for hiding this comment

charliermarsh Sep 19, 2023

Choose a reason for hiding this comment

charliermarsh Sep 19, 2023

Choose a reason for hiding this comment

charliermarsh Sep 19, 2023

Choose a reason for hiding this comment

charliermarsh Sep 19, 2023

Choose a reason for hiding this comment

charliermarsh Sep 19, 2023

Choose a reason for hiding this comment

charliermarsh left a comment

Choose a reason for hiding this comment

feat(rules): implement `flake8-bandit` `S201` (`flask_debug_true`) #7503

feat(rules): implement `flake8-bandit` `S201` (`flask_debug_true`) #7503

codspeed-hq bot commented Sep 19, 2023 •

edited

github-actions bot commented Sep 19, 2023 •

edited