lsp_client_provider.py•2.14 kB
"""LSP Client Provider Protocols for dbt Fusion LSP.
This module defines the protocols for LSP client management using dependency injection.
Protocol Naming Convention:
- LSPClientProtocol: Defines the interface for LSPClient objects (the actual client)
- LSPClientProvider: Defines the interface for provider objects that create LSPClient instances
This separation allows for:
1. Testing by mocking either the client or the provider
2. Different provider implementations (local, remote, pooled, etc.)
3. Lazy initialization of expensive LSP connections
"""
import logging
from typing import Any, Protocol
logger = logging.getLogger(__name__)
class LSPClientProtocol(Protocol):
"""Protocol defining the interface for LSP client objects.
This protocol matches the LSPClient class interface, allowing tools to
depend on the protocol rather than concrete implementation.
Note: Despite the name containing "Provider", this is actually the protocol
for the CLIENT itself, not the provider. It defines the operations that
LSP client implementations must support.
"""
async def compile(self, timeout: float | None = None) -> dict[str, Any]:
"""Compile the dbt project via LSP."""
...
async def get_column_lineage(
self, model_id: str, column_name: str, timeout: float | None = None
) -> dict[str, Any]:
"""Get column-level lineage information."""
...
async def get_model_lineage(
self, model_selector: str, timeout: float | None = None
) -> dict[str, Any]:
"""Get model-level lineage information."""
...
class LSPClientProvider(Protocol):
"""Protocol for objects that provide LSPClient instances.
This is the actual "provider" protocol - it defines how to obtain
an LSPClient instance. Implementations can handle connection pooling,
lazy initialization, lifecycle management, etc.
"""
async def get_client(self) -> LSPClientProtocol:
"""Get or create an LSPClient instance.
Returns:
An object implementing LSPClientProtocol (typically LSPClient)
"""
...