LspClient (and json rpc client), use it optionally(enabled by default) in pyrefly and ruff

Author: Aksem

extensions/fine_python_pyrefly/fine_python_pyrefly/lint_files_handler.py

@@ -12,14 +12,17 @@
     icommandrunner,
     ilogger,
     ifileeditor,
+    iprojectinfoprovider,
     isrcartifactfileclassifier,
     iextensionrunnerinfoprovider,
 )
+from fine_python_pyrefly.pyrefly_lsp_service import PyreflyLspService
 
 
 @dataclasses.dataclass
 class PyreflyLintFilesHandlerConfig(code_action.ActionHandlerConfig):
     python_version: str | None = None
+    use_cli: bool = False
 
 
 class PyreflyLintFilesHandler(
@@ -47,6 +50,8 @@ def __init__(
         command_runner: icommandrunner.ICommandRunner,
         src_artifact_file_classifier: isrcartifactfileclassifier.ISrcArtifactFileClassifier,
         extension_runner_info_provider: iextensionrunnerinfoprovider.IExtensionRunnerInfoProvider,
+        project_info_provider: iprojectinfoprovider.IProjectInfoProvider,
+        lsp_service: PyreflyLspService,
     ) -> None:
         self.config = config
         self.cache = cache
@@ -55,9 +60,27 @@ def __init__(
         self.command_runner = command_runner
         self.src_artifact_file_classifier = src_artifact_file_classifier
         self.extension_runner_info_provider = extension_runner_info_provider
+        self.project_info_provider: iprojectinfoprovider.IProjectInfoProvider = project_info_provider
+        self.lsp_service: PyreflyLspService = lsp_service
 
         self.pyrefly_bin_path = Path(sys.executable).parent / "pyrefly"
 
+        if not self.config.use_cli:
+            # Pyrefly uses pull-based config: the LSP server sends
+            # workspace/configuration requests with section="python",
+            # expecting responses like [{"pyrefly": {"displayTypeErrors": ...}}].
+            # The same format is used for initializationOptions.
+            venv_dir = self.extension_runner_info_provider.get_venv_dir_path_of_env("runtime")
+            interpreter_path = self.extension_runner_info_provider.get_venv_python_interpreter(venv_dir)
+            site_packages = self.extension_runner_info_provider.get_venv_site_packages(venv_dir)
+            self.lsp_service.update_settings({
+                "pythonPath": str(interpreter_path),
+                "pyrefly": {
+                    "displayTypeErrors": "force-on",
+                    "extraPaths": [str(p) for p in site_packages],
+                },
+            })
+
     async def run_on_single_file(
         self, file_path: Path
     ) -> lint_files_action.LintFilesRunResult:
@@ -76,7 +99,14 @@ async def run_on_single_file(
         ) as session:
             file_version = await session.read_file_version(file_path)
 
-        lint_messages = await self.run_pyrefly_lint_on_single_file(file_path)
+        if self.config.use_cli:
+            lint_messages = await self.run_pyrefly_lint_on_single_file(file_path)
+        else:
+            root_uri = self.project_info_provider.get_current_project_dir_path().as_uri()
+            await self.lsp_service.ensure_started(root_uri)
+
+            lint_messages = await self.lsp_service.check_file(file_path)
+
         messages[str(file_path)] = lint_messages
         await self.cache.save_file_cache(
             file_path, file_version, self.CACHE_KEY, lint_messages

extensions/fine_python_pyrefly/fine_python_pyrefly/pyrefly_lsp_service.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import override
+
+from finecode_extension_api import service
+from finecode_extension_api.actions import lint_files as lint_files_action
+from finecode_extension_api.interfaces import ifileeditor, ilspclient, ilogger
+from finecode_extension_api.contrib.lsp_service import LspService, map_diagnostics_to_lint_messages
+
+
+class PyreflyLspService(service.DisposableService):
+    """Pyrefly LSP service — thin wrapper around generic LspService."""
+
+    def __init__(
+        self,
+        lsp_client: ilspclient.ILspClient,
+        file_editor: ifileeditor.IFileEditor,
+        logger: ilogger.ILogger,
+    ) -> None:
+        pyrefly_bin = Path(sys.executable).parent / "pyrefly"
+        self._lsp_service = LspService(
+            lsp_client=lsp_client,
+            file_editor=file_editor,
+            logger=logger,
+            cmd=f"{pyrefly_bin} lsp",
+            language_id="python",
+            readable_id="pyrefly-lsp",
+        )
+
+    @override
+    async def init(self) -> None:
+        await self._lsp_service.init()
+
+    @override
+    def dispose(self) -> None:
+        self._lsp_service.dispose()
+
+    def update_settings(self, settings: dict[str, object]) -> None:
+        self._lsp_service.update_settings(settings)
+
+    async def ensure_started(self, root_uri: str) -> None:
+        await self._lsp_service.ensure_started(root_uri)
+
+    async def check_file(
+        self,
+        file_path: Path,
+        timeout: float = 30.0,
+    ) -> list[lint_files_action.LintMessage]:
+        raw_diagnostics = await self._lsp_service.check_file(file_path, timeout)
+        return map_diagnostics_to_lint_messages(
+            raw_diagnostics, default_source="pyrefly"
+        )

extensions/fine_python_pyrefly/pyproject.toml

@@ -7,6 +7,9 @@ readme = "README.md"
 requires-python = ">=3.11, <= 3.14"
 dependencies = ["finecode_extension_api~=0.4.0a0", "pyrefly (>=0.30.0,<1.0.0)"]
 
+[project.optional-dependencies]
+jsonrpc = ["finecode_jsonrpc~=0.1.0a0"]
+
 [project.entry-points."finecode.activator"]
 fine_python_pyrefly = "fine_python_pyrefly.activator:Activator"
 

extensions/fine_python_ruff/fine_python_ruff/activator.py

@@ -0,0 +1,15 @@
+from finecode_extension_api import extension
+from finecode_extension_api.interfaces import iserviceregistry
+
+from fine_python_ruff.ruff_lsp_service import RuffLspService
+
+
+class Activator(extension.ExtensionActivator):
+    def __init__(self, registry: iserviceregistry.IServiceRegistry) -> None:
+        self.registry = registry
+
+    def activate(self) -> None:
+        self.registry.register_impl(
+            RuffLspService,
+            RuffLspService,
+        )

extensions/fine_python_ruff/fine_python_ruff/lint_files_handler.py

@@ -12,7 +12,9 @@
     icommandrunner,
     ilogger,
     ifileeditor,
+    iprojectinfoprovider,
 )
+from fine_python_ruff.ruff_lsp_service import RuffLspService
 
 
 @dataclasses.dataclass
@@ -23,6 +25,7 @@ class RuffLintFilesHandlerConfig(code_action.ActionHandlerConfig):
     ignore: list[str] | None = None  # Rules to disable
     extend_select: list[str] | None = None
     preview: bool = False
+    use_cli: bool = False
 
 
 class RuffLintFilesHandler(
@@ -40,15 +43,37 @@ def __init__(
         logger: ilogger.ILogger,
         file_editor: ifileeditor.IFileEditor,
         command_runner: icommandrunner.ICommandRunner,
+        project_info_provider: iprojectinfoprovider.IProjectInfoProvider,
+        lsp_service: RuffLspService,
     ) -> None:
         self.config = config
         self.cache = cache
         self.logger = logger
         self.file_editor = file_editor
         self.command_runner = command_runner
+        self.project_info_provider: iprojectinfoprovider.IProjectInfoProvider = project_info_provider
+        self.lsp_service: RuffLspService = lsp_service
 
         self.ruff_bin_path = Path(sys.executable).parent / "ruff"
 
+        if not self.config.use_cli:
+            # reference: https://docs.astral.sh/ruff/editors/settings/
+            lint_settings: dict[str, object] = {"enable": True}
+            if self.config.select is not None:
+                lint_settings["select"] = self.config.select
+            if self.config.extend_select is not None:
+                lint_settings["extendSelect"] = self.config.extend_select
+            if self.config.ignore is not None:
+                lint_settings["ignore"] = self.config.ignore
+            if self.config.preview:
+                lint_settings["preview"] = True
+            self.lsp_service.update_settings({
+                "lint": lint_settings,
+                "showSyntaxErrors": True,
+                "lineLength": self.config.line_length,
+                "targetVersion": self.config.target_version,
+            })
+
     async def run_on_single_file(
         self, file_path: Path
     ) -> lint_files_action.LintFilesRunResult:
@@ -69,7 +94,13 @@ async def run_on_single_file(
                 file_content: str = file_info.content
                 file_version: str = file_info.version
 
-        lint_messages = await self.run_ruff_lint_on_single_file(file_path, file_content)
+        if self.config.use_cli:
+            lint_messages = await self.run_ruff_lint_on_single_file(file_path, file_content)
+        else:
+            root_uri = self.project_info_provider.get_current_project_dir_path().as_uri()
+            await self.lsp_service.ensure_started(root_uri)
+
+            lint_messages = await self.lsp_service.check_file(file_path)
         messages[str(file_path)] = lint_messages
         await self.cache.save_file_cache(
             file_path, file_version, self.CACHE_KEY, lint_messages

extensions/fine_python_ruff/fine_python_ruff/ruff_lsp_service.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+from typing import override
+
+from finecode_extension_api import service
+from finecode_extension_api.actions import lint_files as lint_files_action
+from finecode_extension_api.interfaces import ifileeditor, ilspclient, ilogger
+from finecode_extension_api.contrib.lsp_service import LspService, map_diagnostics_to_lint_messages
+
+
+class RuffLspService(service.DisposableService):
+    """Ruff LSP service — thin wrapper around generic LspService."""
+
+    def __init__(
+        self,
+        lsp_client: ilspclient.ILspClient,
+        file_editor: ifileeditor.IFileEditor,
+        logger: ilogger.ILogger,
+    ) -> None:
+        ruff_bin = Path(sys.executable).parent / "ruff"
+        self._lsp_service = LspService(
+            lsp_client=lsp_client,
+            file_editor=file_editor,
+            logger=logger,
+            cmd=f"{ruff_bin} server",
+            language_id="python",
+            readable_id="ruff-lsp",
+        )
+
+    @override
+    async def init(self) -> None:
+        await self._lsp_service.init()
+
+    @override
+    def dispose(self) -> None:
+        self._lsp_service.dispose()
+
+    def update_settings(self, settings: dict[str, object]) -> None:
+        self._lsp_service.update_settings(settings)
+
+    async def ensure_started(self, root_uri: str) -> None:
+        await self._lsp_service.ensure_started(root_uri)
+
+    async def check_file(
+        self,
+        file_path: Path,
+        timeout: float = 30.0,
+    ) -> list[lint_files_action.LintMessage]:
+        raw_diagnostics = await self._lsp_service.check_file(file_path, timeout)
+        return map_diagnostics_to_lint_messages(
+            raw_diagnostics, default_source="ruff"
+        )

extensions/fine_python_ruff/pyproject.toml

@@ -7,6 +7,12 @@ readme = "README.md"
 requires-python = ">=3.11, <= 3.14"
 dependencies = ["finecode_extension_api~=0.4.0a0", "ruff (>=0.8.0,<1.0.0)"]
 
+[project.optional-dependencies]
+jsonrpc = ["finecode_jsonrpc~=0.1.0a0"]
+
+[project.entry-points."finecode.activator"]
+fine_python_ruff = "fine_python_ruff.activator:Activator"
+
 [dependency-groups]
 dev_workspace = ["finecode~=0.4.0a0", "finecode_dev_common_preset~=0.3.0a0"]
 

finecode_dev_common_preset/src/finecode_dev_common_preset/preset.toml

@@ -42,18 +42,6 @@ source = "finecode_httpclient.HttpClient"
 env = "dev_no_runtime"
 dependencies = ["finecode_httpclient~=0.1.0a1"]
 
-[[tool.finecode.service]]
-interface = "finecode_extension_api.interfaces.ijsonrpcclient.IJsonRpcClient"
-source = "finecode_jsonrpc.jsonrpc_client.JsonRpcClientImpl"
-env = "dev_no_runtime"
-dependencies = ["finecode_jsonrpc~=0.1.0a1"]
-
-[[tool.finecode.service]]
-interface = "finecode_extension_api.interfaces.ilspclient.ILspClient"
-source = "finecode_extension_runner.impls.lsp_client.LspClientImpl"
-env = "dev_no_runtime"
-dependencies = []
-
 # TODO: recognize minimal python version automatically
 [[tool.finecode.action_handler]]
 source = "fine_python_ruff.RuffLintFilesHandler"