Support find all references and rename with notebooks

[rchiodo]

Notebooks can pull in python imports into their cells.

Like so:

test.py:

def foo():
    print('foo')

test.ipynb: cell

import test
foo()

When writing a language server, it would be nice to support renaming and find all references such that these renames get applied to python cells in a notebook too.

In order for a language server to implement this it needs to predict the URI of cells in a notebook though. Otherwise the rename responses will have invalid URIs.

So this request is really to expose an API to give back the URI for cells of a notebook.

[rchiodo]

Or maybe the URI format needs to be part of the LSP specification? Otherwise, how would this list of renames work in say Visual Studio. The URI format of cells (I think?) is opaque to everyone except for VS code.

[rchiodo]

@rebornix why would this be a python issue? The notebook cell URI is encoded by VS code, it's the underlying issue with anybody being able to read notebooks when they're closed.

[rebornix]

@rchiodo I misread, sorry about that and now move back to VS Code.

The URI format of cells (I think?) is opaque to everyone except for VS code

I think this is intentional when designing the fragment.

[rchiodo]

I think this is intentional when designing the fragment.

I think this being the case makes it impossible for say Visual Studio to implement something like this. We could just copy the code that VS code has for computing cell fragments, but then Visual Studio would also have to have that same code.

I feel like the cell uri should be spec'd somewhere (like the LSP), then it would follow a consistent pattern for all parties involved.

[jrieken]

So this request is really to expose an API to give back the URI for cells of a notebook.

This exists via notebookCell.document.uri - no reason to specify the exact format of the uri. A working sample for rename and reference search can be found here: https://github.com/microsoft/vscode-github-issue-notebooks/blob/fe51aafec419dfa5ba99d2ed4795fcf2ea38e759/src/extension/languageProvider.ts#L130

it's the underlying issue with anybody being able to read notebooks when they're closed.

Given that you can read closed notebooks (aka plain text files) why do you need cell uris to begin with? You can just emit a "normal" text edit, right?

[rchiodo]

You can just emit a "normal" text edit, right?

Unless I'm missing something, the URI for the text edit would not be correct. Wouldn't it need the URI for the cell?

Or are you suggesting for closed files we don't use cells, we use the json to determine where the edit should go. We issue edits for the notebook itself.

That works for rename, but I don't think it would work for find all references? Would VS code be able to translate that location into a cell uri?

[rchiodo]

That example project you had looks like it's working with open notebooks. Not closed or just plain files on disk.