-
-
Notifications
You must be signed in to change notification settings - Fork 654
Keep aliased import when the plain name carries a comment #2567
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.
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
Open
sarathfrancis90
wants to merge
1
commit into
PyCQA:main
Choose a base branch
from
sarathfrancis90:fix/aliased-import-dropped-when-name-has-comment
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+46
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -2117,3 +2117,34 @@ def test_noqa_wrap_mode_does_not_accumulate_spaces_with_as_import(): | |||
| first_pass, multi_line_output=7, force_single_line=True, line_length=40 | ||||
| ) | ||||
| assert second_pass == first_pass | ||||
|
|
||||
|
|
||||
| def test_isort_does_not_drop_aliased_import_when_plain_name_has_a_comment(): | ||||
| """A name imported both plainly and with an alias must keep its alias when the plain | ||||
| import carries a trailing comment and another member sorts ahead of it. | ||||
|
|
||||
| With default settings ``from x import m`` (commented) and ``from x import m as z`` are | ||||
| combined into one module group. The aliased ``m as z`` is only emitted by the loop that | ||||
| walks the *leading* aliased names, so it is reached only while ``m`` sits at the front of | ||||
| the group. When a sibling such as ``aaa`` sorts before ``m`` that loop never sees ``m``; | ||||
| the later "name has its own comment" pass then printed ``from x import m # c`` and | ||||
| removed ``m`` from the group, so ``m as z`` was silently dropped (and the output no longer | ||||
| re-sorted cleanly). The comment-bearing names that also have an alias must be left for the | ||||
| alias loop instead of being consumed here. | ||||
| """ | ||||
| to_sort = "from x import aaa\nfrom x import m # c\nfrom x import m as z\n" | ||||
| expected = "from x import aaa\nfrom x import m # c\nfrom x import m as z\n" | ||||
|
|
||||
| first_pass = isort.code(to_sort) | ||||
| assert first_pass == expected | ||||
| assert "m as z" in first_pass | ||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||
|
|
||||
| # The result must already be a fixpoint - the dropped alias previously only surfaced on | ||||
| # the second run. | ||||
| assert isort.code(first_pass) == first_pass | ||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can just use this and remove |
||||
|
|
||||
| # The same holds for a relative (local-folder) import. | ||||
| relative = "from . import bar, one\nfrom . import one as zzz # NOQA\n" | ||||
| relative_sorted = isort.code(relative) | ||||
| assert "one as zzz" in relative_sorted | ||||
| assert isort.code(relative_sorted) == relative_sorted | ||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a very verbose, AI-ey, comment which also refers to stuff that isn't happening (printing). Can you make it more to the point please?