Implement isort custom sections and ordering (#2419) #3900

hackedd · 2023-04-06T13:06:13Z

Similar to some other people in #2419 I'm currently converting a Django project from flake8 + isort to use ruff. The isort settings currently contain (among other things):

known_django = django
sections = FUTURE,STDLIB,THIRDPARTY,DJANGO,FIRSTPARTY,LOCALFOLDER

With these changes, I can configure ruff to do the same grouping:

[tool.ruff.isort]
section-order = ["future", "standard-library", "third-party", "django", "first-party", "local-folder"]

[tool.ruff.isort.sections]
django = ["django"]

github-actions · 2023-04-06T13:17:06Z

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     15.1±0.03ms     2.7 MB/sec    1.00     15.1±0.02ms     2.7 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.8±0.01ms     4.4 MB/sec    1.00      3.8±0.00ms     4.4 MB/sec
linter/all-rules/numpy/globals.py          1.00    418.9±1.67µs     7.0 MB/sec    1.00    417.1±1.32µs     7.1 MB/sec
linter/all-rules/pydantic/types.py         1.01      6.5±0.01ms     3.9 MB/sec    1.00      6.4±0.01ms     4.0 MB/sec
linter/default-rules/large/dataset.py      1.01      7.9±0.01ms     5.1 MB/sec    1.00      7.8±0.01ms     5.2 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01   1758.9±2.44µs     9.5 MB/sec    1.00   1744.5±3.35µs     9.5 MB/sec
linter/default-rules/numpy/globals.py      1.00    182.6±0.45µs    16.2 MB/sec    1.00    182.4±0.64µs    16.2 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.6±0.01ms     7.0 MB/sec    1.00      3.6±0.02ms     7.1 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     19.4±0.52ms     2.1 MB/sec    1.01     19.6±0.64ms     2.1 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      5.0±0.19ms     3.4 MB/sec    1.01      5.0±0.24ms     3.3 MB/sec
linter/all-rules/numpy/globals.py          1.01   608.9±31.17µs     4.8 MB/sec    1.00   605.0±25.46µs     4.9 MB/sec
linter/all-rules/pydantic/types.py         1.00      8.3±0.30ms     3.1 MB/sec    1.03      8.5±0.41ms     3.0 MB/sec
linter/default-rules/large/dataset.py      1.00      9.7±0.28ms     4.2 MB/sec    1.04     10.1±0.44ms     4.0 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00      2.1±0.07ms     7.8 MB/sec    1.05      2.2±0.10ms     7.4 MB/sec
linter/default-rules/numpy/globals.py      1.00    246.9±9.40µs    12.0 MB/sec    1.07   265.3±15.11µs    11.1 MB/sec
linter/default-rules/pydantic/types.py     1.00      4.4±0.17ms     5.8 MB/sec    1.05      4.6±0.22ms     5.5 MB/sec

MichaReiser · 2023-04-11T06:32:15Z

crates/ruff/src/rules/isort/categorize.rs

+ fn categorize_submodule(&self, submodule: &str) -> Option<(ImportSection, Reason)> {
+ if let Some((section, _)) = self.sections.iter().find(|(_, v)| v.contains(submodule)) {
+ Some((
+ ImportSection::UserDefined(section.clone()),
+ Reason::UserDefinedSection,
+ ))
+ } else if self.first_party.contains(submodule) {
+ Some((
+ ImportSection::Known(ImportType::FirstParty),
+ Reason::KnownFirstParty,
+ ))
+ } else if self.third_party.contains(submodule) {
+ Some((
+ ImportSection::Known(ImportType::ThirdParty),
+ Reason::KnownThirdParty,
+ ))
+ } else if self.local_folder.contains(submodule) {
+ Some((
+ ImportSection::Known(ImportType::LocalFolder),
+ Reason::KnownLocalFolder,
+ ))
+ } else if self.standard_library.contains(submodule) {
+ Some((
+ ImportSection::Known(ImportType::StandardLibrary),
+ Reason::ExtraStandardLibrary,
+ ))
+ } else {
+ None
 }


Can a user configure a submodule so that it belongs to multiple sections? If so, what happens in that case?

Can we change the configuration format/internal representation to make this impossible (e.g. have a module -> ImportSection mapping)

yes, just like there is currently nothing stopping a user from doing something like extra-standard-library = ["path"] and known-first-party = ["path"]. The first match found 'wins', and is the section that will be used. Configurations like that should probably result in an error or warning. Constructing a mapping sounds like a good idea, it would make this lookup simpler and makes it easy to detect conflicts.

crates/ruff/src/rules/isort/categorize.rs

crates/ruff/src/rules/isort/mod.rs

charliermarsh · 2023-04-13T20:55:33Z

This is really nice work.

charliermarsh self-requested a review April 7, 2023 02:26

MichaReiser reviewed Apr 11, 2023

View reviewed changes

crates/ruff/src/rules/isort/mod.rs Outdated Show resolved Hide resolved

MichaReiser reviewed Apr 11, 2023

View reviewed changes

crates/ruff/src/rules/isort/mod.rs Outdated Show resolved Hide resolved

hackedd force-pushed the isort-custom-sections branch from af221fa to 48b8f2a Compare April 12, 2023 08:04

Implement isort custom sections and ordering (astral-sh#2419)

80f4d50

hackedd force-pushed the isort-custom-sections branch from 48b8f2a to 80f4d50 Compare April 12, 2023 08:17

hackedd and others added 2 commits April 12, 2023 12:14

Refactor KnownModules to use a map lookup

abc7fb8

Merge branch 'main' into isort-custom-sections

16b0964

Expand some error messages

b18d2e4

charliermarsh enabled auto-merge (squash) April 13, 2023 21:22

charliermarsh merged commit 2d2630e into astral-sh:main Apr 13, 2023

charliermarsh mentioned this pull request Apr 13, 2023

Implement isort custom sections and ordering #2419

Closed

p-linnane mentioned this pull request Apr 20, 2023

ruff 0.0.262 Homebrew/homebrew-core#128839

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement isort custom sections and ordering (#2419) #3900

Implement isort custom sections and ordering (#2419) #3900

hackedd commented Apr 6, 2023

github-actions bot commented Apr 6, 2023 •

edited

Loading

MichaReiser Apr 11, 2023

hackedd Apr 12, 2023

charliermarsh commented Apr 13, 2023

Implement isort custom sections and ordering (#2419) #3900

Implement isort custom sections and ordering (#2419) #3900

Conversation

hackedd commented Apr 6, 2023

github-actions bot commented Apr 6, 2023 • edited Loading

PR Check Results

Ecosystem

Benchmark

Linux

Windows

MichaReiser Apr 11, 2023

Choose a reason for hiding this comment

hackedd Apr 12, 2023

Choose a reason for hiding this comment

charliermarsh commented Apr 13, 2023

github-actions bot commented Apr 6, 2023 •

edited

Loading