Wrong sorting of imports

Question

Wrong sorting of imports

hexvolt opened this issue 7 months ago · 20 comments

Describe the bug
The sorting of imports is not consistent with ruff CLI output.

The plugin is awesome but when it is enabled, it highlights the imports that are sorted properly by categories. If I reformat the code using the plugin, it rearranges the imports in some weird order (3rd party packages being mixed with the local code packages), which is totally different from what ruff check --select I --fix does. So if sort imports properly with the external command ruff check --select I --fix, then the plugin complains on my imports and tries to rearrange them back.

So in order to use the plugin I have to either cope with seeing yellow highlights on all (properly sorted) imports, or give up proper sorting and let plugin do the weird sorting.

To Reproduce
Steps to reproduce the behavior:

Open a python file of any project, that has imports of 3rd party packages, as well as Python built-ins, and imports of local code
Reformat the code using the plugin.
See how the order of imports are mixed up, and the categories are NOT maintained properly (built-ins, 3rd-party, local)
Now in the CLI run the official ruff command for sorting imports ruff check --select I --fix
See how the imports got sorted properly.

Expected behavior
The plugin should yield the same results of imports sorting as the official ruff command ruff check --select I --fix.

Screenshots

You can see how imports sorted properly by the ruff check --select I --fix command are highlighted by the plugin with yellow, while it shouldn't.

And this is the order plugin thinks is correct but it's not.

Environments (please complete the following information):

IDE: PyCharm 2024.1 (Professional Edition)
OS: MacOS Sonoma 14.4
Ruff Version 0.1.15
Plugin version 0.0.33

Notes:

The plugin sees the pyproject.toml file (specified in the settings).
There is nothing in my pyproject.toml file about custom sorting rules or anything like that.

UPDATE
Noteworthy is that if I remove the reference to the pyproject.toml file in the plugin settings, it does sorting correctly. But in that case it ignores all other settings like line length etc.

Answer 1 · 2024-04-18T22:16:51.000Z

I had this issue when using ruff-lsp. Disabling that option in the plugin settings fixed this.

It seemed that somehow the lsp was not picking up (some of) the options which I set in my pyproject.toml file. I suspect the version of lsprotocol has to do with this, although I did not test this very extensively.

I had the following packages installed (managed by Poetry):

ruff: 0.3.7
ruff-lsp: 0.0.53
lsprotocol: 2023.0.1

Perhaps this could give a starting point for fixing this bug.

Answer 2 · 2024-04-22T16:15:12.000Z

Thanks. As to my setup, ruff-lsp is not used.

Answer 3 · 2024-05-10T20:07:03.000Z

I'm also seeing this behaviour. @hexvolt Did you find a workaround?

Answer 4 · 2024-05-28T16:59:30.000Z

@TimChild Nope, unfortunately I have to live with yellow warning around every import block:( To me, this is clearly a pretty major bug, idk why it is not labeled as such yet

Answer 5 · 2024-06-12T09:00:22.000Z

Happens to me as well. Since my imports are now always out of order, I always have to use the command line as well to fix it before I commit any files :(

Answer 6 · 2024-08-30T14:50:29.000Z

disabling ruff-lsp option eliminated the massive warning block (thanks @jellehierck). it still organizes on save, so I can make do with that for now.

Answer 7 · 2024-09-10T08:12:28.000Z

Same issue here, saving/reformatting files changes the import order. Currently I'm just running a tiny script that does a ruff check --fix and ruff format when I'm done changing files. It would be great if the plugin behaviour could be aligned with the CLI interface.

Environments (please complete the following information):
IDE: PyCharm 2024.2.1 (Professional Edition)
OS: MacOS Sonoma 14.6.1
Ruff Version 0.6.4
Plugin version 0.0.36

Answer 8 · 2024-09-11T08:38:38.000Z

For me and my team this bug is currently most annoying because we have to reformat the files with the command line, and can not solely rely on the IntelliJ plugin :(

Answer 9 · 2024-09-11T21:20:47.000Z

@cm253 I feel your pain. It's a shame @JetBrains haven't implemented their own solution, they seem to have some half-assed integration of ruff, but the way everything works together is we have the entire project flooded with warnings just because of the bug in the imports check. I'm considering disabling code check tools altogether since there is no proper integration with ruff, and I need to use CLI anyway. The fact such a fundamental feature of IDE still does not work properly after ruff being around for 2 years is such a shame.

Answer 10 · 2024-09-12T11:04:02.000Z

I wonder if this format support is managed with LSP?

If yes the problem comes from the ruff language server or from LSP4IJ.

If it comes from LSP4IJ I could investigate the problem.

Answer 11 · 2024-09-12T11:07:42.000Z

This is my IntelliJ configuration, I don't use Ruff LSP:

Answer 12 · 2024-09-12T11:24:54.000Z

I wonder if this format support is managed with LSP?

If yes the problem comes from the ruff language server or from LSP4IJ.

If it comes from LSP4IJ I could investigate the problem.

The problem is that the plugin wrongly re-orders imports, the highlighting and detection of the errors is done correctly at all times.

Answer 13 · 2024-09-12T11:29:23.000Z

Ok thanks for your feedback, I though it was a problem from LSP4IJ and in this case I though I could investigate the problem.

Answer 14 · 2024-09-12T11:32:54.000Z

Ok thanks for your feedback, I though it was a problem from LSP4IJ and in this case I though I could investigate the problem.

At least that's the case for me, other users might have a slightly different issue.

Answer 15 · 2024-09-12T16:08:25.000Z

The problem is that the plugin wrongly re-orders imports, the highlighting and detection of the errors is done correctly at all times.

@jeroenbrouwer no, for me that's not the case unfortunately, please see the screenshots ^

You can see how imports sorted properly by the ruff check --select I --fix command are highlighted by the plugin with yellow, while it shouldn't.

Correctly sorted imports are wrongly highlighted, until I disable the plugin altogether.
Which essentially means, either you have no ruff in PyCharm at all (if you don't want false positive highlighting), or you have ruff but wrong highlights.

Answer 16 · 2024-09-13T11:39:47.000Z

The problem is that the plugin wrongly re-orders imports, the highlighting and detection of the errors is done correctly at all times.

@jeroenbrouwer no, for me that's not the case unfortunately, please see the screenshots ^

You can see how imports sorted properly by the ruff check --select I --fix command are highlighted by the plugin with yellow, while it shouldn't.

Correctly sorted imports are wrongly highlighted, until I disable the plugin altogether. Which essentially means, either you have no ruff in PyCharm at all (if you don't want false positive highlighting), or you have ruff but wrong highlights.

Then there seem to be multiple issues related to the ordering of imports, hopefully they can all be fixed 🤞

Answer 17 · 2024-10-10T16:04:47.000Z

I found a workaround that works for my setup. I have a .ruff.toml file at the root of my Python project that looks like this:

line-length = 120

[lint]
select = ["E4", "E7", "E9", "F", "I"]
ignore = ["E721"]

When I click "Reformat Code" in PyCharm, I see the imports being changed twice! First pass is ruff, second pass is PyCharm. I went ahead and disabled "Optimize imports" in the "Reformat File..." dialog.

Now, whenever I hit "Reformat Code", only ruff re-orders the imports. Seems like the plugin should disable PyCharm's built-in reorder feature whenever it's installed.