Sort imports on save is very buggy

[DonJayamanne]

Problems:

• Lines go missing
• Keeps sorting imports even when there are no changes
  (add 4-5 imports with relative imports, every time you save, the imports get formatted differently)

[DavidArchibald]

I'm unable to reproduce any of these behaviors. However I do sometimes find that import will be seemingly repeated for a second and then fixed, but even that is pretty rare. I use these settings:

"[python]": {
    "editor.codeActionsOnSave": {
        "source.organizeImports": true
    }
}

I've been using them for some time without much issue, but I only used a clean environment with those exact settings for a bit so I could've missed those glitches. In case it's specific to your settings, could you verify if they are the same or different?

[cb109]

Workaround: https://gist.github.com/cb109/47496649640c9c5f4287b06db7a7c197

[MapleCCC]

Encountered same issue. Every time pressed Ctrl-S, imports get formatted differently. Quickly pressing multiple Ctrl-S even causes the file to be seemingly modified concurrently by two sorting processes, and in turn causes import statements to be messy or deleted.

I think the behaviour I saw is similar to the one presented in #8245 .

[pcko1]

This issue is still there for VSCode v1.41.1.

Right click + Sort imports works fine but subsequent sorting on save keeps reformatting the imports or even arbitrarily deleting some (!)

[iutlu]

Hello, I was looking at the linked issues, and it looks like the main isort inconsistency / data loss issues reported are:

1. isort not picking up the correct config: Sorting of imports (isort) is different if the file has unsaved modifications #4891, isort not honoring setup.cfg #5840, "organize imports" is inconsistent depending on whether the file is saved or not #8245
2. Repeated invocations of isort corrupting code: Running organize imports quickly ends up corrupting code #10579
3. A race condition between format-and-save and sort-on-save: Organize imports and formatters are conflicting due to a race condition vscode#83586 (comment), which is reported to have been fixed (?)

I was wondering if the current issue is a separate issue from the above three and if so whether it's still ongoing. Thanks!

[mattstrayer]

Was trying to get isort working on-save using the latest vscode-python/pylance setup.

As of now this settings.json config works, but the file gets written to twice in the process, so you see a flicker between when it sorts the imports and when it formats with black.

    "python.formatting.provider": "black",
    "python.languageServer": "Pylance",
 
    "[python]": {
        "editor.formatOnSave": true,
        "editor.defaultFormatter": "ms-python.python",
        "editor.tabSize": 4,     
        "editor.codeActionsOnSave": {
            "source.organizeImports": true
        }   
    },

Would be ideal to pipe each stage into the next for a clean single UI update/file save.

It is most noticeable when there's a tuple of imports.... like:

from .models import (
    Model1,
    Model2
    Model3,
    Model4,
    Model5,
    Model6,
    Model7,
    Model8,
    Model9,
    Model10,
)

You see the sorting happen and the imports get compressed to a line or two, and then black will format the newly sorted imports.

[karrtikr]

Related: #5748

[Zacharias030]

The sorting imports functionality is a mess :|