Feature request: Ship isort 5

[bersbersbers]

I was trying out

"python.sortImports.args": [
        "--profile",
        "black",
    ],

today, which promises better compatibility between isort and black. However, it seems that the extension ships with an older version of isort that does not support these flags.

user@host:~/.vscode-server/extensions/ms-python.python-2020.6.91350/pythonFiles/lib/python/isort> grep version __init__.py
__version__ = "4.3.21"

Even worse, adding these flags leads to endless "Saving xyz.py: Applying code action 'Sort imports'."

Shipping isort>=5 should solve this.

[karthiknadig]

@bersbersbers isort shipped 5.* in July. Looks like they have been rapidly releasing new versions almost everyday. Which tells me this is not stable yet. We will update to latest isort once we see that it is stable.

[janosh]

I've been using isort 5 since it's release date and had no issues at all. In fact, it's been a major improvement in all respects! Really looking forward to it shipping with the Python extension!

[karrtikr]

Unexpected changes with upgrading isort:

• In isort usage:
  Change in isort usage from 4 to 5 is a bit unexpected PyCQA/isort#1363
  For instance, settings path is now specified using --sp instead of -sp. We have a setting python.sortImports.args through which users pass arguments to the isort command we run. If we upgrade isort it'll break settings for all those users as many old flags are no longer valid.

• In isort results:
  Change in isort result from 4 to 5 PyCQA/isort#1364
  In isort 5, it looks like imports are sorted in groups by default. A feature request we might consider: Add an option to collect all imports at the top #13283

Changes we'll have to make:

• Remove old workaround used with isort 4:
  In sortImports.py, remove the following change: fc34f9c
  isort5 expects stdin stream to be of type string, not byte. And the workaround converts stream to bytes, so we have an error when upgrading. From my understanding, the workaround was added because of No output when stdin used on Windows PyCQA/isort#1195 with isort4, but isort5 doesn't have that issue, so we can remove it. cc @PeterJCLaw

• Change tests which accept old arguments:
  Some tests in extension.sort.test.ts have specified -sp in args which will need to be changed to --sp given the new usage.

• Change tests which expect old results:
  Some tests in extension.sort.test.ts expects old results, which are now outdated. Change the tests to compare against the new value.

• Do something to migrate user arguments in python.sortImports.args setting & the config file ???:
  Users maybe using certain flags like -sp which needs to be updated to --sp, else their setting would break. It's probably worth it to point users to the upgrade guide.
  UPDATE: Show a general warning prompt pointing to the upgrade guide, in case we see any warnings related to deprecation from isort.

[PeterJCLaw]

• Remove old workaround used with isort 4:
  In sortImports.py, remove the following change: fc34f9c
  isort5 expects stdin stream to be of type string, not byte. And the workaround converts stream to bytes, so we have an error when upgrading. From my understanding, the workaround was added because of timothycrosley/isort#1195 with isort4, but isort5 doesn't have that issue, so we can remove it. cc @PeterJCLaw

Yup, that's correct regarding the workaround. If isort>=5 has fixed the Windows stdin issue on its own then that workaround can be dropped. (I don't tend to develop on Windows, so haven't tested that).
It was the vscode-python CI which originally found the issue, so if the CI is happy everything should be fine.

[bersbersbers]

Since this bug is receiving attention from #12949, I should note that the endless "Sorting imports" may have been that exact bug (#12949), namely, using a too recent version of setuptools. I can further test this if required.