feat: add basedpyright and set it as default python client

Author: observerw

src/lsp_client/clients/__init__.py

@@ -2,6 +2,7 @@
 
 from typing import Final
 
+from .basedpyright import BasedpyrightClient
 from .deno import DenoClient
 from .gopls import GoplsClient
 from .pyrefly import PyreflyClient
@@ -11,6 +12,7 @@
 from .typescript import TypescriptClient
 
 clients: Final = {
+    "basedpyright": BasedpyrightClient,
     "gopls": GoplsClient,
     "pyrefly": PyreflyClient,
     "pyright": PyrightClient,
@@ -21,6 +23,7 @@
 }
 
 __all__ = [
+    "BasedpyrightClient",
     "DenoClient",
     "GoplsClient",
     "PyreflyClient",

src/lsp_client/clients/basedpyright.py

@@ -0,0 +1,144 @@
+from __future__ import annotations
+
+import shutil
+from functools import partial
+from subprocess import CalledProcessError
+from typing import Any, override
+
+import anyio
+from attrs import define
+from loguru import logger
+
+from lsp_client.capability.notification import (
+    WithNotifyDidChangeConfiguration,
+)
+from lsp_client.capability.request import (
+    WithRequestCallHierarchy,
+    WithRequestCodeAction,
+    WithRequestCompletion,
+    WithRequestDeclaration,
+    WithRequestDefinition,
+    WithRequestDocumentSymbol,
+    WithRequestHover,
+    WithRequestReferences,
+    WithRequestSignatureHelp,
+    WithRequestTypeDefinition,
+    WithRequestWorkspaceSymbol,
+)
+from lsp_client.capability.server_notification import (
+    WithReceiveLogMessage,
+    WithReceiveLogTrace,
+    WithReceivePublishDiagnostics,
+    WithReceiveShowMessage,
+)
+from lsp_client.capability.server_request import (
+    WithRespondConfigurationRequest,
+    WithRespondInlayHintRefresh,
+    WithRespondShowDocumentRequest,
+    WithRespondShowMessageRequest,
+    WithRespondWorkspaceFoldersRequest,
+)
+from lsp_client.clients.base import PythonClientBase
+from lsp_client.server import DefaultServers, ServerInstallationError
+from lsp_client.server.container import ContainerServer
+from lsp_client.server.local import LocalServer
+from lsp_client.utils.types import lsp_type
+
+BasedpyrightContainerServer = partial(
+    ContainerServer, image="ghcr.io/lsp-client/basedpyright:latest"
+)
+
+
+async def ensure_basedpyright_installed() -> None:
+    if shutil.which("basedpyright-langserver"):
+        return
+
+    logger.warning(
+        "basedpyright-langserver not found, attempting to install via npm..."
+    )
+
+    try:
+        await anyio.run_process(["npm", "install", "-g", "basedpyright"])
+        logger.info("Successfully installed basedpyright-langserver via npm")
+        return
+    except CalledProcessError as e:
+        raise ServerInstallationError(
+            "Could not install basedpyright-langserver. Please install it manually with 'npm install -g basedpyright' or 'pip install basedpyright'. "
+            "See https://github.com/detachhead/basedpyright for more information."
+        ) from e
+
+
+BasedpyrightLocalServer = partial(
+    LocalServer,
+    program="basedpyright-langserver",
+    args=["--stdio"],
+    ensure_installed=ensure_basedpyright_installed,
+)
+
+
+@define
+class BasedpyrightClient(
+    PythonClientBase,
+    WithNotifyDidChangeConfiguration,
+    WithRequestCallHierarchy,
+    WithRequestCodeAction,
+    WithRequestCompletion,
+    WithRequestDeclaration,
+    WithRequestDefinition,
+    WithRequestDocumentSymbol,
+    WithRequestHover,
+    WithRequestReferences,
+    WithRequestSignatureHelp,
+    WithRequestTypeDefinition,
+    WithRequestWorkspaceSymbol,
+    WithReceiveLogMessage,
+    WithReceiveLogTrace,
+    WithReceivePublishDiagnostics,
+    WithReceiveShowMessage,
+    WithRespondConfigurationRequest,
+    WithRespondInlayHintRefresh,
+    WithRespondShowDocumentRequest,
+    WithRespondShowMessageRequest,
+    WithRespondWorkspaceFoldersRequest,
+):
+    """
+    - Language: Python
+    - Homepage: https://github.com/detachhead/basedpyright
+    - Doc: https://github.com/detachhead/basedpyright
+    - Github: https://github.com/detachhead/basedpyright
+    """
+
+    @classmethod
+    @override
+    def create_default_servers(cls) -> DefaultServers:
+        return DefaultServers(
+            local=BasedpyrightLocalServer(),
+            container=BasedpyrightContainerServer(),
+        )
+
+    @override
+    def check_server_compatibility(self, info: lsp_type.ServerInfo | None) -> None:
+        return
+
+    @override
+    def create_default_config(self) -> dict[str, Any] | None:
+        """
+        https://github.com/detachhead/basedpyright#settings
+        """
+        return {
+            "basedpyright": {
+                "analysis": {
+                    "autoImportCompletions": True,
+                    "autoSearchPaths": True,
+                    "diagnosticMode": "openFilesOnly",
+                    "indexing": True,
+                    "typeCheckingMode": "recommended",
+                    "inlayHints": {
+                        "variableTypes": True,
+                        "functionReturnTypes": True,
+                        "callArgumentNames": True,
+                        "pytestParameters": True,
+                    },
+                }
+            }
+        }

src/lsp_client/clients/lang.py

@@ -6,9 +6,9 @@
 
 from lsp_client.client.abc import Client
 
+from .basedpyright import BasedpyrightClient
 from .deno.client import DenoClient
 from .gopls import GoplsClient
-from .pyright import PyrightClient
 from .rust_analyzer import RustAnalyzerClient
 from .typescript import TypescriptClient
 
@@ -21,13 +21,13 @@
 ]
 
 GoClient = GoplsClient
-PythonClient = PyrightClient
+PythonClient = BasedpyrightClient
 RustClient = RustAnalyzerClient
 TypeScriptClient = TypescriptClient
 
 lang_clients: Final[dict[Language, type[Client]]] = {
     "go": GoplsClient,
-    "python": PyrightClient,
+    "python": BasedpyrightClient,
     "rust": RustAnalyzerClient,
     "typescript": TypescriptClient,
     "deno": DenoClient,