fix: remove circular types with protocols

Author: owlas

lightdash/dimensions.py

@@ -4,6 +4,8 @@
 from dataclasses import dataclass
 from typing import Any, Dict, List, Optional
 
+from .types import Model, Dimension as DimensionProtocol
+
 
 @dataclass
 class Dimension:
@@ -48,7 +50,7 @@ class Dimensions:
     
     Will fetch dimensions from API on first access if not already cached.
     """
-    def __init__(self, model: "Model"):
+    def __init__(self, model: Model):
         self._model = model
         self._dimensions: Optional[Dict[str, Dimension]] = None
 

lightdash/metrics.py

@@ -4,6 +4,8 @@
 from dataclasses import dataclass
 from typing import Any, Dict, List, Optional
 
+from .types import Model, Metric as MetricProtocol
+
 
 @dataclass
 class Metric:
@@ -48,7 +50,7 @@ class Metrics:
     
     Will fetch metrics from API on first access if not already cached.
     """
-    def __init__(self, model: "Model"):
+    def __init__(self, model: Model):
         self._model = model
         self._metrics: Optional[Dict[str, Metric]] = None
 

lightdash/models.py

@@ -4,6 +4,7 @@
 from dataclasses import dataclass
 from typing import Any, Dict, List, Optional, Union, Sequence
 
+from .types import Model as ModelProtocol, Client
 from .metrics import Metric, Metrics
 from .dimensions import Dimension, Dimensions
 from .query import Query
@@ -20,7 +21,7 @@ class Model:
     description: Optional[str] = None
 
     def __post_init__(self):
-        self._client: Optional["Client"] = None
+        self._client: Optional[Client] = None
         self.metrics = Metrics(self)
         self.dimensions = Dimensions(self)
 
@@ -34,7 +35,7 @@ def _repr_pretty_(self, p, cycle):
         else:
             p.text(str(self))
 
-    def _set_client(self, client: "Client") -> None:
+    def _set_client(self, client: Client) -> None:
         """Set the client reference for making API calls."""
         self._client = client
 
@@ -126,7 +127,7 @@ class Models:
     
     Will fetch models from API on first access if not already cached.
     """
-    def __init__(self, client: "Client"):
+    def __init__(self, client: Client):
         self._client = client
         self._models: Optional[Dict[str, Model]] = None
 

lightdash/query.py

@@ -5,6 +5,7 @@
 
 from .dimensions import Dimension
 from .metrics import Metric
+from .types import Model
 
 
 class Query:
@@ -32,7 +33,7 @@ class Query:
     """
     def __init__(
         self,
-        model: "Model",
+        model: Model,
         metrics: Sequence[Union[str, Metric]],
         dimensions: Sequence[Union[str, Dimension]] = (),
         limit: int = 50,

lightdash/types.py

@@ -0,0 +1,54 @@
+"""
+Type definitions for Lightdash.
+"""
+from typing import Protocol, Dict, List, Optional, Any
+
+
+class Client(Protocol):
+    """Type protocol for the Lightdash client."""
+    instance_url: str
+    access_token: str
+    project_uuid: str
+
+    def _make_request(
+        self,
+        method: str,
+        path: str,
+        params: Optional[Dict[str, Any]] = None,
+        json: Optional[Dict[str, Any]] = None,
+    ) -> Dict[str, Any]: ...
+
+
+class Model(Protocol):
+    """Type protocol for a Lightdash model."""
+    name: str
+    type: str
+    database_name: str
+    schema_name: str
+    label: Optional[str]
+    description: Optional[str]
+
+    def list_metrics(self) -> List["Metric"]: ...
+    def list_dimensions(self) -> List["Dimension"]: ...
+
+
+class Metric(Protocol):
+    """Type protocol for a Lightdash metric."""
+    name: str
+    model_name: str
+    label: Optional[str]
+    description: Optional[str]
+
+    @property
+    def field_id(self) -> str: ...
+
+
+class Dimension(Protocol):
+    """Type protocol for a Lightdash dimension."""
+    name: str
+    model_name: str
+    label: Optional[str]
+    description: Optional[str]
+
+    @property
+    def field_id(self) -> str: ... 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lightdash"
-version = "0.2.3"
+version = "0.2.4"
 description = "Query metrics from Lightdash"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -18,6 +18,7 @@ dev = [
     "jupyter>=1.0.0",
     "ipykernel>=6.0.0",  # Required for Jupyter notebooks
     "pandas>=2.0.0",  # For DataFrame support in tests
+    "polars>=1.22.0",  # For DataFrame support in tests
 ]
 
 [tool.pytest.ini_options]