Merge pull request #158 from dbt-labs/qmalcolm--143-support-label-att…

…ribute Support `label` attribute
dbt-labs · Oct 6, 2023 · b306a5b · b306a5b
2 parents b0da545 + ff2d7e5
commit b306a5b
Show file tree

Hide file tree

Showing 26 changed files with 896 additions and 96 deletions.
diff --git a/.changes/unreleased/Features-20230926-173230.yaml b/.changes/unreleased/Features-20230926-173230.yaml
@@ -0,0 +1,6 @@
+kind: Features
+body: Begin supporting `label` attr on top level objects and semantic model elements
+time: 2023-09-26T17:32:30.099904-07:00
+custom:
+  Author: QMalcolm
+  Issue: "143"
diff --git a/dbt_semantic_interfaces/implementations/elements/dimension.py b/dbt_semantic_interfaces/implementations/elements/dimension.py
@@ -47,6 +47,7 @@ class PydanticDimension(HashableBaseModel, ModelWithMetadataParsing):
     type_params: Optional[PydanticDimensionTypeParams]
     expr: Optional[str] = None
     metadata: Optional[PydanticMetadata]
+    label: Optional[str] = None
 
     @property
     def reference(self) -> DimensionReference:  # noqa: D

diff --git a/dbt_semantic_interfaces/implementations/elements/entity.py b/dbt_semantic_interfaces/implementations/elements/entity.py
@@ -20,6 +20,7 @@ class PydanticEntity(HashableBaseModel, ModelWithMetadataParsing):
     role: Optional[str]
     expr: Optional[str] = None
     metadata: Optional[PydanticMetadata] = None
+    label: Optional[str] = None
 
     @property
     def reference(self) -> EntityReference:  # noqa: D

diff --git a/dbt_semantic_interfaces/implementations/elements/measure.py b/dbt_semantic_interfaces/implementations/elements/measure.py
@@ -44,6 +44,7 @@ class PydanticMeasure(HashableBaseModel, ModelWithMetadataParsing):
     metadata: Optional[PydanticMetadata]
     non_additive_dimension: Optional[PydanticNonAdditiveDimensionParameters] = None
     agg_time_dimension: Optional[str] = None
+    label: Optional[str] = None
 
     @property
     def reference(self) -> MeasureReference:  # noqa: D

diff --git a/dbt_semantic_interfaces/implementations/metric.py b/dbt_semantic_interfaces/implementations/metric.py
@@ -157,6 +157,7 @@ class PydanticMetric(HashableBaseModel, ModelWithMetadataParsing):
     type_params: PydanticMetricTypeParams
     filter: Optional[PydanticWhereFilter]
     metadata: Optional[PydanticMetadata]
+    label: Optional[str] = None
 
     @property
     def input_measures(self) -> Sequence[PydanticMetricInputMeasure]:

diff --git a/dbt_semantic_interfaces/implementations/saved_query.py b/dbt_semantic_interfaces/implementations/saved_query.py
@@ -30,3 +30,4 @@ def _implements_protocol(self) -> SavedQuery:
 
     description: Optional[str] = None
     metadata: Optional[PydanticMetadata] = None
+    label: Optional[str] = None
diff --git a/dbt_semantic_interfaces/implementations/semantic_model.py b/dbt_semantic_interfaces/implementations/semantic_model.py
@@ -92,6 +92,7 @@ def _implements_protocol(self) -> SemanticModel:
     entities: Sequence[PydanticEntity] = []
     measures: Sequence[PydanticMeasure] = []
     dimensions: Sequence[PydanticDimension] = []
+    label: Optional[str] = None
 
     metadata: Optional[PydanticMetadata]
 

diff --git a/dbt_semantic_interfaces/parsing/generated_json_schemas/default_explicit_schema.json b/dbt_semantic_interfaces/parsing/generated_json_schemas/default_explicit_schema.json
@@ -45,6 +45,9 @@
                 "is_partition": {
                     "type": "boolean"
                 },
+                "label": {
+                    "type": "string"
+                },
                 "name": {
                     "pattern": "(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$",
                     "type": "string"
@@ -107,6 +110,9 @@
                         "boolean"
                     ]
                 },
+                "label": {
+                    "type": "string"
+                },
                 "name": {
                     "pattern": "(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$",
                     "type": "string"
@@ -195,6 +201,9 @@
                         "boolean"
                     ]
                 },
+                "label": {
+                    "type": "string"
+                },
                 "name": {
                     "pattern": "(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$",
                     "type": "string"
@@ -270,6 +279,9 @@
                 "filter": {
                     "type": "string"
                 },
+                "label": {
+                    "type": "string"
+                },
                 "name": {
                     "pattern": "(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$",
                     "type": "string"
@@ -410,6 +422,9 @@
                     },
                     "type": "array"
                 },
+                "label": {
+                    "type": "string"
+                },
                 "metrics": {
                     "items": {
                         "type": "string"
@@ -465,6 +480,9 @@
                     },
                     "type": "array"
                 },
+                "label": {
+                    "type": "string"
+                },
                 "measures": {
                     "items": {
                         "$ref": "#/definitions/measure_schema"

diff --git a/dbt_semantic_interfaces/parsing/schemas.py b/dbt_semantic_interfaces/parsing/schemas.py
@@ -100,6 +100,7 @@
         "role": {"type": "string"},
         "expr": {"type": ["string", "boolean"]},
         "entity": {"type": "string"},
+        "label": {"type": "string"},
     },
     "additionalProperties": False,
     "required": ["name", "type"],
@@ -173,6 +174,7 @@
             "$ref": "non_additive_dimension_schema",
         },
         "description": {"type": "string"},
+        "label": {"type": "string"},
     },
     "additionalProperties": False,
     "required": ["name", "agg"],
@@ -191,6 +193,7 @@
         "is_partition": {"type": "boolean"},
         "expr": {"type": ["string", "boolean"]},
         "type_params": {"$ref": "dimension_type_params_schema"},
+        "label": {"type": "string"},
     },
     # dimension must have type_params if its a time dimension
     "anyOf": [{"not": {"$ref": "#/definitions/is-time-dimension"}}, {"required": ["type_params"]}],
@@ -217,6 +220,7 @@
         "type_params": {"$ref": "metric_type_params"},
         "filter": {"type": "string"},
         "description": {"type": "string"},
+        "label": {"type": "string"},
     },
     "additionalProperties": False,
     "required": ["name", "type", "type_params"],
@@ -292,6 +296,7 @@
             "type": "array",
             "items": {"type": "string"},
         },
+        "label": {"type": "string"},
     },
     "required": ["name", "metrics"],
     "additionalProperties": False,
@@ -314,6 +319,7 @@
         "measures": {"type": "array", "items": {"$ref": "measure_schema"}},
         "dimensions": {"type": "array", "items": {"$ref": "dimension_schema"}},
         "description": {"type": "string"},
+        "label": {"type": "string"},
     },
     "additionalProperties": False,
     "required": ["name"],

diff --git a/dbt_semantic_interfaces/protocols/dimension.py b/dbt_semantic_interfaces/protocols/dimension.py
@@ -101,3 +101,9 @@ def time_dimension_reference(self) -> Optional[TimeDimensionReference]:
     def validity_params(self) -> Optional[DimensionValidityParams]:
         """Returns the DimensionValidityParams if they exist for the dimension implementation."""
         ...
+
+    @property
+    @abstractmethod
+    def label(self) -> Optional[str]:
+        """Returns a string representing a human readable label for the dimension."""
+        pass
diff --git a/dbt_semantic_interfaces/protocols/entity.py b/dbt_semantic_interfaces/protocols/entity.py
@@ -54,3 +54,9 @@ def is_linkable_entity_type(self) -> bool:
         keys reserved for SCD Type II style data sources.
         """
         ...
+
+    @property
+    @abstractmethod
+    def label(self) -> Optional[str]:
+        """Returns a string representing a human readable label for the entity."""
+        pass
diff --git a/dbt_semantic_interfaces/protocols/measure.py b/dbt_semantic_interfaces/protocols/measure.py
@@ -92,3 +92,9 @@ def agg_time_dimension(self) -> Optional[str]:  # noqa: D
     def reference(self) -> MeasureReference:
         """Returns a reference to this measure."""
         ...
+
+    @property
+    @abstractmethod
+    def label(self) -> Optional[str]:
+        """Returns a string representing a human readable label for the measure."""
+        pass
diff --git a/dbt_semantic_interfaces/protocols/metric.py b/dbt_semantic_interfaces/protocols/metric.py
@@ -206,3 +206,9 @@ def input_metrics(self) -> Sequence[MetricInput]:
     @abstractmethod
     def metadata(self) -> Optional[Metadata]:  # noqa: D
         pass
+
+    @property
+    @abstractmethod
+    def label(self) -> Optional[str]:
+        """Returns a string representing a human readable label for the metric."""
+        pass
diff --git a/dbt_semantic_interfaces/protocols/saved_query.py b/dbt_semantic_interfaces/protocols/saved_query.py
@@ -37,3 +37,9 @@ def group_bys(self) -> Sequence[str]:  # noqa: D
     @abstractmethod
     def where(self) -> Sequence[WhereFilter]:  # noqa: D
         pass
+
+    @property
+    @abstractmethod
+    def label(self) -> Optional[str]:
+        """Returns a string representing a human readable label for the saved query."""
+        pass
diff --git a/dbt_semantic_interfaces/protocols/semantic_model.py b/dbt_semantic_interfaces/protocols/semantic_model.py
@@ -173,5 +173,11 @@ def primary_entity_reference(self) -> Optional[EntityReference]:
         """Reference object form of primary_entity."""
         pass
 
+    @property
+    @abstractmethod
+    def label(self) -> Optional[str]:
+        """Returns a string representing a human readable label for the semantic model."""
+        pass
+
 
 SemanticModelT = TypeVar("SemanticModelT", bound=SemanticModel)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,3 +30,4 @@ def _implements_protocol(self) -> SavedQuery:

		description: Optional[str] = None
		metadata: Optional[PydanticMetadata] = None
		label: Optional[str] = None