language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-30 13:51:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Support isort: skip_file directive (#1075)

Browse source
This commit is contained in:
Charlie Marsh 2022-12-05 15:02:01 -05:00 • committed by GitHub
parent e01e45ca35
commit c69c4fd655
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

47
src/directives.rs
View file

@ -75,17 +75,26 @@ pub fn extract_noqa_line_for(lxr: &[LexResult]) -> IntMap<usize, usize> {
/// Extract a set of lines over which to disable isort. /// Extract a set of lines over which to disable isort.
pub fn extract_isort_exclusions(lxr: &[LexResult], locator: &SourceCodeLocator) -> IntSet<usize> { pub fn extract_isort_exclusions(lxr: &[LexResult], locator: &SourceCodeLocator) -> IntSet<usize> {
let mut exclusions: IntSet<usize> = IntSet::default(); let mut exclusions: IntSet<usize> = IntSet::default();
let mut skip_file: bool = false;
let mut off: Option<Location> = None; let mut off: Option<Location> = None;
let mut last: Option<Location> = None; let mut last: Option<Location> = None;
for &(start, ref tok, end) in lxr.iter().flatten() { for &(start, ref tok, end) in lxr.iter().flatten() {
last = Some(end); last = Some(end);
// No need to keep processing, but we do need to determine the last token.
if skip_file {
continue;
}
if matches!(tok, Tok::Comment) { if matches!(tok, Tok::Comment) {
// TODO(charlie): Modify RustPython to include the comment text in the token. // TODO(charlie): Modify RustPython to include the comment text in the token.
let comment_text = locator.slice_source_code_range(&Range { let comment_text = locator.slice_source_code_range(&Range {
location: start, location: start,
end_location: end, end_location: end,
}); });
if off.is_some() { if comment_text == "# isort: skip_file" {
skip_file = true;
} else if off.is_some() {
if comment_text == "# isort: on" { if comment_text == "# isort: on" {
if let Some(start) = off { if let Some(start) = off {
for row in start.row() + 1..=end.row() { for row in start.row() + 1..=end.row() {
@ -95,7 +104,7 @@ pub fn extract_isort_exclusions(lxr: &[LexResult], locator: &SourceCodeLocator)
off = None; off = None;
} }
} else { } else {
if comment_text.contains("isort: skip") || comment_text.contains("isort:skip") { if comment_text.contains("isort: skip") {
exclusions.insert(start.row()); exclusions.insert(start.row());
} else if comment_text == "# isort: off" { } else if comment_text == "# isort: off" {
off = Some(start); off = Some(start);
@ -103,7 +112,15 @@ pub fn extract_isort_exclusions(lxr: &[LexResult], locator: &SourceCodeLocator)
} }
} }
} }
if let Some(start) = off { if skip_file {
// Enforce `isort: skip_file`.
if let Some(end) = last {
for row in 1..=end.row() {
exclusions.insert(row);
}
}
} else if let Some(start) = off {
// Enforce unterminated `isort: off`.
if let Some(end) = last { if let Some(end) = last {
for row in start.row() + 1..=end.row() { for row in start.row() + 1..=end.row() {
exclusions.insert(row); exclusions.insert(row);
@ -247,5 +264,29 @@ z = x + 1";
extract_isort_exclusions(&lxr, &locator), extract_isort_exclusions(&lxr, &locator),
IntSet::from_iter([2, 3, 4]) IntSet::from_iter([2, 3, 4])
); );
let contents = "# isort: skip_file
x = 1
y = 2
z = x + 1";
let lxr: Vec<LexResult> = lexer::make_tokenizer(contents).collect();
let locator = SourceCodeLocator::new(contents);
assert_eq!(
extract_isort_exclusions(&lxr, &locator),
IntSet::from_iter([1, 2, 3, 4])
);
let contents = "# isort: off
x = 1
# isort: on
y = 2
# isort: skip_file
z = x + 1";
let lxr: Vec<LexResult> = lexer::make_tokenizer(contents).collect();
let locator = SourceCodeLocator::new(contents);
assert_eq!(
extract_isort_exclusions(&lxr, &locator),
IntSet::from_iter([1, 2, 3, 4, 5, 6])
);
} }
} }