Preserve comments when sorting imports #749
Merged
Conversation
This file contains 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
charliermarsh
force-pushed
the
charlie/isort-comments
branch
3 times, most recently
from
72041bc
to
5ed4a4e
Compare
|
I'll add a few examples here tomorrow. |
|
There’s a slight Black incompatibility—Black requires this newline: import math
import os
# a comment
import pathlib
import syswhile Ruff deletes it: import math
import os
# a comment
import pathlib
import sys |
|
Comments seem to be unexpectedly counted toward the length of the following line in some cases, causing the following import to wrap early: import a
# ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
from b import c→ import a
# ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
from b import (
c,
) |
|
Woo thanks for trying! I noticed the second issue when running on Zulip :) It's late here so will fix these both tomorrow (then hopefully merge). |
|
Multi-line comments are unexpectedly sorted and deduplicated: import io
# Old MacDonald had a farm,
# EIEIO
# And on his farm he had a cow,
# EIEIO
# With a moo-moo here and a moo-moo there
# Here a moo, there a moo, everywhere moo-moo
# Old MacDonald had a farm,
# EIEIO
from errno import EIO→ import io
# And on his farm he had a cow,
# EIEIO
# Here a moo, there a moo, everywhere moo-moo
# Old MacDonald had a farm,
# With a moo-moo here and a moo-moo there
from errno import (
EIO,
) |
charliermarsh
force-pushed
the
charlie/isort-comments
branch
from
5ed4a4e
to
30a23b5
Compare
|
Ok, I believe all of those are addressed. Here's the diff on Zulip:
|
charliermarsh
force-pushed
the
charlie/isort-comments
branch
2 times, most recently
from
dba0f7f
to
f6e19e7
Compare
charliermarsh
force-pushed
the
charlie/isort-comments
branch
from
f6e19e7
to
deab5c8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It's tough to come up with a strategy that does the "right" thing in all cases (in part, because it's hard to even define the "right" output in every case), but this PR preserves all comments, is stable across re-runs, and tries to do sensible things when merging across imports.
Resolves #675.