pytest-lsp: Migrate to pygls v2

lib/pytest-lsp/hatch.toml

@@ -1,3 +1,6 @@
+[metadata]
+allow-direct-references = true
+
 [version]
 path = "pytest_lsp/client.py"
 validate-bump = false

lib/pytest-lsp/pyproject.toml

@@ -7,17 +7,16 @@ name = "pytest-lsp"
 dynamic = ["version"]
 description = "A pytest plugin for end-to-end testing of language servers"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = { text = "MIT" }
 authors = [{ name = "Alex Carney", email = "alcarneyme@gmail.com" }]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "License :: OSI Approved :: MIT License",
     "Framework :: Pytest",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -26,7 +25,7 @@ classifiers = [
 dependencies = [
     "importlib-resources; python_version<\"3.9\"",
     "packaging",
-    "pygls>=1.1.0",
+    "pygls @ git+https://github.com/openlawlibrary/pygls@main",
     "pytest",
     "pytest-asyncio>=0.23",
 ]

lib/pytest-lsp/pytest_lsp/checks.py

@@ -261,7 +261,7 @@ def work_done_progress_create(
 @check_params_of(method=types.WORKSPACE_CONFIGURATION)
 def workspace_configuration(
     capabilities: types.ClientCapabilities,
-    params: types.WorkspaceConfigurationParams,
+    params: types.ConfigurationParams,
 ):
     """Ensure that the client has support for ``workspace/configuration`` requests."""
     is_supported = get_capability(capabilities, "workspace.configuration", False)

lib/pytest-lsp/tests/examples/client-capabilities/server.py

@@ -4,7 +4,7 @@
     CompletionParams,
     InsertTextFormat,
 )
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("hello-world", "v1")
 

lib/pytest-lsp/tests/examples/diagnostics/server.py

@@ -1,28 +1,24 @@
-from lsprotocol.types import (
-    TEXT_DOCUMENT_DID_OPEN,
-    Diagnostic,
-    DidOpenTextDocumentParams,
-    Position,
-    Range,
-)
-from pygls.server import LanguageServer
+from lsprotocol import types
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("diagnostic-server", "v1")
 
 
-@server.feature(TEXT_DOCUMENT_DID_OPEN)
-def did_open(ls: LanguageServer, params: DidOpenTextDocumentParams):
-    ls.publish_diagnostics(
-        params.text_document.uri,
-        [
-            Diagnostic(
-                message="There is an error here.",
-                range=Range(
-                    start=Position(line=1, character=1),
-                    end=Position(line=1, character=10),
-                ),
-            )
-        ],
+@server.feature(types.TEXT_DOCUMENT_DID_OPEN)
+def did_open(ls: LanguageServer, params: types.DidOpenTextDocumentParams):
+    ls.text_document_publish_diagnostics(
+        types.PublishDiagnosticsParams(
+            uri=params.text_document.uri,
+            diagnostics=[
+                types.Diagnostic(
+                    message="There is an error here.",
+                    range=types.Range(
+                        start=types.Position(line=1, character=1),
+                        end=types.Position(line=1, character=10),
+                    ),
+                )
+            ],
+        )
     )
 
 

lib/pytest-lsp/tests/examples/fixture-passthrough/server.py

@@ -1,5 +1,5 @@
 from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("hello-world", "v1")
 

lib/pytest-lsp/tests/examples/fixture-scope/server.py

@@ -1,5 +1,5 @@
 from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("hello-world", "v1")
 

lib/pytest-lsp/tests/examples/generic-rpc/server.py

@@ -1,27 +1,29 @@
 from pygls.protocol import JsonRPCProtocol, default_converter
-from pygls.server import Server
+from pygls.server import JsonRPCServer
 
-server = Server(protocol_cls=JsonRPCProtocol, converter_factory=default_converter)
+server = JsonRPCServer(
+    protocol_cls=JsonRPCProtocol, converter_factory=default_converter
+)
 
 
-@server.lsp.fm.feature("math/add")
-def addition(ls: Server, params):
+@server.feature("math/add")
+def addition(ls: JsonRPCServer, params):
     a = params.a
     b = params.b
 
-    ls.lsp.notify("log/message", dict(message=f"{a=}"))
-    ls.lsp.notify("log/message", dict(message=f"{b=}"))
+    ls.protocol.notify("log/message", dict(message=f"{a=}"))
+    ls.protocol.notify("log/message", dict(message=f"{b=}"))
 
     return dict(total=a + b)
 
 
-@server.lsp.fm.feature("math/sub")
-def subtraction(ls: Server, params):
+@server.feature("math/sub")
+def subtraction(ls: JsonRPCServer, params):
     a = params.a
     b = params.b
 
-    ls.lsp.notify("log/message", dict(message=f"{a=}"))
-    ls.lsp.notify("log/message", dict(message=f"{b=}"))
+    ls.protocol.notify("log/message", dict(message=f"{a=}"))
+    ls.protocol.notify("log/message", dict(message=f"{b=}"))
 
     return dict(total=b - a)
 

lib/pytest-lsp/tests/examples/getting-started-fail/server.py

@@ -1,5 +1,5 @@
 from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("hello-world", "v1")
 

lib/pytest-lsp/tests/examples/getting-started/server.py

@@ -1,5 +1,5 @@
 from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("hello-world", "v1")
 

lib/pytest-lsp/tests/examples/parameterised-clients/server.py

@@ -1,5 +1,5 @@
 from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("hello-world", "v1")
 

lib/pytest-lsp/tests/examples/server-stderr/server.py

@@ -1,7 +1,7 @@
 import sys
 
 from lsprotocol import types
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("server-stderr", "v1")
 

lib/pytest-lsp/tests/examples/window-create-progress/server.py

@@ -1,7 +1,7 @@
 from unittest.mock import Mock
 
 from lsprotocol import types
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("window-create-progress", "v1")
 
@@ -10,21 +10,21 @@
 async def do_progress(ls: LanguageServer, *args):
     token = "a-token"
 
-    await ls.progress.create_async(token)
+    await ls.work_done_progress.create_async(token)
 
     # Begin
-    ls.progress.begin(
+    ls.work_done_progress.begin(
         token,
         types.WorkDoneProgressBegin(title="Indexing", percentage=0),
     )
     # Report
     for i in range(1, 4):
-        ls.progress.report(
+        ls.work_done_progress.report(
             token,
             types.WorkDoneProgressReport(message=f"{i * 25}%", percentage=i * 25),
         )
     # End
-    ls.progress.end(token, types.WorkDoneProgressEnd(message="Finished"))
+    ls.work_done_progress.end(token, types.WorkDoneProgressEnd(message="Finished"))
 
     return "a result"
 
@@ -34,30 +34,30 @@ async def duplicate_progress(ls: LanguageServer, *args):
     token = "duplicate-token"
 
     # Need to stop pygls preventing us from using the progress API wrong.
-    ls.progress._check_token_registered = Mock()
-    await ls.progress.create_async(token)
+    ls.work_done_progress._check_token_registered = Mock()
+    await ls.work_done_progress.create_async(token)
 
     # pytest-lsp should return an error here.
-    await ls.progress.create_async(token)
+    await ls.work_done_progress.create_async(token)
 
 
 @server.command("no.progress")
 async def no_progress(ls: LanguageServer, *args):
     token = "undefined-token"
 
     # Begin
-    ls.progress.begin(
+    ls.work_done_progress.begin(
         token,
         types.WorkDoneProgressBegin(title="Indexing", percentage=0, cancellable=False),
     )
     # Report
     for i in range(1, 4):
-        ls.progress.report(
+        ls.work_done_progress.report(
             token,
             types.WorkDoneProgressReport(message=f"{i * 25}%", percentage=i * 25),
         )
     # End
-    ls.progress.end(token, types.WorkDoneProgressEnd(message="Finished"))
+    ls.work_done_progress.end(token, types.WorkDoneProgressEnd(message="Finished"))
 
 
 if __name__ == "__main__":

lib/pytest-lsp/tests/examples/window-log-message-fail/server.py

@@ -1,16 +1,21 @@
-from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from lsprotocol import types
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("window-log-message", "v1")
 
 
-@server.feature(TEXT_DOCUMENT_COMPLETION)
-def completion(ls: LanguageServer, params: CompletionParams):
+@server.feature(types.TEXT_DOCUMENT_COMPLETION)
+def completion(ls: LanguageServer, params: types.CompletionParams):
     items = []
 
     for i in range(10):
-        ls.show_message_log(f"Suggesting item {i}")
-        items.append(CompletionItem(label=f"item-{i}"))
+        ls.window_log_message(
+            types.LogMessageParams(
+                message=f"Suggesting item {i}",
+                type=types.MessageType.Log,
+            )
+        )
+        items.append(types.CompletionItem(label=f"item-{i}"))
 
     return items
 

lib/pytest-lsp/tests/examples/window-log-message/server.py

@@ -1,16 +1,20 @@
-from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from lsprotocol import types
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("window-log-message", "v1")
 
 
-@server.feature(TEXT_DOCUMENT_COMPLETION)
-def completion(ls: LanguageServer, params: CompletionParams):
+@server.feature(types.TEXT_DOCUMENT_COMPLETION)
+def completion(ls: LanguageServer, params: types.CompletionParams):
     items = []
 
     for i in range(10):
-        ls.show_message_log(f"Suggesting item {i}")
-        items.append(CompletionItem(label=f"item-{i}"))
+        ls.window_log_message(
+            types.LogMessageParams(
+                message=f"Suggesting item {i}", type=types.MessageType.Log
+            )
+        )
+        items.append(types.CompletionItem(label=f"item-{i}"))
 
     return items
 

lib/pytest-lsp/tests/examples/window-show-document/server.py

@@ -1,21 +1,18 @@
-from lsprotocol.types import (
-    TEXT_DOCUMENT_COMPLETION,
-    CompletionItem,
-    CompletionParams,
-    ShowDocumentParams,
-)
-from pygls.server import LanguageServer
+from lsprotocol import types
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("window-show-document", "v1")
 
 
-@server.feature(TEXT_DOCUMENT_COMPLETION)
-async def completion(ls: LanguageServer, params: CompletionParams):
+@server.feature(types.TEXT_DOCUMENT_COMPLETION)
+async def completion(ls: LanguageServer, params: types.CompletionParams):
     items = []
-    await ls.show_document_async(ShowDocumentParams(uri=params.text_document.uri))
+    await ls.window_show_document_async(
+        types.ShowDocumentParams(uri=params.text_document.uri)
+    )
 
     for i in range(10):
-        items.append(CompletionItem(label=f"item-{i}"))
+        items.append(types.CompletionItem(label=f"item-{i}"))
 
     return items
 

lib/pytest-lsp/tests/examples/window-show-message/server.py

@@ -1,16 +1,21 @@
-from lsprotocol.types import TEXT_DOCUMENT_COMPLETION, CompletionItem, CompletionParams
-from pygls.server import LanguageServer
+from lsprotocol import types
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("window-show-message", "v1")
 
 
-@server.feature(TEXT_DOCUMENT_COMPLETION)
-def completion(ls: LanguageServer, params: CompletionParams):
+@server.feature(types.TEXT_DOCUMENT_COMPLETION)
+def completion(ls: LanguageServer, params: types.CompletionParams):
     items = []
 
     for i in range(10):
-        ls.show_message(f"Suggesting item {i}")
-        items.append(CompletionItem(label=f"item-{i}"))
+        ls.window_show_message(
+            types.ShowMessageParams(
+                message=f"Suggesting item {i}",
+                type=types.MessageType.Log,
+            )
+        )
+        items.append(types.CompletionItem(label=f"item-{i}"))
 
     return items
 

lib/pytest-lsp/tests/examples/workspace-configuration/server.py

@@ -1,13 +1,13 @@
 from lsprotocol import types
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 server = LanguageServer("workspace-configuration", "v1")
 
 
 @server.command("server.configuration")
 async def configuration(ls: LanguageServer, *args):
-    results = await ls.get_configuration_async(
-        types.WorkspaceConfigurationParams(
+    results = await ls.workspace_configuration_async(
+        types.ConfigurationParams(
             items=[
                 types.ConfigurationItem(scope_uri="file://workspace/file.txt"),
                 types.ConfigurationItem(section="not.found"),

lib/pytest-lsp/tests/servers/capabilities.py

@@ -1,5 +1,5 @@
 from lsprotocol.converters import get_converter
-from pygls.server import LanguageServer
+from pygls.lsp.server import LanguageServer
 
 converter = get_converter()
 server = LanguageServer(name="capabilities-server", version="v1.0")