Support for ipynb Notebooks

[karthiknadig]

New version of pygls is coming out, with significant breaking changes and several new features.

• Notebook document and notebook content synchronization
• pygls has utilities to deal with cells and manage cells.

[seeM]

@pappasam would you be open to a PR with the approach outlined below?

The overall idea is to concatenate the cell sources and update the cursor position from the position in the cell to the position in the concatenated notebook.

More specifically:

1. Advertise support for notebooks by adding the following to the server init:

    # Advertise support for Python notebook cells.
    notebook_document_sync=NotebookDocumentSyncOptions(
        notebook_selector=[
            NotebookDocumentSyncOptionsNotebookSelectorType2(
                cells=[NotebookDocumentSyncOptionsNotebookSelectorType2CellsType(language="python")]
            )
        ]
    ),

2. Update jedi_utils.script to get the concatenated source of the whole notebook if document is a cell text document. I assume we can leave document.path as is?
3. Update jedi_utils.line_column to also accept the document, and if it's a cell, return the position in the concatenated notebook.
4. General idea for tests is to have notebooks which define a variable in one cell and complete/hover/etc the variable in the next cell.

[pappasam]

Sure, I'm open to considering a PR with this approach! Are there any usability downsides that you anticipate?

[seeM]

Oh, I forgot that we'd also need to convert Positions back to cell-relative in any returned locations.

Are there any usability downsides that you anticipate?

I don't anticipate any usability downsides. Text documents should behave exactly as before the change. Notebooks should have the added benefit of having the full source available for static analysis.

I doubt that concatenating sources and converting Positionss would be much of a performance hit.

What do you think?

[pappasam]

Go for it!