Skip to content

Add notebook document sync infrastructure for Jupyter support #664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
edvilme wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add notebook document sync infrastructure for Jupyter support #664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5db365
Add notebook document sync infrastructure for Jupyter support
edvilme Mar 10, 2026
38de393
Add notebook mock types to test_get_cwd.py
edvilme Mar 10, 2026
8b0307c
Fix mock type classes to accept keyword arguments
edvilme Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion bundled/tool/lsp_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,28 @@ def update_environ_path() -> None:
RUNNER = pathlib.Path(__file__).parent / "lsp_runner.py"

MAX_WORKERS = 5
NOTEBOOK_SYNC_OPTIONS = lsp.NotebookDocumentSyncOptions(
notebook_selector=[
lsp.NotebookDocumentFilterWithNotebook(
notebook="jupyter-notebook",
cells=[
lsp.NotebookCellLanguage(language="python"),
],
),
lsp.NotebookDocumentFilterWithNotebook(
notebook="interactive",
cells=[
lsp.NotebookCellLanguage(language="python"),
],
),
],
save=True,
)
LSP_SERVER = LanguageServer(
name="black-server", version="v0.1.0", max_workers=MAX_WORKERS
name="black-server",
version="v0.1.0",
max_workers=MAX_WORKERS,
notebook_document_sync=NOTEBOOK_SYNC_OPTIONS,
)


Expand Down
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@
"onLanguage:python",
"workspaceContains:pyproject.toml",
"workspaceContains:.black",
"workspaceContains:*.py"
"workspaceContains:*.py",
"onNotebook:jupyter-notebook",
"onNotebook:interactive"
],
"main": "./dist/extension.js",
"l10n": "./l10n",
Expand Down
18 changes: 15 additions & 3 deletions src/test/python_tests/test_get_cwd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ def feature(self, *args, **kwargs):
def command(self, *args, **kwargs):
return lambda f: f

def show_message_log(self, *args, **kwargs):
def window_log_message(self, *args, **kwargs):
pass

def show_message(self, *args, **kwargs):
def window_show_message(self, *args, **kwargs):
pass

mock_lsp_server = types.ModuleType("pygls.lsp.server")
Expand All @@ -48,6 +48,10 @@ def show_message(self, *args, **kwargs):
"INITIALIZE",
"EXIT",
"SHUTDOWN",
"NOTEBOOK_DOCUMENT_DID_OPEN",
"NOTEBOOK_DOCUMENT_DID_CHANGE",
"NOTEBOOK_DOCUMENT_DID_SAVE",
"NOTEBOOK_DOCUMENT_DID_CLOSE",
]:
setattr(mock_lsp, _name, _name)
for _name in [
Expand All @@ -56,13 +60,21 @@ def show_message(self, *args, **kwargs):
"DidCloseTextDocumentParams",
"DidOpenTextDocumentParams",
"DidSaveTextDocumentParams",
"DidChangeNotebookDocumentParams",
"DidCloseNotebookDocumentParams",
"DidOpenNotebookDocumentParams",
"DidSaveNotebookDocumentParams",
"DocumentFormattingParams",
"InitializeParams",
"NotebookCellKind",
"NotebookCellLanguage",
"NotebookDocumentFilterWithNotebook",
"NotebookDocumentSyncOptions",
"Position",
"Range",
"TextEdit",
]:
setattr(mock_lsp, _name, type(_name, (), {}))
setattr(mock_lsp, _name, type(_name, (), {"__init__": lambda self, **kw: None}))
mock_lsp.MessageType = type(
"MessageType", (), {"Log": 4, "Error": 1, "Warning": 2, "Info": 3}
)
Expand Down