lsp: Use pygls' support for typed command handlers

Author: alcarney

lib/esbonio/esbonio/server/features/preview_manager/__init__.py

@@ -2,6 +2,7 @@
 from typing import Optional
 from urllib.parse import urlencode
 
+import attrs
 from lsprotocol import types
 from pygls.capabilities import get_capability
 
@@ -18,6 +19,11 @@
 from .webview import make_ws_server
 
 
+@attrs.define
+class PreviewFileParams:
+    uri: str
+
+
 class PreviewManager(server.LanguageFeature):
     """Language feature for managing previews."""
 
@@ -144,12 +150,12 @@ async def scroll_view(self, uri: str, line: int):
 
         self.webview.scroll(uri, line)
 
-    async def preview_file(self, params, retry=True):
+    async def preview_file(self, params: PreviewFileParams, retry=True):
         if self.preview is None:
             return None
 
         # Always check the fully resolved uri.
-        src_uri = Uri.parse(params["uri"]).resolve()
+        src_uri = Uri.parse(params.uri).resolve()
         self.logger.debug("Previewing file: '%s'", src_uri)
 
         if (client := await self.sphinx.get_client(src_uri)) is None:
@@ -227,5 +233,5 @@ async def on_scroll(ls: server.EsbonioLanguageServer, params):
         await manager.scroll_view(params.uri, params.line)
 
     @esbonio.command("esbonio.server.previewFile")
-    async def preview_file(ls: server.EsbonioLanguageServer, *args):
-        return await manager.preview_file(args[0][0])
+    async def preview_file(ls: server.EsbonioLanguageServer, params: PreviewFileParams):
+        return await manager.preview_file(params)

lib/esbonio/esbonio/server/features/sphinx_manager/__init__.py

@@ -7,6 +7,7 @@
 from .client import SphinxClient
 from .client_subprocess import make_subprocess_sphinx_client
 from .config import SphinxConfig
+from .manager import RestartSphinxParams
 from .manager import SphinxManager
 
 __all__ = [
@@ -22,11 +23,8 @@ def esbonio_setup(server: EsbonioLanguageServer, project_manager: ProjectManager
     server.add_feature(manager)
 
     @server.command("esbonio.sphinx.restart")
-    async def restart_client(ls: EsbonioLanguageServer, params, *args):
+    async def restart_client(
+        ls: EsbonioLanguageServer, params: RestartSphinxParams, *args
+    ):
         ls.logger.debug("esbonio.sphinx.restart: %s", params)
-
-        for item in params:
-            if item is None:
-                continue
-
-            await manager.restart_client(item["id"])
+        await manager.restart_client(params.id)

lib/esbonio/esbonio/server/features/sphinx_manager/manager.py

@@ -93,6 +93,14 @@ class ManagerConfig:
     """Options controlling when to trigger a Sphinx build."""
 
 
+@attrs.define
+class RestartSphinxParams:
+    """Parameters for the ``esbonio.sphinx.restart`` command"""
+
+    id: str
+    """The id of the sphinx client to restart"""
+
+
 class SphinxManager(server.LanguageFeature):
     """Responsible for managing Sphinx application instances."""