-
Notifications
You must be signed in to change notification settings - Fork 897
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary Implement [`PLR1702`/`too-many-nested-blocks`](https://pylint.readthedocs.io/en/latest/user_guide/messages/refactor/too-many-nested-blocks.html) See: #970 ## Test Plan `cargo test`
- Loading branch information
1 parent
45628a5
commit dba2cb7
Showing
10 changed files
with
210 additions
and
0 deletions.
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
crates/ruff_linter/resources/test/fixtures/pylint/too_many_nested_blocks.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
def correct_fruits(fruits) -> bool: | ||
if len(fruits) > 1: # PLR1702 | ||
if "apple" in fruits: | ||
if "orange" in fruits: | ||
count = fruits["orange"] | ||
if count % 2: | ||
if "kiwi" in fruits: | ||
if count == 2: | ||
return True | ||
return False | ||
|
||
# Ok | ||
def correct_fruits(fruits) -> bool: | ||
if len(fruits) > 1: | ||
if "apple" in fruits: | ||
if "orange" in fruits: | ||
count = fruits["orange"] | ||
if count % 2: | ||
if "kiwi" in fruits: | ||
return True | ||
return False |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
crates/ruff_linter/src/rules/pylint/rules/too_many_nested_blocks.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
use ast::ExceptHandler; | ||
use ruff_diagnostics::{Diagnostic, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::{self as ast, Stmt}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// Checks for functions or methods with too many nested blocks. | ||
/// | ||
/// By default, this rule allows up to five nested blocks. | ||
/// This can be configured using the [`pylint.max-nested-blocks`] option. | ||
/// | ||
/// ## Why is this bad? | ||
/// Functions or methods with too many nested blocks are harder to understand | ||
/// and maintain. | ||
/// | ||
/// ## Options | ||
/// - `pylint.max-nested-blocks` | ||
#[violation] | ||
pub struct TooManyNestedBlocks { | ||
nested_blocks: usize, | ||
max_nested_blocks: usize, | ||
} | ||
|
||
impl Violation for TooManyNestedBlocks { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
let TooManyNestedBlocks { | ||
nested_blocks, | ||
max_nested_blocks, | ||
} = self; | ||
format!("Too many nested blocks ({nested_blocks} > {max_nested_blocks})") | ||
} | ||
} | ||
|
||
/// PLR1702 | ||
pub(crate) fn too_many_nested_blocks(checker: &mut Checker, stmt: &Stmt) { | ||
// Only enforce nesting within functions or methods. | ||
if !checker.semantic().current_scope().kind.is_function() { | ||
return; | ||
} | ||
|
||
// If the statement isn't a leaf node, we don't want to emit a diagnostic, since the diagnostic | ||
// will be emitted on the leaves. | ||
if has_nested_block(stmt) { | ||
return; | ||
} | ||
|
||
let max_nested_blocks = checker.settings.pylint.max_nested_blocks; | ||
|
||
// Traverse up the hierarchy, identifying the root node and counting the number of nested | ||
// blocks between the root and this leaf. | ||
let (count, root_id) = | ||
checker | ||
.semantic() | ||
.current_statement_ids() | ||
.fold((0, None), |(count, ancestor_id), id| { | ||
let stmt = checker.semantic().statement(id); | ||
if is_nested_block(stmt) { | ||
(count + 1, Some(id)) | ||
} else { | ||
(count, ancestor_id) | ||
} | ||
}); | ||
|
||
let Some(root_id) = root_id else { | ||
return; | ||
}; | ||
|
||
// If the number of nested blocks is less than the maximum, we don't want to emit a diagnostic. | ||
if count <= max_nested_blocks { | ||
return; | ||
} | ||
|
||
checker.diagnostics.push(Diagnostic::new( | ||
TooManyNestedBlocks { | ||
nested_blocks: count, | ||
max_nested_blocks, | ||
}, | ||
checker.semantic().statement(root_id).range(), | ||
)); | ||
} | ||
|
||
/// Returns `true` if the given statement is a nested block. | ||
fn is_nested_block(stmt: &Stmt) -> bool { | ||
matches!( | ||
stmt, | ||
Stmt::If(_) | Stmt::While(_) | Stmt::For(_) | Stmt::Try(_) | Stmt::With(_) | ||
) | ||
} | ||
|
||
/// Returns `true` if the given statement is a leaf node. | ||
fn has_nested_block(stmt: &Stmt) -> bool { | ||
match stmt { | ||
Stmt::If(ast::StmtIf { | ||
body, | ||
elif_else_clauses, | ||
.. | ||
}) => { | ||
body.iter().any(is_nested_block) | ||
|| elif_else_clauses | ||
.iter() | ||
.any(|elif_else| elif_else.body.iter().any(is_nested_block)) | ||
} | ||
Stmt::While(ast::StmtWhile { body, orelse, .. }) => { | ||
body.iter().any(is_nested_block) || orelse.iter().any(is_nested_block) | ||
} | ||
Stmt::For(ast::StmtFor { body, orelse, .. }) => { | ||
body.iter().any(is_nested_block) || orelse.iter().any(is_nested_block) | ||
} | ||
Stmt::Try(ast::StmtTry { | ||
body, | ||
handlers, | ||
orelse, | ||
finalbody, | ||
.. | ||
}) => { | ||
body.iter().any(is_nested_block) | ||
|| handlers.iter().any(|handler| match handler { | ||
ExceptHandler::ExceptHandler(ast::ExceptHandlerExceptHandler { | ||
body, .. | ||
}) => body.iter().any(is_nested_block), | ||
}) | ||
|| orelse.iter().any(is_nested_block) | ||
|| finalbody.iter().any(is_nested_block) | ||
} | ||
Stmt::With(ast::StmtWith { body, .. }) => body.iter().any(is_nested_block), | ||
_ => false, | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
...ylint/snapshots/ruff_linter__rules__pylint__tests__PLR1702_too_many_nested_blocks.py.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/pylint/mod.rs | ||
--- | ||
too_many_nested_blocks.py:2:5: PLR1702 Too many nested blocks (6 > 5) | ||
| | ||
1 | def correct_fruits(fruits) -> bool: | ||
2 | if len(fruits) > 1: # PLR1702 | ||
| _____^ | ||
3 | | if "apple" in fruits: | ||
4 | | if "orange" in fruits: | ||
5 | | count = fruits["orange"] | ||
6 | | if count % 2: | ||
7 | | if "kiwi" in fruits: | ||
8 | | if count == 2: | ||
9 | | return True | ||
| |_______________________________________^ PLR1702 | ||
10 | return False | ||
| | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.