Skip to content
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

Add tkinter import convention #5626

Merged
merged 1 commit into from
Jul 9, 2023
Merged

Add tkinter import convention #5626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions crates/ruff/resources/test/fixtures/flake8_import_conventions/defaults.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@
import numpy # unconventional
import pandas # unconventional
import seaborn # unconventional
import tkinter # unconventional

import altair as altr # unconventional
import matplotlib.pyplot as plot # unconventional
import numpy as nmp # unconventional
import pandas as pdas # unconventional
import seaborn as sbrn # unconventional
import tkinter as tkr # unconventional

import altair as alt # conventional
import matplotlib.pyplot as plt # conventional
import numpy as np # conventional
import pandas as pd # conventional
import seaborn as sns # conventional
import tkinter as tk # conventional
3 changes: 2 additions & 1 deletion crates/ruff/src/rules/flake8_import_conventions/settings.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const CONVENTIONAL_ALIASES: &[(&str, &str)] = &[
("pandas", "pd"),
("seaborn", "sns"),
("tensorflow", "tf"),
("tkinter", "tk"),
("holoviews", "hv"),
("panel", "pn"),
("plotly.express", "px"),
Expand All @@ -31,7 +32,7 @@ const CONVENTIONAL_ALIASES: &[(&str, &str)] = &[
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub struct Options {
#[option(
default = r#"{"altair": "alt", "matplotlib": "mpl", "matplotlib.pyplot": "plt", "numpy": "np", "pandas": "pd", "seaborn": "sns", "tensorflow": "tf", "holoviews": "hv", "panel": "pn", "plotly.express": "px", "polars": "pl", "pyarrow": "pa"}"#,
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"}"#,
value_type = "dict[str, str]",
example = r#"
[tool.ruff.flake8-import-conventions.aliases]
Expand Down
80 changes: 51 additions & 29 deletions ...import_conventions/snapshots/ruff__rules__flake8_import_conventions__tests__defaults.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ defaults.py:6:8: ICN001 `pandas` should be imported as `pd`
6 | import pandas # unconventional
| ^^^^^^ ICN001
7 | import seaborn # unconventional
8 | import tkinter # unconventional
|
= help: Alias `pandas` to `pd`

Expand All @@ -49,62 +50,83 @@ defaults.py:7:8: ICN001 `seaborn` should be imported as `sns`
6 | import pandas # unconventional
7 | import seaborn # unconventional
| ^^^^^^^ ICN001
8 |
9 | import altair as altr # unconventional
8 | import tkinter # unconventional
|
= help: Alias `seaborn` to `sns`

defaults.py:9:18: ICN001 `altair` should be imported as `alt`
defaults.py:8:8: ICN001 `tkinter` should be imported as `tk`
|
6 | import pandas # unconventional
7 | import seaborn # unconventional
8 |
9 | import altair as altr # unconventional
8 | import tkinter # unconventional
| ^^^^^^^ ICN001
9 |
10 | import altair as altr # unconventional
|
= help: Alias `tkinter` to `tk`

defaults.py:10:18: ICN001 `altair` should be imported as `alt`
|
8 | import tkinter # unconventional
9 |
10 | import altair as altr # unconventional
| ^^^^ ICN001
10 | import matplotlib.pyplot as plot # unconventional
11 | import numpy as nmp # unconventional
11 | import matplotlib.pyplot as plot # unconventional
12 | import numpy as nmp # unconventional
|
= help: Alias `altair` to `alt`

defaults.py:10:29: ICN001 `matplotlib.pyplot` should be imported as `plt`
defaults.py:11:29: ICN001 `matplotlib.pyplot` should be imported as `plt`
|
9 | import altair as altr # unconventional
10 | import matplotlib.pyplot as plot # unconventional
10 | import altair as altr # unconventional
11 | import matplotlib.pyplot as plot # unconventional
| ^^^^ ICN001
11 | import numpy as nmp # unconventional
12 | import pandas as pdas # unconventional
12 | import numpy as nmp # unconventional
13 | import pandas as pdas # unconventional
|
= help: Alias `matplotlib.pyplot` to `plt`

defaults.py:11:17: ICN001 `numpy` should be imported as `np`
defaults.py:12:17: ICN001 `numpy` should be imported as `np`
|
9 | import altair as altr # unconventional
10 | import matplotlib.pyplot as plot # unconventional
11 | import numpy as nmp # unconventional
10 | import altair as altr # unconventional
11 | import matplotlib.pyplot as plot # unconventional
12 | import numpy as nmp # unconventional
| ^^^ ICN001
12 | import pandas as pdas # unconventional
13 | import seaborn as sbrn # unconventional
13 | import pandas as pdas # unconventional
14 | import seaborn as sbrn # unconventional
|
= help: Alias `numpy` to `np`

defaults.py:12:18: ICN001 `pandas` should be imported as `pd`
defaults.py:13:18: ICN001 `pandas` should be imported as `pd`
|
10 | import matplotlib.pyplot as plot # unconventional
11 | import numpy as nmp # unconventional
12 | import pandas as pdas # unconventional
11 | import matplotlib.pyplot as plot # unconventional
12 | import numpy as nmp # unconventional
13 | import pandas as pdas # unconventional
| ^^^^ ICN001
13 | import seaborn as sbrn # unconventional
14 | import seaborn as sbrn # unconventional
15 | import tkinter as tkr # unconventional
|
= help: Alias `pandas` to `pd`

defaults.py:13:19: ICN001 `seaborn` should be imported as `sns`
defaults.py:14:19: ICN001 `seaborn` should be imported as `sns`
|
11 | import numpy as nmp # unconventional
12 | import pandas as pdas # unconventional
13 | import seaborn as sbrn # unconventional
12 | import numpy as nmp # unconventional
13 | import pandas as pdas # unconventional
14 | import seaborn as sbrn # unconventional
| ^^^^ ICN001
14 |
15 | import altair as alt # conventional
15 | import tkinter as tkr # unconventional
|
= help: Alias `seaborn` to `sns`

defaults.py:15:19: ICN001 `tkinter` should be imported as `tk`
|
13 | import pandas as pdas # unconventional
14 | import seaborn as sbrn # unconventional
15 | import tkinter as tkr # unconventional
| ^^^ ICN001
16 |
17 | import altair as alt # conventional
|
= help: Alias `tkinter` to `tk`