Skip to content

[flake8-import-conventions] Add import numpy.typing as npt to default flake8-import-conventions.aliases #17133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MichaReiser merged 2 commits into from
Apr 2, 2025
Merged

[flake8-import-conventions] Add import numpy.typing as npt to default flake8-import-conventions.aliases #17133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57da178
[flake8-import-conventions] Add import `numpy.typing as npt` to defau…
amin-not-found Apr 1, 2025
5cbddb8
moved new tests to the end of file and fixed a typo
amin-not-found Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions crates/ruff/tests/lint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2244,6 +2244,7 @@ requires-python = ">= 3.11"
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down Expand Up @@ -2554,6 +2555,7 @@ requires-python = ">= 3.11"
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down Expand Up @@ -2916,6 +2918,7 @@ from typing import Union;foo: Union[int, str] = 1
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down Expand Up @@ -3294,6 +3297,7 @@ from typing import Union;foo: Union[int, str] = 1
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down Expand Up @@ -3620,6 +3624,7 @@ from typing import Union;foo: Union[int, str] = 1
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down Expand Up @@ -3946,6 +3951,7 @@ from typing import Union;foo: Union[int, str] = 1
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down Expand Up @@ -4229,6 +4235,7 @@ from typing import Union;foo: Union[int, str] = 1
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down Expand Up @@ -4565,6 +4572,7 @@ from typing import Union;foo: Union[int, str] = 1
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down
1 change: 1 addition & 0 deletions crates/ruff/tests/snapshots/show_settings__display_default_settings.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ linter.flake8_import_conventions.aliases = {
matplotlib.pyplot = plt,
networkx = nx,
numpy = np,
numpy.typing = npt,
pandas = pd,
panel = pn,
plotly.express = px,
Expand Down
4 changes: 4 additions & 0 deletions crates/ruff_linter/resources/test/fixtures/flake8_import_conventions/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,7 @@
import pyarrow as pa # conventional

from tensorflow.keras import Model # conventional

import numpy.typing # unconventional
import numpy.typing as nt # unconventional
import numpy.typing as npt # conventional
1 change: 1 addition & 0 deletions crates/ruff_linter/src/rules/flake8_import_conventions/settings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const CONVENTIONAL_ALIASES: &[(&str, &str)] = &[
("matplotlib.pyplot", "plt"),
("networkx", "nx"),
("numpy", "np"),
("numpy.typing", "npt"),
("pandas", "pd"),
("seaborn", "sns"),
("tensorflow", "tf"),
Expand Down
20 changes: 20 additions & 0 deletions ...t_conventions/snapshots/ruff_linter__rules__flake8_import_conventions__tests__custom.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,3 +304,23 @@ custom.py:31:19: ICN001 `pyarrow` should be imported as `pa`
33 | import altair as alt # conventional
|
= help: Alias `pyarrow` to `pa`

custom.py:50:8: ICN001 `numpy.typing` should be imported as `npt`
|
48 | from tensorflow.keras import Model # conventional
49 |
50 | import numpy.typing # unconventional
| ^^^^^^^^^^^^ ICN001
51 | import numpy.typing as nt # unconventional
52 | import numpy.typing as npt # conventional
|
= help: Alias `numpy.typing` to `npt`

custom.py:51:24: ICN001 `numpy.typing` should be imported as `npt`
|
50 | import numpy.typing # unconventional
51 | import numpy.typing as nt # unconventional
| ^^ ICN001
52 | import numpy.typing as npt # conventional
|
= help: Alias `numpy.typing` to `npt`
2 changes: 1 addition & 1 deletion crates/ruff_workspace/src/options.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1496,7 +1496,7 @@ pub struct Flake8ImportConventionsOptions {
/// The conventional aliases for imports. These aliases can be extended by
/// the [`extend-aliases`](#lint_flake8-import-conventions_extend-aliases) option.
#[option(
default = r#"{"altair": "alt", "matplotlib": "mpl", "matplotlib.pyplot": "plt", "numpy": "np", "pandas": "pd", "seaborn": "sns", "tensorflow": "tf", "tkinter": "tk", "holoviews": "hv", "panel": "pn", "plotly.express": "px", "polars": "pl", "pyarrow": "pa", "xml.etree.ElementTree": "ET"}"#,
default = r#"{"altair": "alt", "matplotlib": "mpl", "matplotlib.pyplot": "plt", "numpy": "np", "numpy.typing": "npt", "pandas": "pd", "seaborn": "sns", "tensorflow": "tf", "tkinter": "tk", "holoviews": "hv", "panel": "pn", "plotly.express": "px", "polars": "pl", "pyarrow": "pa", "xml.etree.ElementTree": "ET"}"#,
value_type = "dict[str, str]",
scope = "aliases",
example = r#"
Expand Down
Loading