feat: add support for ty (Astral's Python type checker)

Author: observerw

container/registry.toml

@@ -14,6 +14,11 @@ repo = "rust-lang/rust-analyzer"
 type = "pypi"
 package = "pyrefly"
 
+[ty]
+type = "github"
+repo = "astral-sh/ty"
+strip_v = true
+
 [deno]
 type = "github"
 repo = "denoland/deno"

container/ty/ContainerFile

@@ -0,0 +1,8 @@
+# ty has built-in LSP
+ARG VERSION=0.0.5
+FROM ghcr.io/astral-sh/ty:${VERSION}
+ARG VERSION
+LABEL org.opencontainers.image.version="${VERSION}"
+
+WORKDIR /workspace
+ENTRYPOINT ["ty", "server"]

src/lsp_client/clients/__init__.py

@@ -4,17 +4,20 @@
 from .pyrefly import PyreflyClient
 from .pyright import PyrightClient
 from .rust_analyzer import RustAnalyzerClient
+from .ty import TyClient
 from .typescript import TypescriptClient
 
 PythonClient = PyrightClient
 RustClient = RustAnalyzerClient
 TypeScriptClient = TypescriptClient
 DenoLSPClient = DenoClient
+TyLSPClient = TyClient
 
 __all__ = [
     "DenoLSPClient",
     "PyreflyClient",
     "PythonClient",
     "RustClient",
+    "TyLSPClient",
     "TypeScriptClient",
 ]

src/lsp_client/clients/ty.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+import shutil
+import sys
+from functools import partial
+from subprocess import CalledProcessError
+from typing import Any, Literal, override
+
+import anyio
+from attrs import define
+from loguru import logger
+
+from lsp_client.capability.notification import (
+    WithNotifyDidChangeConfiguration,
+)
+from lsp_client.capability.request import (
+    WithRequestDeclaration,
+    WithRequestDefinition,
+    WithRequestDocumentSymbol,
+    WithRequestHover,
+    WithRequestReferences,
+    WithRequestTypeDefinition,
+    WithRequestWorkspaceSymbol,
+)
+from lsp_client.capability.server_notification import (
+    WithReceiveLogMessage,
+    WithReceiveLogTrace,
+    WithReceivePublishDiagnostics,
+    WithReceiveShowMessage,
+)
+from lsp_client.capability.server_request import (
+    WithRespondConfigurationRequest,
+    WithRespondShowDocumentRequest,
+    WithRespondShowMessageRequest,
+    WithRespondWorkspaceFoldersRequest,
+)
+from lsp_client.client.abc import LSPClient
+from lsp_client.server.abc import LSPServer
+from lsp_client.server.container import ContainerServer
+from lsp_client.server.local import LocalServer
+from lsp_client.utils.types import lsp_type
+
+TyContainerServer = partial(
+    ContainerServer, image="ghcr.io/observerw/lsp-client/ty:latest"
+)
+
+
+@define
+class TyClient(
+    LSPClient,
+    WithNotifyDidChangeConfiguration,
+    WithRequestDeclaration,
+    WithRequestDefinition,
+    WithRequestDocumentSymbol,
+    WithRequestHover,
+    WithRequestReferences,
+    WithRequestTypeDefinition,
+    WithRequestWorkspaceSymbol,
+    WithReceiveLogMessage,
+    WithReceiveLogTrace,
+    WithReceivePublishDiagnostics,
+    WithReceiveShowMessage,
+    WithRespondConfigurationRequest,
+    WithRespondShowDocumentRequest,
+    WithRespondShowMessageRequest,
+    WithRespondWorkspaceFoldersRequest,
+):
+    """
+    - Language: Python
+    - Homepage: https://docs.astral.sh/ty/
+    - Github: https://github.com/astral-sh/ty
+    """
+
+    log_level: Literal["trace", "debug", "info", "warn", "error"] = "info"
+    diagnostic_mode: Literal["openFilesOnly", "workspace"] = "openFilesOnly"
+    inlay_hints_variable_types: bool = True
+    inlay_hints_call_argument_names: bool = True
+
+    @override
+    def get_language_id(self) -> lsp_type.LanguageKind:
+        return lsp_type.LanguageKind.Python
+
+    @override
+    def create_default_server(self) -> LSPServer:
+        return LocalServer(command=["ty", "server"])
+
+    @override
+    def create_initialization_options(self) -> dict[str, Any]:
+        return {
+            "logLevel": self.log_level,
+            "diagnosticMode": self.diagnostic_mode,
+            "inlayHints": {
+                "variableTypes": self.inlay_hints_variable_types,
+                "callArgumentNames": self.inlay_hints_call_argument_names,
+            },
+        }
+
+    @override
+    def check_server_compatibility(self, info: lsp_type.ServerInfo | None) -> None:
+        return
+
+    @override
+    async def ensure_installed(self) -> None:
+        if shutil.which("ty"):
+            return
+
+        logger.warning("ty not found, attempting to install via pip...")
+
+        try:
+            await anyio.run_process([sys.executable, "-m", "pip", "install", "ty"])
+            logger.info("Successfully installed ty via pip")
+            return
+        except CalledProcessError as e:
+            raise RuntimeError(
+                "Could not install ty. Please install it manually with 'pip install ty' or 'uv tool install ty'. "
+                "See https://docs.astral.sh/ty/installation/ for more information."
+            ) from e

src/lsp_client/server/container.py

@@ -199,5 +199,5 @@ async def run_process(self, workspace: Workspace) -> AsyncGenerator[None]:
         logger.debug("Running docker runtime with command: {}", command)
 
         self._local = LocalServer(command=command)
-        async with self._local.run_process():
+        async with self._local.run_process(workspace):
             yield

src/lsp_client/server/docker.py

@@ -15,6 +15,7 @@
 from lsp_client.jsonrpc.parse import read_raw_package, write_raw_package
 from lsp_client.jsonrpc.types import RawPackage
 from lsp_client.server.abc import LSPServer
+from lsp_client.utils.workspace import Workspace
 
 
 @final
@@ -69,7 +70,7 @@ async def kill(self) -> None:
 
     @override
     @asynccontextmanager
-    async def run_process(self) -> AsyncGenerator[None]:
+    async def run_process(self, workspace: Workspace) -> AsyncGenerator[None]:
         command = [*self.command, *self.args]
         logger.debug("Running with command: {}", command)
 

src/lsp_client/server/local.py

@@ -17,6 +17,7 @@
 from lsp_client.client.abc import LSPClient
 from lsp_client.jsonrpc.convert import lsp_type, request_serialize, response_deserialize
 from lsp_client.server.abc import LSPServer
+from lsp_client.utils.workspace import DEFAULT_WORKSPACE
 
 
 @frozen
@@ -32,7 +33,7 @@ async def inspect_capabilities(
     if not __debug__:
         raise RuntimeError("inspect_capabilities can only be used in debug mode")
 
-    async with server.serve():
+    async with server.serve(DEFAULT_WORKSPACE):
         # send a fake initialize request to get server capabilities
         req = lsp_type.InitializeRequest(
             id="initialize",