VSCode: Python Sort Imports on File Save (isort)

vscode_python_sort_imports_isort_on_save.md

VSCode: Python Sort Imports on File Save (isort)

Problem

VSCode does have support to sort imports inside a .py file using isort. The recommended way to turn this on is via the following settings:

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

Sadly, this seems to ignore anything configured in python.sortImports.args and produces different and buggy results (e.g. duplicate imports) on subsequential runs.

Calling the Sort Imports command manually inside the UI works flawlessly, so I've tried to instead do:

"[python]": {
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
        "python.sortImports": true,
    },
}

However this has no effect, probably because python.sortImports is not properly identified as a valid code action to trigger (?). Maybe it's a bug.

Workaround

We can still make this work though. Using the multicommand extension we can define a "Save File" command targetting python files in which we call the "Sort Imports" beforehand.

Add the following to your settings:

"multiCommand.commands": [
  {
    "command": "multiCommand.saveFileAndSortImportsWhenPython",
    "sequence": [
      "python.sortImports",
      "workbench.action.files.save"
    ]
  }
]

And configure a new keybinding for it that will take precedence over the default save-file command when working on a Python file:

{
  "command": "multiCommand.saveFileAndSortImportsWhenPython",
  "key": "ctrl+s",
  "when": "resourceLangId == 'python'"
}

Done! Your imports are sorted properly now and will respect any additional settings :)

For compatibility with black see: https://pycqa.github.io/isort/docs/configuration/black_compatibility/

By the way, these settings seem to play nicely together with black, which is also supported natively by vscode's python extension:

"python.sortImports.args": [
    "--trailing-comma",
    "--force-grid-wrap", "0",
    "--use-parentheses",
    "--force-single-line-imports",
    "--line-width", "88",
    "--multi-line", "3",
    "--float-to-top"
],

The better way would be to reuse the exact configuration by pointing vscode to the directory that contains one of the possible config files (.isort.cfg, tox.ini, setup.cfg):

"python.sortImports.args": [
    "--settings-path", "${workspaceFolder}",
],

Thanks for this, I was looking to fix the terrible default behavior of organize imports, and your python.sortImports.args section really helped with that.

After experimenting with the editor.codeActionsOnSave some more, this seems to organize the imports on save without having to make a custom command:

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

source.organizeImports is identified as a valid command, and works fine in my case. I am using Pylance as linting server. I'm not sure if that has anything to do with it but at least this works.

Thank you for sharing this! Could you please let me know where can I find all the options available to pass inside "python.sortImports.args"?
I would love to force the formatter to arrange imports indented and vertically aligned, like so:

from some_module import (
  something,
  something_else,
  yet_some_other,
)

But I cannot find the source of this information. Thank you!

@GBrachetta Those options are taken from theisort CLI which you can get help on via:

$ pip install isort
$ isort --help

Thank you, that helped a lot! :)

Hey, thanks for your trials and helpful settings.
I've encountered the very same issue.
Have you opened an issue for that "bug"? I think we should unite and request a fix.

VSCode ignores "python.sortImports": true, key, and for example on the creation of RemoteContainerEnv - completely ignores that setting key in resulting VSCode settings. (i.e. not includes, drops)

Also both blakc and isort can be configured together in a single pyproject.toml in the project's root.

Also potentially with modern isort everything should work without explicitly configuring it but just passing --profile=black to isort.

UPD
Found related issue microsoft/vscode-python#7042

I only had to do 2 things. Use the vscode settings here https://eshlox.net/2019/12/02/vscode-sort-python-imports-automatically

That made import sorting happen automatically on save. I use black for formatting so I also had to create a config file for isort to set the profile to black. Details here https://pycqa.github.io/isort/docs/configuration/black_compatibility.html