Notebook (notebook.*) code actions does not work when first cell is markdown

[bolliger32]

It took me a little while, but I finally figured out the use of notebook.source.fixAll and notebook.source.organizeImports settings (instead of their source.* counterparts) to prevent vscode from turning my import cells in jupyter notebooks into gibberish when using ruff as the formatter. However, it appears that when a notebook starts with a markdown cell (say, to title the notebook) and then has a python cell with imports after the markdown, notebook.source.organizeImports doesn't work. Here are my relevant vscode settings:

{
    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
        "source.organizeImports": "explicit",
        "source.fixAll": "explicit"
    },
    "notebook.defaultFormatter": "charliermarsh.ruff",
    "notebook.formatOnSave.enabled": true,
    "notebook.codeActionsOnSave": {
        "notebook.source.organizeImports": "explicit",
        "notebook.source.fixAll": "explicit"
    }
}

And here's the relevant part of my pyproject.toml file in the workspace open in vscode:

[tool.ruff.lint]
unfixable = ["F401"]
select = ["E4", "E7", "E9", "F", "NPY", "I"]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["E402"]

[tool.ruff.format]
docstring-code-format = true

I'm using ruff 0.6.2.

Side Note:
If I use source.organizeImports instead of notebook.source.organizeImports, it "works" in the sense that something happens, but the effect is to introduce gibberish. Here's an example of the "gibberish" that occurs when using source.* instead of notebook.source.*. The first screenshot is from "pre-save", the second is after saving once, and the third after saving a second time

[dhruvmanila]

Huh, that is indeed the case. I wonder if it's a bug in VS Code, let me check if the editor is sending the request in the first place.

[dhruvmanila]

Hmm, VS Code isn't sending the code action request when a markdown cell is present. This is a bit worrying and could be related to the notebook selector filter here: https://github.com/astral-sh/ruff/blob/3e9c7adeeee639043686a1717a1683f6620efd2a/crates/ruff_server/src/server.rs#L335-L344

[dhruvmanila]

Let me look at this later today. Thanks for raising this issue!

[bolliger32]

Thanks for taking a look so quickly!

[dhruvmanila]

This might be related to microsoft/vscode#216653

[Riezebos]

@bolliger32 Thanks for mentioning "notebook.source.organizeImports" as a replacement for "source.organizeImports"! I had no idea this existed, and since a few weeks I've had a bunch of import cells in notebooks turn to gibberish as well. It was quite annoying as the Undo action would also not consistently restore the original version.

[matt-dies-tenet3]

I commented on the potentially related issue as well, but I'm experiencing the same issue; manually saving kicks off the importing, but doesn't actually organize the imports and instead creates gibberish.

Important to note though, our setup uses the following, unlike the original poster:

"notebook.formatOnSave.enabled": true,
"notebook.codeActionsOnSave": {
    "source.organizeImports": "explicit"
},

Unfortunately, the VSCode issue doesn't seemed to have gained any traction quite yet, but fingers crossed!

[dhruvmanila]

@Riezebos Does your issue gets resolved when using notebook.source.organizeImports instead of source.organizeImports?

@matt-dies-tenet3 Can you try doing the same? Use notebook.source.organizeImports.ruff instead of source.organizeImports?

[Riezebos]

@dhruvmanila yes, using notebook.source.organizeImports instead of source.organizeImports inside of "notebook.codeActionsOnSave" stopped imports from becoming gibberish.

[MichaReiser]

Has the VS code extension access to the notebook.codeActionsOnSaveSetting so that we could show a warning / info message and recommend users to use notebook.source.organizeImports instead?

For anyone running into this. You can help that microsoft/vscode#216653 gains traction by upvoting it (please no +1 Comments)

[dhruvmanila]

Has the VS code extension access to the notebook.codeActionsOnSaveSetting so that we could show a warning / info message and recommend users to use notebook.source.organizeImports instead?

Yes, it should. Although I want to look into why ruff-lsp isn't facing the same issue.

[matt-dies-tenet3]

Using the following also works consistently!

"notebook.formatOnSave.enabled": true,
"notebook.codeActionsOnSave": {
    "notebook.source.organizeImports.ruff": "explicit"
},

[dhruvmanila]

Oh wow, I just found out this:

note: if you are linking your provider to a selector that only runs against code cells, this will likely break functionality, as markdown cells are often the leading cell in notebooks. This behavior will be explored during next debt week.

microsoft/vscode#179213 (comment)

which is basically what is happening here.

[dhruvmanila]

cc @Yoyokrazy, apologies for the ping but if possible could you clarify if this was discussed further as I couldn't find any related issues.

We're facing this issue here as we do select only Python code cells during initialization:

https://github.com/astral-sh/ruff/blob/6e34f74c164a646f07f3fe9bed9492c3557a95d7/crates/ruff_server/src/server.rs#L320-L329

[lethefrost]

It recently stopped working in jupyter notebook... Even when manually triggered by command, it still says no available imports organizer found. In the meanwhile, the formatting/linting features of ruff work well as normal in jupyter. And in regular python files, the imports organizer could be found. Has anyone else also run into the same issue?

[dhruvmanila]

Even when manually triggered by command, it still says no available imports organizer found. In the meanwhile, the formatting/linting features of ruff work well as normal in jupyter. And in regular python files, the imports organizer could be found.

IIUC, this seems unrelated to what's being discussed here. Do you mind opening a new issue with all the details (refer to troubleshooting guide).

[dhruvmanila]

I might try changing the notebook selector to include markdown cells on syncing, I think the server should be able to handle it.

[dhruvmanila]

I might try changing the notebook selector to include markdown cells on syncing, I think the server should be able to handle it.

Nope, this doesn't seem to work either. I've tried the following NotebookDocumentSyncOptions but none of them allows VS Code to send us the notebook source code action request but when I rearrange cells such that the first cell is a code cell then it works:

        "notebookDocumentSync": {
            "notebookSelector": [
                {
                    "cells": [
                        {
                            "language": "python"
                        },
                        {
                            "language": "markdown"
                        }
                    ],
                    "notebook": {
                        "notebook_type": "jupyter-notebook"
                    }
                }
            ],
            "save": false
        },

        "notebookDocumentSync": {
            "notebookSelector": [
                {
                    "cells": [
                        {
                            "language": "python"
                        },
                        {
                            "language": "markdown"
                        }
                    ]
                }
            ],
            "save": false
        },

        "notebookDocumentSync": {
            "notebookSelector": [
                {
                    "cells": [
                        {
                            "language": "*"
                        }
                    ]
                }
            ],
            "save": false
        },