Initial support for notebook document sync methods

[alcarney]

Description (e.g. "Related to ...", etc.)

This is a first pass at implementing support for the notebookDocument/did* group of messages from the LSP spec.

• This PR depends on a future version of lsprotocol that has some additional fixes
  (see Missing structure hook(s?) for notebook types  microsoft/lsprotocol#228, Unable to structure NotebookDocumentSyncOptions microsoft/lsprotocol#259)

• Servers can advertise support for notebooks by passing an instance of NotebookDocumentSyncOptions to the LanguageServer constructor. e.g. from the inlay_hints.py server

  server = LanguageServer(
      name="inlay-hint-server",
      version="v0.1",
      notebook_document_sync=types.NotebookDocumentSyncOptions(
          notebook_selector=[
              types.NotebookDocumentSyncOptionsNotebookSelectorType2(
                  cells=[
                      types.NotebookDocumentSyncOptionsNotebookSelectorType2CellsType(
                          language="python"
                      )
                  ]
              )
          ]
      ),
  )

• Notebooks as a whole are represented using instances of the NotebookDocument class that comes from lsprotocol

• Like regular text documents, notebook cell contents are represented as instances of pygls.workspace.TextDocument (previously called Document)

• Notebooks can be accessed from the Workspace using the new workspace.get_notebook_document() method either

  • by passing the notebook_uri of the notebook itself or
  • by passing cell_uri of one of the text documents representing the contents of a cell in the notebook

• Currently this is the only notebook specific method exposed to server authors - @karthiknadig let me know if you have anything specific you'd like pygls to handle/provide

• Generic references to "document" have been renamed to "text_document" so that it's clear which kind of document a method/object is referring to. Old names still work, but emit deprecation warnings where possible - see 9034bdb

• The example inlays_hints.py server has been updated to support notebooks.
  # characters on a line on their own are annotated with the notebook's uri and index of the cell it resides in - let me know if you can think of a more interesting demonstration of the notebook support! 😅

Closes #311

Code review checklist (for code reviewer to complete)

• Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
• Title summarizes what is changing
• Commit messages are meaningful (see this for details)
• Tests have been included and/or updated, as appropriate
• Docstrings have been included and/or updated, as appropriate
• Standalone docs have been updated accordingly

[alcarney]

This is probably good enough to merge now, I expect the best way to get some feedback is to get this out there in a release so people can try it out

Any thoughts?

[karthiknadig]

Should this remain Incremental?

[karthiknadig]

I think this will break servers. Many of the servers I have written assume this is set to Incremental by default.

[alcarney]

It should've been ok, since this is the base Server class where I don't think this was really used.
It's also set by the LanguageServer constructor.

That said, I don't think we gain anything from changing this so I've rolled it back anyway 😄

[tombh]

Let's merge this then? Would be good to get the confirmation from Karthik, but sounds like you're happy Alex?

[alcarney]

but sounds like you're happy Alex?

Yes :)