Skip to content

Add example useless-import-alias message documentation #6151

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
Pierre-Sassoulas merged 8 commits into from
Apr 3, 2022
Merged

Add example useless-import-alias message documentation #6151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fb4eadb
add example `uselesss-import-alias`
gunungpw Apr 3, 2022
47752ac
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 3, 2022
17d235c
Update bad.py
gunungpw Apr 3, 2022
b17e25e
add issue #6006
gunungpw Apr 3, 2022
6242682
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 3, 2022
45b0c6f
Apply suggestions from code review
Pierre-Sassoulas Apr 3, 2022
afa1e66
Apply suggestions from code review
Pierre-Sassoulas Apr 3, 2022
41c7540
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 3, 2022
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
1 change: 1 addition & 0 deletions doc/data/messages/u/useless-import-alias/bad.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import pandas as pandas # [useless-import-alias]
8 changes: 8 additions & 0 deletions doc/data/messages/u/useless-import-alias/details.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Known issue
-----------

If you prefer to use "from-as" to explicitly reexport in API (`from fruit import orange as orange`)
instead of using `__all__` this message will be a false positive.

If that's the case use `pylint: disable=useless-import-alias` before your imports in your API files.
`False positive 'useless-import-alias' error for mypy-compatible explicit re-exports #6006 <https://github.com/PyCQA/pylint/issues/6006>`_
1 change: 1 addition & 0 deletions doc/data/messages/u/useless-import-alias/good.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import pandas as pd
3 changes: 3 additions & 0 deletions doc/data/messages/u/useless-import-alias/related.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* `PEP 8, Import Guideline <https://peps.python.org/pep-0008/#imports>`_
* `Pylint block-disable <https://pylint.pycqa.org/en/latest/user_guide/message-control.html#block-disables>`_
* `mypy --no-implicit-reexport <https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-no-implicit-reexport>`_
⚡