-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary Part of #970. This adds Pylint's [R0244 empty_comment](https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/empty-comment.html) lint as well as an always-safe fix. ## Test Plan The included snapshot verifies the following: - A line containing only a non-empty comment is not changed - A line containing leading whitespace before a non-empty comment is not changed - A line containing only an empty comment has its content deleted - A line containing only leading whitespace before an empty comment has its content deleted - A line containing only leading and trailing whitespace on an empty comment has its content deleted - A line containing trailing whitespace after a non-empty comment is not changed - A line containing only a single newline character (i.e. a blank line) is not changed - A line containing code followed by a non-empty comment is not changed - A line containing code followed by an empty comment has its content deleted after the last non-whitespace character - Lines containing code and no comments are not changed - Empty comment lines within block comments are ignored - Empty comments within triple-quoted sections are ignored ## Comparison to Pylint Running Ruff and Pylint 3.0.3 with Python 3.12.0 against the `empty_comment.py` file added in this PR, we see the following: * Identical behavior: * empty_comment.py:3:0: R2044: Line with empty comment (empty-comment) * empty_comment.py:4:0: R2044: Line with empty comment (empty-comment) * empty_comment.py:5:0: R2044: Line with empty comment (empty-comment) * empty_comment.py:18:0: R2044: Line with empty comment (empty-comment) * Differing behavior: * Pylint doesn't ignore empty comments in block comments commonly used for visual spacing; I decided these were fine in this implementation since many projects use these and likely do not want them removed. * empty_comment.py:28:0: R2044: Line with empty comment (empty-comment) * Pylint detects "empty comments" within the triple-quoted section at the bottom of the file, which is arguably a bug in the Pylint implementation since these are not truly comments. These are ignored by this implementation. * empty_comment.py:37:0: R2044: Line with empty comment (empty-comment) * empty_comment.py:38:0: R2044: Line with empty comment (empty-comment) * empty_comment.py:39:0: R2044: Line with empty comment (empty-comment)
- Loading branch information
Showing
13 changed files
with
581 additions
and
1 deletion.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
53 changes: 53 additions & 0 deletions
53
crates/ruff_linter/resources/test/fixtures/pylint/empty_comment.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,53 @@ | ||
# this line has a non-empty comment and is OK | ||
# this line is also OK, but the three following lines are not | ||
# | ||
# | ||
# | ||
|
||
# this non-empty comment has trailing whitespace and is OK | ||
|
||
# Many codebases use multiple `#` characters on a single line to visually | ||
# separate sections of code, so we don't consider these empty comments. | ||
|
||
########################################## | ||
|
||
# trailing `#` characters are not considered empty comments ### | ||
|
||
|
||
def foo(): # this comment is OK, the one below is not | ||
pass # | ||
|
||
|
||
# the lines below have no comments and are OK | ||
def bar(): | ||
pass | ||
|
||
|
||
# "Empty comments" are common in block comments | ||
# to add legibility. For example: | ||
# | ||
# The above line's "empty comment" is likely | ||
# intentional and is considered OK. | ||
|
||
|
||
# lines in multi-line strings/comments whose last non-whitespace character is a `#` | ||
# do not count as empty comments | ||
""" | ||
The following lines are all fine: | ||
# | ||
# | ||
# | ||
""" | ||
|
||
# These should be removed, despite being an empty "block comment". | ||
|
||
# | ||
# | ||
|
||
# These should also be removed. | ||
|
||
x = 1 | ||
|
||
# | ||
## | ||
# |
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
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
106 changes: 106 additions & 0 deletions
106
crates/ruff_linter/src/rules/pylint/rules/empty_comment.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,106 @@ | ||
use ruff_diagnostics::{Diagnostic, Edit, Fix, FixAvailability, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_index::Indexer; | ||
use ruff_python_trivia::is_python_whitespace; | ||
|
||
use ruff_source_file::Locator; | ||
use ruff_text_size::{TextRange, TextSize}; | ||
use rustc_hash::FxHashSet; | ||
|
||
/// ## What it does | ||
/// Checks for a # symbol appearing on a line not followed by an actual comment. | ||
/// | ||
/// ## Why is this bad? | ||
/// Empty comments don't provide any clarity to the code, and just add clutter. | ||
/// Either add a comment or delete the empty comment. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// class Foo: # | ||
/// pass | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// class Foo: | ||
/// pass | ||
/// ``` | ||
/// | ||
/// ## References | ||
/// - [Pylint documentation](https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/empty-comment.html) | ||
#[violation] | ||
pub struct EmptyComment; | ||
|
||
impl Violation for EmptyComment { | ||
const FIX_AVAILABILITY: FixAvailability = FixAvailability::Always; | ||
|
||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("Line with empty comment") | ||
} | ||
|
||
fn fix_title(&self) -> Option<String> { | ||
Some(format!("Delete the empty comment")) | ||
} | ||
} | ||
|
||
/// PLR2044 | ||
pub(crate) fn empty_comments( | ||
diagnostics: &mut Vec<Diagnostic>, | ||
indexer: &Indexer, | ||
locator: &Locator, | ||
) { | ||
let block_comments = FxHashSet::from_iter(indexer.comment_ranges().block_comments(locator)); | ||
|
||
for range in indexer.comment_ranges() { | ||
// Ignore comments that are part of multi-line "comment blocks". | ||
if block_comments.contains(&range.start()) { | ||
continue; | ||
} | ||
|
||
// If the line contains an empty comment, add a diagnostic. | ||
if let Some(diagnostic) = empty_comment(*range, locator) { | ||
diagnostics.push(diagnostic); | ||
} | ||
} | ||
} | ||
|
||
/// Return a [`Diagnostic`] if the comment at the given [`TextRange`] is empty. | ||
fn empty_comment(range: TextRange, locator: &Locator) -> Option<Diagnostic> { | ||
// Check: is the comment empty? | ||
if !locator | ||
.slice(range) | ||
.chars() | ||
.skip(1) | ||
.all(is_python_whitespace) | ||
{ | ||
return None; | ||
} | ||
|
||
// Find the location of the `#`. | ||
let first_hash_col = range.start(); | ||
|
||
// Find the start of the line. | ||
let line = locator.line_range(first_hash_col); | ||
|
||
// Find the last character in the line that precedes the comment, if any. | ||
let deletion_start_col = locator | ||
.slice(TextRange::new(line.start(), first_hash_col)) | ||
.char_indices() | ||
.rev() | ||
.find(|&(_, c)| !is_python_whitespace(c) && c != '#') | ||
.map(|(last_non_whitespace_non_comment_col, _)| { | ||
// SAFETY: (last_non_whitespace_non_comment_col + 1) <= first_hash_col | ||
TextSize::try_from(last_non_whitespace_non_comment_col).unwrap() + TextSize::new(1) | ||
}); | ||
|
||
Some( | ||
Diagnostic::new(EmptyComment, TextRange::new(first_hash_col, line.end())).with_fix( | ||
Fix::safe_edit(if let Some(deletion_start_col) = deletion_start_col { | ||
Edit::deletion(line.start() + deletion_start_col, line.end()) | ||
} else { | ||
Edit::range_deletion(locator.full_line_range(first_hash_col)) | ||
}), | ||
), | ||
) | ||
} |
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
118 changes: 118 additions & 0 deletions
118
...c/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR2044_empty_comment.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,118 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/pylint/mod.rs | ||
--- | ||
empty_comment.py:3:1: PLR2044 [*] Line with empty comment | ||
| | ||
1 | # this line has a non-empty comment and is OK | ||
2 | # this line is also OK, but the three following lines are not | ||
3 | # | ||
| ^ PLR2044 | ||
4 | # | ||
5 | # | ||
| | ||
= help: Delete the empty comment | ||
|
||
ℹ Safe fix | ||
1 1 | # this line has a non-empty comment and is OK | ||
2 2 | # this line is also OK, but the three following lines are not | ||
3 |-# | ||
4 3 | # | ||
5 4 | # | ||
6 5 | | ||
|
||
empty_comment.py:4:5: PLR2044 [*] Line with empty comment | ||
| | ||
2 | # this line is also OK, but the three following lines are not | ||
3 | # | ||
4 | # | ||
| ^ PLR2044 | ||
5 | # | ||
| | ||
= help: Delete the empty comment | ||
|
||
ℹ Safe fix | ||
1 1 | # this line has a non-empty comment and is OK | ||
2 2 | # this line is also OK, but the three following lines are not | ||
3 3 | # | ||
4 |- # | ||
5 4 | # | ||
6 5 | | ||
7 6 | # this non-empty comment has trailing whitespace and is OK | ||
|
||
empty_comment.py:5:9: PLR2044 [*] Line with empty comment | ||
| | ||
3 | # | ||
4 | # | ||
5 | # | ||
| ^ PLR2044 | ||
6 | | ||
7 | # this non-empty comment has trailing whitespace and is OK | ||
| | ||
= help: Delete the empty comment | ||
|
||
ℹ Safe fix | ||
2 2 | # this line is also OK, but the three following lines are not | ||
3 3 | # | ||
4 4 | # | ||
5 |- # | ||
6 5 | | ||
7 6 | # this non-empty comment has trailing whitespace and is OK | ||
8 7 | | ||
|
||
empty_comment.py:18:11: PLR2044 [*] Line with empty comment | ||
| | ||
17 | def foo(): # this comment is OK, the one below is not | ||
18 | pass # | ||
| ^ PLR2044 | ||
| | ||
= help: Delete the empty comment | ||
|
||
ℹ Safe fix | ||
15 15 | | ||
16 16 | | ||
17 17 | def foo(): # this comment is OK, the one below is not | ||
18 |- pass # | ||
18 |+ pass | ||
19 19 | | ||
20 20 | | ||
21 21 | # the lines below have no comments and are OK | ||
|
||
empty_comment.py:44:1: PLR2044 [*] Line with empty comment | ||
| | ||
42 | # These should be removed, despite being an empty "block comment". | ||
43 | | ||
44 | # | ||
| ^ PLR2044 | ||
45 | # | ||
| | ||
= help: Delete the empty comment | ||
|
||
ℹ Safe fix | ||
42 42 | # These should be removed, despite being an empty "block comment". | ||
43 43 | | ||
44 44 | # | ||
45 |-# | ||
46 45 | | ||
47 46 | # These should also be removed. | ||
48 47 | | ||
|
||
empty_comment.py:45:1: PLR2044 [*] Line with empty comment | ||
| | ||
44 | # | ||
45 | # | ||
| ^ PLR2044 | ||
46 | | ||
47 | # These should also be removed. | ||
| | ||
= help: Delete the empty comment | ||
|
||
ℹ Safe fix | ||
42 42 | # These should be removed, despite being an empty "block comment". | ||
43 43 | | ||
44 44 | # | ||
45 |-# | ||
46 45 | | ||
47 46 | # These should also be removed. | ||
48 47 | | ||
|
||
|
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
Oops, something went wrong.