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

Avoid removing un-selected codes when applying --add-noqa edits #2465

Merged
merged 1 commit into from
Feb 2, 2023
Merged

Avoid removing un-selected codes when applying --add-noqa edits #2465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/linter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,6 @@ pub fn add_noqa_to_path(path: &Path, settings: &Settings) -> Result<usize> {
&contents,
indexer.commented_lines(),
&directives.noqa_line_for,
&settings.external,
stylist.line_ending(),
)
}
Expand Down
78 changes: 38 additions & 40 deletions src/noqa.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ use rustc_hash::{FxHashMap, FxHashSet};

use crate::registry::{Diagnostic, Rule};
use crate::rule_redirects::get_redirect_target;
use crate::settings::hashable::HashableHashSet;
use crate::source_code::LineEnding;

static NOQA_LINE_REGEX: Lazy<Regex> = Lazy::new(|| {
Expand Down Expand Up @@ -83,15 +82,13 @@ pub fn add_noqa(
contents: &str,
commented_lines: &[usize],
noqa_line_for: &IntMap<usize, usize>,
external: &HashableHashSet<String>,
line_ending: &LineEnding,
) -> Result<usize> {
let (count, output) = add_noqa_inner(
diagnostics,
contents,
commented_lines,
noqa_line_for,
external,
line_ending,
);
fs::write(path, output)?;
Expand All @@ -103,7 +100,6 @@ fn add_noqa_inner(
contents: &str,
commented_lines: &[usize],
noqa_line_for: &IntMap<usize, usize>,
external: &HashableHashSet<String>,
line_ending: &LineEnding,
) -> (usize, String) {
let mut matches_by_line: FxHashMap<usize, FxHashSet<&Rule>> = FxHashMap::default();
Expand All @@ -114,11 +110,35 @@ fn add_noqa_inner(
return (0, contents.to_string());
}

// Grab the noqa (logical) line number for the current (physical) line.
let noqa_lineno = noqa_line_for.get(&(lineno + 1)).unwrap_or(&(lineno + 1)) - 1;

let mut codes: FxHashSet<&Rule> = FxHashSet::default();
for diagnostic in diagnostics {
// Is the violation ignored by a `noqa` directive on the parent line?
if let Some(parent_lineno) = diagnostic.parent.map(|location| location.row()) {
let noqa_lineno = noqa_line_for.get(&parent_lineno).unwrap_or(&parent_lineno);
if diagnostic.location.row() == lineno + 1 {
// Is the violation ignored by a `noqa` directive on the parent line?
if let Some(parent_lineno) = diagnostic.parent.map(|location| location.row()) {
let noqa_lineno = noqa_line_for.get(&parent_lineno).unwrap_or(&parent_lineno);
if commented_lines.contains(noqa_lineno) {
match extract_noqa_directive(lines[noqa_lineno - 1]) {
Directive::All(..) => {
continue;
}
Directive::Codes(.., codes) => {
if includes(diagnostic.kind.rule(), &codes) {
continue;
}
}
Directive::None => {}
}
}
}

// Is the diagnostic ignored by a `noqa` directive on the same line?
let diagnostic_lineno = diagnostic.location.row();
let noqa_lineno = noqa_line_for
.get(&diagnostic_lineno)
.unwrap_or(&diagnostic_lineno);
if commented_lines.contains(noqa_lineno) {
match extract_noqa_directive(lines[noqa_lineno - 1]) {
Directive::All(..) => {
Expand All @@ -132,16 +152,12 @@ fn add_noqa_inner(
Directive::None => {}
}
}
}

if diagnostic.location.row() == lineno + 1 {
// The diagnostic is not ignored by any `noqa` directive; add it to the list.
codes.insert(diagnostic.kind.rule());
}
}

// Grab the noqa (logical) line number for the current (physical) line.
let noqa_lineno = noqa_line_for.get(&(lineno + 1)).unwrap_or(&(lineno + 1)) - 1;

if !codes.is_empty() {
matches_by_line
.entry(noqa_lineno)
Expand Down Expand Up @@ -174,22 +190,13 @@ fn add_noqa_inner(
output.push_str(line_ending);
count += 1;
}
Directive::All(_, start, _) => {
// Add existing content.
output.push_str(line[..start].trim_end());

// Add `noqa` directive.
output.push_str(" # noqa: ");

// Add codes.
let codes: Vec<&str> =
rules.iter().map(|r| r.code()).sorted_unstable().collect();
let suffix = codes.join(", ");
output.push_str(&suffix);
Directive::All(..) => {
// Leave the line as-is.
output.push_str(line);
output.push_str(line_ending);
count += 1;
}
Directive::Codes(_, start_byte, _, existing) => {
println!("existing: {:?}", existing);
// Reconstruct the line based on the preserved rule codes.
// This enables us to tally the number of edits.
let mut formatted = String::with_capacity(line.len());
Expand All @@ -204,7 +211,7 @@ fn add_noqa_inner(
let codes: Vec<&str> = rules
.iter()
.map(|r| r.code())
.chain(existing.into_iter().filter(|code| external.contains(*code)))
.chain(existing.into_iter())
.sorted_unstable()
.collect();
let suffix = codes.join(", ");
Expand Down Expand Up @@ -235,7 +242,6 @@ mod tests {
use crate::noqa::{add_noqa_inner, NOQA_LINE_REGEX};
use crate::registry::Diagnostic;
use crate::rules::pycodestyle::rules::AmbiguousVariableName;
use crate::settings::hashable::HashableHashSet;
use crate::source_code::LineEnding;
use crate::violations;

Expand All @@ -259,13 +265,11 @@ mod tests {
let contents = "x = 1";
let commented_lines = vec![];
let noqa_line_for = IntMap::default();
let external = HashableHashSet::default();
let (count, output) = add_noqa_inner(
&diagnostics,
contents,
&commented_lines,
&noqa_line_for,
&external,
&LineEnding::Lf,
);
assert_eq!(count, 0);
Expand All @@ -278,15 +282,13 @@ mod tests {
Range::new(Location::new(1, 0), Location::new(1, 0)),
)];
let contents = "x = 1";
let commented_lines = vec![];
let commented_lines = vec![1];
let noqa_line_for = IntMap::default();
let external = HashableHashSet::default();
let (count, output) = add_noqa_inner(
&diagnostics,
contents,
&commented_lines,
&noqa_line_for,
&external,
&LineEnding::Lf,
);
assert_eq!(count, 1);
Expand All @@ -305,15 +307,13 @@ mod tests {
),
];
let contents = "x = 1 # noqa: E741\n";
let commented_lines = vec![];
let commented_lines = vec![1];
let noqa_line_for = IntMap::default();
let external = HashableHashSet::default();
let (count, output) = add_noqa_inner(
&diagnostics,
contents,
&commented_lines,
&noqa_line_for,
&external,
&LineEnding::Lf,
);
assert_eq!(count, 1);
Expand All @@ -332,18 +332,16 @@ mod tests {
),
];
let contents = "x = 1 # noqa";
let commented_lines = vec![];
let commented_lines = vec![1];
let noqa_line_for = IntMap::default();
let external = HashableHashSet::default();
let (count, output) = add_noqa_inner(
&diagnostics,
contents,
&commented_lines,
&noqa_line_for,
&external,
&LineEnding::Lf,
);
assert_eq!(count, 1);
assert_eq!(output, "x = 1 # noqa: E741, F841\n");
assert_eq!(count, 0);
assert_eq!(output, "x = 1 # noqa\n");
}
}