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

fix(ERA001): detect commented out case statements, add more one-line support #10055

Merged
merged 5 commits into from Feb 20, 2024
Merged

fix(ERA001): detect commented out case statements, add more one-line support #10055

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
28160b2
add case: to ERA
ottaviohartman Feb 20, 2024
20950cf
add to ERA001.py
ottaviohartman Feb 20, 2024
2ec5573
add one-line tests and insta
ottaviohartman Feb 20, 2024
4e1d2bf
remove one-line
ottaviohartman Feb 20, 2024
babbe5a
fix
ottaviohartman Feb 20, 2024
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
3 changes: 3 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/eradicate/ERA001.py
View file
Open in desktop
Expand Up @@ -28,3 +28,6 @@ class A():
}

#import os # noqa

# case 1:
# case "foo": print()
6 changes: 5 additions & 1 deletion crates/ruff_linter/src/rules/eradicate/detection.rs
View file
Open in desktop
Expand Up @@ -26,7 +26,7 @@ static HASH_NUMBER: Lazy<Regex> = Lazy::new(|| Regex::new(r"#\d").unwrap());
static POSITIVE_CASES: Lazy<RegexSet> = Lazy::new(|| {
RegexSet::new([
// Keywords
r"^(?:elif\s+.*\s*:|else\s*:|try\s*:|finally\s*:|except\s+.*\s*:)$",
r"^(?:elif\s+.*\s*:|else\s*:|try\s*:|finally\s*:|except\s+.*\s*:|case\s+.*\s*:.*)$",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

note: this group ends with .* to detect the one-line case:

case "hi": print()

Copy link
Member

Choose a reason for hiding this comment

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

I feel like the other cases don't catch that -- can you try to add a test case with try followed by a one-line body?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep - I think this will catch more non-code statements though like "to try: use iterators" or something. I'll write some tests to see

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok seems to work well, should I add .* for all of the cases, and add tests?

Copy link
Member

Choose a reason for hiding this comment

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

Let's remove the trailing .* from this PR, and we can open a separate PR to add .* to all of the cases. It'll make it easier to approve and merge these as separate changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cool will do

Copy link
Member

Choose a reason for hiding this comment

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

Ah sorry, I meant the opposite: can we remove the .* from here, so that we don't support one-line for any of the patterns (like before this PR), and then open a separate PR that adds the .* to all of them at once?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, that's what I understood you to mean! I'll do that and open an issue to add .* in another PR

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! Ticket opened, I'll open that PR next.

Copy link
Member

Choose a reason for hiding this comment

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

Yep, that's what I understood you to mean! I'll do that and open an issue to add .* in another PR

(Oops, sorry, I think I was looking at the code, and thought you'd already pushed!)

// Partial dictionary
r#"^['"]\w+['"]\s*:.+[,{]\s*(#.*)?$"#,
// Multiline assignment
Expand Down Expand Up @@ -155,11 +155,15 @@ mod tests {
assert!(comment_contains_code("#elif True:", &[]));
assert!(comment_contains_code("#x = foo(", &[]));
assert!(comment_contains_code("#except Exception:", &[]));
assert!(comment_contains_code("# case 1:", &[]));
assert!(comment_contains_code("#case 1:", &[]));
assert!(comment_contains_code("#case 1: print()", &[]));

assert!(!comment_contains_code("# this is = to that :(", &[]));
assert!(!comment_contains_code("#else", &[]));
assert!(!comment_contains_code("#or else:", &[]));
assert!(!comment_contains_code("#else True:", &[]));
assert!(!comment_contains_code("# in that case:", &[]));

// Unpacking assignments
assert!(comment_contains_code(
Expand Down
3 changes: 2 additions & 1 deletion crates/ruff_linter/src/rules/eradicate/rules/commented_out_code.rs
View file
Open in desktop
Expand Up @@ -47,7 +47,8 @@ fn is_standalone_comment(line: &str) -> bool {
for char in line.chars() {
if char == '#' {
return true;
} else if !char.is_whitespace() {
}
if !char.is_whitespace() {
Copy link
Member

Choose a reason for hiding this comment

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

Was this change intentional? Just checking.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, but I can revert! Just was a style lint in VSCode

return false;
}
}
Expand Down