Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Normalize treatment of aliased and unaliased imports (#3216)

This commit is contained in:
Charlie Marsh 2023-02-24 17:11:03 -05:00 committed by GitHub
parent 1c01b3c934
commit 42f61535b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 111 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
crates/ruff/resources/test/fixtures/isort/as_imports_comments.py vendored Normal file
View File

@ -0,0 +1,15 @@
from foo import ( # Comment on `foo`
Member as Alias, # Comment on `Alias`
)
from bar import ( # Comment on `bar`
Member, # Comment on `Member`
)
from baz import ( # Comment on `baz`
Member as Alias # Comment on `Alias`
)
from bop import ( # Comment on `bop`
Member # Comment on `Member`
)

4
crates/ruff/src/rules/isort/categorize.rs
View File

@ -154,7 +154,7 @@ pub fn categorize_imports<'a>(
.insert(import_from, aliases);
}
// Categorize `StmtKind::ImportFrom` (with re-export).
for ((import_from, alias), comments) in block.import_from_as {
for ((import_from, alias), aliases) in block.import_from_as {
let classification = categorize(
&import_from.module_base(),
import_from.level,
@ -170,7 +170,7 @@ pub fn categorize_imports<'a>(
.entry(classification)
.or_default()
.import_from_as
.insert((import_from, alias), comments);
.insert((import_from, alias), aliases);
}
// Categorize `StmtKind::ImportFrom` (with star).
for (import_from, comments) in block.import_from_star {

1
crates/ruff/src/rules/isort/mod.rs
View File

@ -358,6 +358,7 @@ mod tests {
use crate::test::{test_path, test_resource_path};
#[test_case(Path::new("add_newline_before_comments.py"))]
#[test_case(Path::new("as_imports_comments.py"))]
#[test_case(Path::new("combine_as_imports.py"))]
#[test_case(Path::new("combine_import_from.py"))]
#[test_case(Path::new("comments.py"))]

47
crates/ruff/src/rules/isort/normalize.rs
View File

@ -1,5 +1,6 @@
use super::types::{AliasData, ImportBlock, ImportFromData, TrailingComma};
use super::types::{AliasData, ImportBlock, ImportFromData};
use super::AnnotatedImport;
use crate::rules::isort::types::TrailingComma;
pub fn normalize_imports(imports: Vec<AnnotatedImport>, combine_as_imports: bool) -> ImportBlock {
let mut block = ImportBlock::default();
@ -12,7 +13,7 @@ pub fn normalize_imports(imports: Vec<AnnotatedImport>, combine_as_imports: bool
} => {
// Associate the comments with the first alias (best effort).
if let Some(name) = names.first() {
let entry = block
let comment_set = block
.import
.entry(AliasData {
name: name.name,
@ -20,10 +21,10 @@ pub fn normalize_imports(imports: Vec<AnnotatedImport>, combine_as_imports: bool
})
.or_default();
for comment in atop {
entry.atop.push(comment.value);
comment_set.atop.push(comment.value);
}
for comment in inline {
entry.inline.push(comment.value);
comment_set.inline.push(comment.value);
}
}
@ -46,18 +47,18 @@ pub fn normalize_imports(imports: Vec<AnnotatedImport>, combine_as_imports: bool
inline,
trailing_comma,
} => {
// Insert comments on the statement itself.
if let Some(alias) = names.first() {
let entry = if alias.name == "*" {
let import_from = if alias.name == "*" {
block
.import_from_star
.entry(ImportFromData { module, level })
.or_default()
} else if alias.asname.is_none() || combine_as_imports {
&mut block
block
.import_from
.entry(ImportFromData { module, level })
.or_default()
.0
} else {
block
.import_from_as
@ -72,17 +73,17 @@ pub fn normalize_imports(imports: Vec<AnnotatedImport>, combine_as_imports: bool
};
for comment in atop {
entry.atop.push(comment.value);
import_from.comments.atop.push(comment.value);
}
for comment in inline {
entry.inline.push(comment.value);
import_from.comments.inline.push(comment.value);
}
}
// Create an entry for every alias.
// Create an entry for every alias (import) within the statement.
for alias in names {
let entry = if alias.name == "*" {
let import_from = if alias.name == "*" {
block
.import_from_star
.entry(ImportFromData { module, level })
@ -92,12 +93,6 @@ pub fn normalize_imports(imports: Vec<AnnotatedImport>, combine_as_imports: bool
.import_from
.entry(ImportFromData { module, level })
.or_default()
.1
.entry(AliasData {
name: alias.name,
asname: alias.asname,
})
.or_default()
} else {
block
.import_from_as
@ -111,20 +106,24 @@ pub fn normalize_imports(imports: Vec<AnnotatedImport>, combine_as_imports: bool
.or_default()
};
let comment_set = import_from
.aliases
.entry(AliasData {
name: alias.name,
asname: alias.asname,
})
.or_default();
for comment in alias.atop {
entry.atop.push(comment.value);
comment_set.atop.push(comment.value);
}
for comment in alias.inline {
entry.inline.push(comment.value);
}
comment_set.inline.push(comment.value);
}
// Propagate trailing commas.
if matches!(trailing_comma, TrailingComma::Present) {
if let Some(entry) =
block.import_from.get_mut(&ImportFromData { module, level })
{
entry.2 = trailing_comma;
import_from.trailing_comma = TrailingComma::Present;
}
}
}

63
crates/ruff/src/rules/isort/order.rs
View File

@ -1,12 +1,12 @@
use std::cmp::Ordering;
use std::collections::BTreeSet;
use crate::rules::isort::types::ImportFromStatement;
use itertools::Itertools;
use rustc_hash::FxHashMap;
use super::settings::RelativeImportsOrder;
use super::sorting::{cmp_import_from, cmp_members, cmp_modules};
use super::types::{AliasData, CommentSet, ImportBlock, OrderedImportBlock, TrailingComma};
use super::types::{AliasData, CommentSet, ImportBlock, OrderedImportBlock};
pub fn order_imports<'a>(
block: ImportBlock<'a>,
@ -38,60 +38,26 @@ pub fn order_imports<'a>(
block
.import_from_as
.into_iter()
.map(|((import_from, alias), comments)| {
(
import_from,
(
CommentSet {
atop: comments.atop,
inline: vec![],
},
FxHashMap::from_iter([(
alias,
CommentSet {
atop: vec![],
inline: comments.inline,
},
)]),
TrailingComma::Absent,
),
)
}),
.map(|((import_from, ..), body)| (import_from, body)),
)
.chain(
// Include all star imports.
block
.import_from_star
.into_iter()
.map(|(import_from, comments)| {
(
block.import_from_star.into_iter(),
)
.map(
|(
import_from,
(
CommentSet {
atop: comments.atop,
inline: vec![],
ImportFromStatement {
comments,
aliases,
trailing_comma,
},
FxHashMap::from_iter([(
AliasData {
name: "*",
asname: None,
},
CommentSet {
atop: vec![],
inline: comments.inline,
},
)]),
TrailingComma::Absent,
),
)
}),
)
.map(|(import_from, (comments, aliases, locations))| {
)| {
// Within each `StmtKind::ImportFrom`, sort the members.
(
import_from,
comments,
locations,
trailing_comma,
aliases
.into_iter()
.sorted_by(|(alias1, _), (alias2, _)| {
@ -107,7 +73,8 @@ pub fn order_imports<'a>(
})
.collect::<Vec<(AliasData, CommentSet)>>(),
)
})
},
)
.sorted_by(
|(import_from1, _, _, aliases1), (import_from2, _, _, aliases2)| {
cmp_import_from(

22
crates/ruff/src/rules/isort/snapshots/ruff__rules__isort__tests__as_imports_comments.py.snap Normal file
View File

@ -0,0 +1,22 @@
---
source: crates/ruff/src/rules/isort/mod.rs
expression: diagnostics
---
- kind:
UnsortedImports: ~
location:
row: 1
column: 0
end_location:
row: 16
column: 0
fix:
content: "from bar import ( # Comment on `bar`\n Member, # Comment on `Member`\n)\nfrom baz import Member as Alias # Comment on `Alias` # Comment on `baz`\nfrom bop import Member # Comment on `Member` # Comment on `bop`\nfrom foo import ( # Comment on `foo`\n Member as Alias, # Comment on `Alias`\n)\n"
location:
row: 1
column: 0
end_location:
row: 16
column: 0
parent: ~

4
crates/ruff/src/rules/isort/split.rs
View File

@ -46,10 +46,10 @@ pub fn split_by_forced_separate<'a>(
.import_from
.insert(imp, val);
}
for ((imp, alias), comment_set) in import_from_as {
for ((imp, alias), val) in import_from_as {
blocks[find_block_index(forced_separate, &imp)]
.import_from_as
.insert((imp, alias), comment_set);
.insert((imp, alias), val);
}
for (imp, comment_set) in import_from_star {
blocks[find_block_index(forced_separate, &imp)]

20
crates/ruff/src/rules/isort/types.rs
View File

@ -54,6 +54,13 @@ impl Importable for ImportFromData<'_> {
}
}
#[derive(Debug, Default)]
pub struct ImportFromStatement<'a> {
pub comments: CommentSet<'a>,
pub aliases: FxHashMap<AliasData<'a>, CommentSet<'a>>,
pub trailing_comma: TrailingComma,
}
#[derive(Debug, Default)]
pub struct ImportBlock<'a> {
// Set of (name, asname), used to track regular imports.
@ -61,20 +68,13 @@ pub struct ImportBlock<'a> {
pub import: FxHashMap<AliasData<'a>, CommentSet<'a>>,
// Map from (module, level) to `AliasData`, used to track 'from' imports.
// Ex) `from module import member`
pub import_from: FxHashMap<
ImportFromData<'a>,
(
CommentSet<'a>,
FxHashMap<AliasData<'a>, CommentSet<'a>>,
TrailingComma,
),
>,
pub import_from: FxHashMap<ImportFromData<'a>, ImportFromStatement<'a>>,
// Set of (module, level, name, asname), used to track re-exported 'from' imports.
// Ex) `from module import member as member`
pub import_from_as: FxHashMap<(ImportFromData<'a>, AliasData<'a>), CommentSet<'a>>,
pub import_from_as: FxHashMap<(ImportFromData<'a>, AliasData<'a>), ImportFromStatement<'a>>,
// Map from (module, level) to `AliasData`, used to track star imports.
// Ex) `from module import *`
pub import_from_star: FxHashMap<ImportFromData<'a>, CommentSet<'a>>,
pub import_from_star: FxHashMap<ImportFromData<'a>, ImportFromStatement<'a>>,
}
type AliasDataWithComments<'a> = (AliasData<'a>, CommentSet<'a>);