[`flake8-import-conventions`] Add missing conventions from upstream (`ICN001`, `ICN002`) by danparizher · Pull Request #21373 · astral-sh/ruff

danparizher · 2025-11-11T04:25:41Z

Summary

Adds missing import conventions from upstream flake8-import-conventions plugin. Specifically:

ICN001: Enforces plotly.graph_objects → go and statsmodels.api → sm
ICN002: Bans geopandas → gpd alias

Problem Analysis

Ruff's ICN001 (unconventional-import-alias) and ICN002 (banned-import-alias) rules were missing some conventions enforced by the upstream flake8-import-conventions plugin:

ICN001 missing conventions:
- plotly.graph_objects should be imported as go (IC008 in upstream)
- statsmodels.api should be imported as sm (IC010 in upstream)
ICN002 missing convention:
- geopandas should not be imported as gpd (IC002 in upstream)

The root cause was that these conventions were not included in Ruff's default configuration. The CONVENTIONAL_ALIASES constant was missing the two ICN001 entries, and there was no default banned aliases configuration for ICN002.

Approach

Added missing ICN001 conventions:
- Added ("plotly.graph_objects", "go") and ("statsmodels.api", "sm") to CONVENTIONAL_ALIASES in settings.rs
- Updated the default option string in options.rs to include these new aliases
Added default banned aliases for ICN002:
- Created default_banned_aliases() function returning geopandas → ["gpd"]
- Updated Settings::default() to use default_banned_aliases()
- Updated try_into_settings() in options.rs to use default_banned_aliases() when banned_aliases is None
- Updated the default option string for banned_aliases in options.rs
Added comprehensive tests:
- Created missing_conventions.py test fixture with cases for all three new conventions
- Added missing_conventions test in mod.rs to verify the new conventions work correctly

Test Plan

Added new snapshot test missing_conventions that verifies:

ICN001 correctly flags plotly.graph_objects without alias and requires go
ICN001 correctly flags statsmodels.api without alias and requires sm
ICN002 correctly flags geopandas as gpd as banned
All existing tests continue to pass (10/10 tests passing)

The fix has been manually verified to match the behavior of upstream flake8-import-conventions.

astral-sh-bot · 2025-11-11T04:33:27Z

`ruff-ecosystem` results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

ℹ️ ecosystem check detected linter changes. (+3 -0 violations, +0 -0 fixes in 1 projects; 55 projects unchanged)

ibis-project/ibis (+3 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --no-fix --output-format concise --preview

+ ibis/backends/bigquery/converter.py:9:9: ICN002 `geopandas` should not be imported as `gpd`
+ ibis/backends/postgres/converter.py:11:9: ICN002 `geopandas` should not be imported as `gpd`
+ ibis/formats/pandas.py:184:9: ICN002 `geopandas` should not be imported as `gpd`

Changes by rule (1 rules affected)

code	total	+ violation	- violation	+ fix	- fix
ICN002	3	3	0	0	0

ntBre

Thanks! This looks good, just one suggestion about where to put the new tests

crates/ruff_linter/resources/test/fixtures/flake8_import_conventions/missing_conventions.py

ntBre

On second thought, could we make this a preview change? Initially I assumed this was an unintentional omission from the original PR adding the rules (#1098), but I see now that these were changed upstream after our rule was added (joaopalmeiro/flake8-import-conventions#3, joaopalmeiro/flake8-import-conventions#4). These issues were opened upstream before our rule but closed after. And there are a few hits in the ecosystem report for geopandas too.

crates/ruff_linter/src/rules/flake8_import_conventions/rules/banned_import_alias.rs

ntBre · 2025-11-18T19:53:49Z

crates/ruff_linter/src/rules/flake8_import_conventions/settings.rs

+impl Settings {
+    /// Merge preview aliases and banned aliases into the settings if preview mode is enabled.
+    #[must_use]
+    pub fn with_preview(mut self, preview_enabled: bool) -> Self {


I think the way we usually handle this is by defining a method that takes a preview argument instead of impl Default (which can't take arguments). This is kind of the opposite since it was a stabilization PR, but you can see an example here: https://github.com/astral-sh/ruff/pull/12838/files#diff-0e4daa1a461406d9fd7af87b85ff4ecc89bd61f748d2b7cb24b88b25c7d5ba59

Possibly a better example: #15951

ntBre

Thanks, this is looking good. I fixed a few nits, reverting some unrelated changes and tweaking the test setup, but I also wanted to get your thoughts on the try_into_settings changes. See my inline comments for that.

ntBre · 2025-12-03T20:08:26Z

crates/ruff_workspace/src/options.rs

+        // Merge preview aliases if preview mode is enabled
+        if preview.is_enabled() {
+            aliases.extend(flake8_import_conventions::settings::preview_aliases());
+        }
+


I don't think we should set this here. If I understand correctly, this will extend the list of aliases when preview is enabled even if the user provided a set of aliases. We only want to extend the default set in the case where self.aliases is None above. I think it would make sense for the default_aliases helper function to take the preview argument and apply it there.

ntBre · 2025-12-03T20:08:46Z

crates/ruff_workspace/src/options.rs

+        if preview.is_enabled() {
+            banned_aliases.extend(flake8_import_conventions::settings::preview_banned_aliases());
+        }


Same as above, we should only do this in the or_default case.

ntBre

Thank you!

ntBre · 2026-02-24T21:00:58Z

Not sure why the ecosystem check dropped a diagnostic after the last push, I'm still seeing 4 locally. I think I'll go ahead and land this anyway once CI finishes again.

fix-21300

3633bcf

danparizher added 2 commits November 10, 2025 23:37

Update remaining snaps

0c44086

Update cli__lint__requires_python_ruff_toml_above-2.snap

3b468da

ntBre requested changes Nov 11, 2025

View reviewed changes

crates/ruff_linter/resources/test/fixtures/flake8_import_conventions/missing_conventions.py Outdated Show resolved Hide resolved

ntBre added the rule Implementing or modifying a lint rule label Nov 11, 2025

Move tests to defaults.py

7cb1196

danparizher requested a review from ntBre November 11, 2025 22:20

ntBre reviewed Nov 13, 2025

View reviewed changes

danparizher added 2 commits November 13, 2025 20:34

Apply preview

17bbb53

Fix preview snaps; cargo clippy

924fd61

danparizher requested a review from ntBre November 14, 2025 02:19

ntBre reviewed Nov 18, 2025

View reviewed changes

Refactor preview mode handling

814642c

danparizher requested a review from ntBre November 19, 2025 23:31

ntBre added the preview Related to preview mode features label Dec 3, 2025

ntBre added 3 commits December 3, 2025 14:51

revert otherwise unmodified snaps

a9b8e78

revert reordering

af7c72f

separate preview defaults test

2222bcf

ntBre reviewed Dec 3, 2025

View reviewed changes

Implement Feedback

a36e399

danparizher requested a review from ntBre January 26, 2026 05:26

ntBre added 5 commits February 24, 2026 14:45

Merge branch 'main' into fix-21300

3821d63

revert order change

9ed0a1c

add preview function

23bdcf6

inline single-use preview functions

440ea88

consistently use preview function

a65d506

ntBre approved these changes Feb 24, 2026

View reviewed changes

avoid unnecessary collect

ae8085b

ntBre merged commit 46f71fb into astral-sh:main Feb 24, 2026
42 checks passed

BrewTestBot mentioned this pull request Feb 26, 2026

ruff 0.15.3 Homebrew/homebrew-core#269612

Merged

seisman mentioned this pull request Feb 27, 2026

ruff: Fix ICN002 geopandas import alias GenericMappingTools/pygmt#4430

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[`flake8-import-conventions`] Add missing conventions from upstream (`ICN001`, `ICN002`)#21373

[`flake8-import-conventions`] Add missing conventions from upstream (`ICN001`, `ICN002`)#21373
ntBre merged 17 commits intoastral-sh:mainfrom
danparizher:fix-21300

danparizher commented Nov 11, 2025

Uh oh!

astral-sh-bot bot commented Nov 11, 2025 •

edited

Loading

Uh oh!

ntBre left a comment

Uh oh!

Uh oh!

ntBre left a comment

Uh oh!

Uh oh!

ntBre Nov 18, 2025

Uh oh!

ntBre left a comment

Uh oh!

ntBre Dec 3, 2025

Uh oh!

ntBre Dec 3, 2025

Uh oh!

ntBre left a comment

Uh oh!

ntBre commented Feb 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

danparizher commented Nov 11, 2025

Summary

Problem Analysis

Approach

Test Plan

Uh oh!

astral-sh-bot bot commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ruff-ecosystem results

Linter (stable)

Linter (preview)

Uh oh!

ntBre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ntBre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ntBre Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

ntBre left a comment

Choose a reason for hiding this comment

Uh oh!

ntBre Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

ntBre Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

ntBre left a comment

Choose a reason for hiding this comment

Uh oh!

ntBre commented Feb 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

astral-sh-bot bot commented Nov 11, 2025 •

edited

Loading

`ruff-ecosystem` results