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

Use value > max style in pylint and mccabe messages #3553

Merged
merged 2 commits into from
Mar 16, 2023
Merged

Use value > max style in pylint and mccabe messages #3553

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7dc22b2
[mccabe] Add `max-complexity` to message
edgarrmondragon Mar 16, 2023
e17a361
Update style in pylint messages
edgarrmondragon Mar 16, 2023
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
10 changes: 8 additions & 2 deletions crates/ruff/src/rules/mccabe/rules.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,18 @@ use ruff_python_ast::source_code::Locator;
pub struct ComplexStructure {
pub name: String,
pub complexity: usize,
pub max_complexity: usize,
}

impl Violation for ComplexStructure {
#[derive_message_formats]
fn message(&self) -> String {
let ComplexStructure { name, complexity } = self;
format!("`{name}` is too complex ({complexity})")
let ComplexStructure {
name,
complexity,
max_complexity,
} = self;
format!("`{name}` is too complex ({complexity} > {max_complexity})")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mind changing those Pylint messages too, like too_many_branches, to use this style?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done (e17a361) and updated the title too

}
}

Expand Down Expand Up @@ -135,6 +140,7 @@ pub fn function_is_too_complex(
ComplexStructure {
name: name.to_string(),
complexity,
max_complexity,
},
identifier_range(stmt, locator),
))
Expand Down
44 changes: 22 additions & 22 deletions crates/ruff/src/rules/mccabe/snapshots/ruff__rules__mccabe__tests__max_complexity_0.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ expression: diagnostics
---
- kind:
name: ComplexStructure
body: "`trivial` is too complex (1)"
body: "`trivial` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -17,7 +17,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`expr_as_statement` is too complex (1)"
body: "`expr_as_statement` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -30,7 +30,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`sequential` is too complex (1)"
body: "`sequential` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -43,7 +43,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`if_elif_else_dead_path` is too complex (3)"
body: "`if_elif_else_dead_path` is too complex (3 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -56,7 +56,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`nested_ifs` is too complex (3)"
body: "`nested_ifs` is too complex (3 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -69,7 +69,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`for_loop` is too complex (2)"
body: "`for_loop` is too complex (2 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -82,7 +82,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`for_else` is too complex (2)"
body: "`for_else` is too complex (2 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -95,7 +95,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`recursive` is too complex (2)"
body: "`recursive` is too complex (2 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -108,7 +108,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`nested_functions` is too complex (3)"
body: "`nested_functions` is too complex (3 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -121,7 +121,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`a` is too complex (2)"
body: "`a` is too complex (2 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -134,7 +134,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`b` is too complex (1)"
body: "`b` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -147,7 +147,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`try_else` is too complex (4)"
body: "`try_else` is too complex (4 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -160,7 +160,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`nested_try_finally` is too complex (1)"
body: "`nested_try_finally` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -173,7 +173,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`foobar` is too complex (3)"
body: "`foobar` is too complex (3 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -186,7 +186,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`annotated_assign` is too complex (1)"
body: "`annotated_assign` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -199,7 +199,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`handle` is too complex (9)"
body: "`handle` is too complex (9 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -212,7 +212,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`a` is too complex (1)"
body: "`a` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -225,7 +225,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`b` is too complex (2)"
body: "`b` is too complex (2 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -238,7 +238,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`c` is too complex (1)"
body: "`c` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -251,7 +251,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`error` is too complex (1)"
body: "`error` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -264,7 +264,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`info` is too complex (1)"
body: "`info` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand All @@ -277,7 +277,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`exception` is too complex (1)"
body: "`exception` is too complex (1 > 0)"
suggestion: ~
fixable: false
location:
Expand Down
4 changes: 2 additions & 2 deletions crates/ruff/src/rules/mccabe/snapshots/ruff__rules__mccabe__tests__max_complexity_3.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ expression: diagnostics
---
- kind:
name: ComplexStructure
body: "`try_else` is too complex (4)"
body: "`try_else` is too complex (4 > 3)"
suggestion: ~
fixable: false
location:
Expand All @@ -17,7 +17,7 @@ expression: diagnostics
parent: ~
- kind:
name: ComplexStructure
body: "`handle` is too complex (9)"
body: "`handle` is too complex (9 > 3)"
suggestion: ~
fixable: false
location:
Expand Down