Cyclic0007/ruff
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

isort: Support disabling sections with `no-sections = true` (#8657)

Browse Source 
## Summary

This adds a ``no-sections`` option for isort in the linter, similar to
the ``no_sections`` option that exists in upstream isort
(https://pycqa.github.io/isort/docs/configuration/options.html#no-sections)

This option puts all imports except for ``__future__`` into the same
section, and is mostly used by monorepos.

I've taken a bit of a leap in assuming that ruff wants to support the
exact same option; more than happy to refactor if you'd prefer a
different way of setting this up.

Fixes #8653

## Test Plan

I've added a test and have run it on a large Python codebase that uses
isort with --no-sections. The option is disabled by default.
This commit is contained in:
Jelmer Vernooij
2023-11-14 21:45:51 +00:00
committed by GitHub
parent 561277925f
commit 9d76e4e0b9
8 changed files with 93 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crates/ruff_linter/resources/test/fixtures/isort/no_sections.py vendored Normal file
View File

@@ -0,0 +1,8 @@
from __future__ import annotations
import django.settings
import os
import pytz
import sys
from . import local
from library import foo

1
crates/ruff_linter/src/rules/flake8_type_checking/rules/typing_only_runtime_import.rs
View File

@@ -285,6 +285,7 @@ pub(crate) fn typing_only_runtime_import(
checker.settings.isort.detect_same_package,
&checker.settings.isort.known_modules,
checker.settings.target_version,
checker.settings.isort.no_sections,
) {
ImportSection::Known(ImportType::LocalFolder | ImportType::FirstParty) => {
ImportType::FirstParty

18
crates/ruff_linter/src/rules/isort/categorize.rs
View File

@@ -61,6 +61,7 @@ enum Reason<'a> {
SourceMatch(&'a Path),
NoMatch,
UserDefinedSection,
NoSections,
}
#[allow(clippy::too_many_arguments)]
@@ -72,16 +73,22 @@ pub(crate) fn categorize<'a>(
detect_same_package: bool,
known_modules: &'a KnownModules,
target_version: PythonVersion,
no_sections: bool,
) -> &'a ImportSection {
let module_base = module_name.split('.').next().unwrap();
let (import_type, reason) = {
if level.is_some_and(|level| level > 0) {
if matches!(level, None | Some(0)) && module_base == "__future__" {
(&ImportSection::Known(ImportType::Future), Reason::Future)
} else if no_sections {
(
&ImportSection::Known(ImportType::FirstParty),
Reason::NoSections,
)
} else if level.is_some_and(|level| level > 0) {
(
&ImportSection::Known(ImportType::LocalFolder),
Reason::NonZeroLevel,
)
} else if module_base == "__future__" {
(&ImportSection::Known(ImportType::Future), Reason::Future)
} else if let Some((import_type, reason)) = known_modules.categorize(module_name) {
(import_type, reason)
} else if is_known_standard_library(target_version.minor(), module_base) {
@@ -141,6 +148,7 @@ pub(crate) fn categorize_imports<'a>(
detect_same_package: bool,
known_modules: &'a KnownModules,
target_version: PythonVersion,
no_sections: bool,
) -> BTreeMap<&'a ImportSection, ImportBlock<'a>> {
let mut block_by_type: BTreeMap<&ImportSection, ImportBlock> = BTreeMap::default();
// Categorize `Stmt::Import`.
@@ -153,6 +161,7 @@ pub(crate) fn categorize_imports<'a>(
detect_same_package,
known_modules,
target_version,
no_sections,
);
block_by_type
.entry(import_type)
@@ -170,6 +179,7 @@ pub(crate) fn categorize_imports<'a>(
detect_same_package,
known_modules,
target_version,
no_sections,
);
block_by_type
.entry(classification)
@@ -187,6 +197,7 @@ pub(crate) fn categorize_imports<'a>(
detect_same_package,
known_modules,
target_version,
no_sections,
);
block_by_type
.entry(classification)
@@ -204,6 +215,7 @@ pub(crate) fn categorize_imports<'a>(
detect_same_package,
known_modules,
target_version,
no_sections,
);
block_by_type
.entry(classification)

19
crates/ruff_linter/src/rules/isort/mod.rs
View File

@@ -153,6 +153,7 @@ fn format_import_block(
settings.detect_same_package,
&settings.known_modules,
target_version,
settings.no_sections,
);
let mut output = String::new();
@@ -836,6 +837,24 @@ mod tests {
Ok(())
}
#[test_case(Path::new("no_sections.py"))]
fn no_sections(path: &Path) -> Result<()> {
let snapshot = format!("no_sections_{}", path.to_string_lossy());
let diagnostics = test_path(
Path::new("isort").join(path).as_path(),
&LinterSettings {
isort: super::settings::Settings {
no_sections: true,
..super::settings::Settings::default()
},
src: vec![test_resource_path("fixtures/isort")],
..LinterSettings::for_rule(Rule::UnsortedImports)
},
)?;
assert_messages!(snapshot, diagnostics);
Ok(())
}
#[test_case(Path::new("no_lines_before.py"))]
fn no_lines_before(path: &Path) -> Result<()> {
let snapshot = format!("no_lines_before.py_{}", path.to_string_lossy());

2
crates/ruff_linter/src/rules/isort/settings.rs
View File

@@ -56,6 +56,7 @@ pub struct Settings {
pub lines_between_types: usize,
pub forced_separate: Vec<String>,
pub section_order: Vec<ImportSection>,
pub no_sections: bool,
}
impl Default for Settings {
@@ -82,6 +83,7 @@ impl Default for Settings {
lines_between_types: 0,
forced_separate: Vec::new(),
section_order: ImportType::iter().map(ImportSection::Known).collect(),
no_sections: false,
}
}
}

4
crates/ruff_linter/src/rules/isort/snapshots/ruff_linter__rules__isort__tests__no_sections_no_sections.py.snap Normal file
View File

@@ -0,0 +1,4 @@
---
source: crates/ruff_linter/src/rules/isort/mod.rs
---

37
crates/ruff_workspace/src/options.rs
View File

@@ -1978,6 +1978,33 @@ pub struct IsortOptions {
)]
pub section_order: Option<Vec<ImportSection>>,
/// Put all imports into the same section bucket.
///
/// For example, rather than separating standard library and third-party imports, as in:
/// ```python
/// import os
/// import sys
///
/// import numpy
/// import pandas
/// ```
///
/// Setting `no-sections = true` will instead group all imports into a single section:
/// ```python
/// import os
/// import numpy
/// import pandas
/// import sys
/// ```
#[option(
default = r#"false"#,
value_type = "bool",
example = r#"
no-sections = true
"#
)]
pub no_sections: Option<bool>,
/// Whether to automatically mark imports from within the same package as first-party.
/// For example, when `detect-same-package = true`, then when analyzing files within the
/// `foo` package, any imports from within the `foo` package will be considered first-party.
@@ -2013,6 +2040,15 @@ impl IsortOptions {
pub fn try_into_settings(
self,
) -> Result<isort::settings::Settings, isort::settings::SettingsError> {
// Verify that if `no_sections` is set, then `section_order` is empty.
let no_sections = self.no_sections.unwrap_or_default();
if no_sections && self.section_order.is_some() {
warn_user_once!("`section-order` is ignored when `no-sections` is set to `true`");
}
if no_sections && self.sections.is_some() {
warn_user_once!("`sections` is ignored when `no-sections` is set to `true`");
}
// Extract any configuration options that deal with user-defined sections.
let mut section_order: Vec<_> = self
.section_order
@@ -2169,6 +2205,7 @@ impl IsortOptions {
lines_between_types: self.lines_between_types.unwrap_or_default(),
forced_separate: Vec::from_iter(self.forced_separate.unwrap_or_default()),
section_order,
no_sections,
})
}
}

7
ruff.schema.json generated
View File

@@ -1497,6 +1497,13 @@
"$ref": "#/definitions/ImportSection"
}
},
"no-sections": {
"description": "Put all imports into the same section bucket.\n\nFor example, rather than separating standard library and third-party imports, as in: ```python import os import sys\n\nimport numpy import pandas ```\n\nSetting `no-sections = true` will instead group all imports into a single section: ```python import os import numpy import pandas import sys ```",
"type": [
"boolean",
"null"
]
},
"order-by-type": {
"description": "Order imports by type, which is determined by case, in addition to alphabetically.",
"type": [