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.

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

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

Merged

Conversation

ottaviohartman
Copy link
Contributor

@ottaviohartman ottaviohartman commented Feb 20, 2024

Summary

Closes #10031

Test Plan

Unit tested and tested with

cargo run -p ruff -- check crates/ruff_linter/resources/test/fixtures/eradicate/ERA001.py --no-cache --preview --select ERA001

TODO:

  • cargo insta test

@@ -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

Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

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

Thanks!

@@ -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

@ottaviohartman ottaviohartman Feb 20, 2024

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

@ottaviohartman ottaviohartman Feb 20, 2024

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!)

@ottaviohartman ottaviohartman changed the title fix(ERA001): detect commented out case statements fix(ERA001): detect commented out case statements, add more one-line support Feb 20, 2024
@charliermarsh charliermarsh merged commit 0d363ab into astral-sh:main Feb 20, 2024
16 of 17 checks passed
@charliermarsh
Copy link
Member

Thank you!

nkxxll pushed a commit to nkxxll/ruff that referenced this pull request Mar 10, 2024
…e support (astral-sh#10055)

## Summary

Closes astral-sh#10031 

- Detect commented out `case` statements. Playground repro:
https://play.ruff.rs/5a305aa9-6e5c-4fa4-999a-8fc427ab9a23
- Add more support for one-line commented out code.

## Test Plan

Unit tested and tested with
```sh
cargo run -p ruff -- check crates/ruff_linter/resources/test/fixtures/eradicate/ERA001.py --no-cache --preview --select ERA001
```

TODO:
- [x] `cargo insta test`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ERA001 does not detect commented out case statements
2 participants