Add support for set type collections in the pretty-printer

Our snapshot files rely on consistent order for all rendered collections, but we were assuming that all input objects would be strictly ordered. Unfortunately, the fallback method of using Python's pretty-printer does not allow for ordered sets, so any inputs involving set or frozenset types will be fundamentally unstable. This expands our list-like formatted print handling to cover set types, indicating the distinction between set and frozenset and printing all values in a stable sort order. This does assume all set values are sortable, which should be the case. As you can see from the snapshot updates, this is a pre-existing problem in the codebase. We've gotten away with it because all of the sets in our snapshots have, thus far, all been of length 1. This will change in coming updates.
dbt-labs · May 3, 2024 · 900ace8 · 900ace8
1 parent 6a230bc
commit 900ace8
Show file tree

Hide file tree

Showing 19 changed files with 73 additions and 27 deletions.
diff --git a/metricflow-semantics/metricflow_semantics/mf_logging/pretty_print.py b/metricflow-semantics/metricflow_semantics/mf_logging/pretty_print.py
@@ -39,7 +39,9 @@ def _is_pydantic_base_model(obj: Any):  # type:ignore
         # Checking the attribute as the BaseModel check fails for newer version of Pydantic.
         return isinstance(obj, BaseModel) or hasattr(obj, "__config__")
 
-    def _handle_sequence_obj(self, list_like_obj: Union[list, tuple], remaining_line_width: Optional[int]) -> str:
+    def _handle_sequence_obj(
+        self, list_like_obj: Union[list, tuple, set, frozenset], remaining_line_width: Optional[int]
+    ) -> str:
         """Pretty prints a sequence object i.e. list or tuple.
 
         Args:
@@ -55,6 +57,10 @@ def _handle_sequence_obj(self, list_like_obj: Union[list, tuple], remaining_line
         elif isinstance(list_like_obj, tuple):
             left_enclose_str = "("
             right_enclose_str = ")"
+        elif isinstance(list_like_obj, set) or isinstance(list_like_obj, frozenset):
+            left_enclose_str = f"{type(list_like_obj).__name__}("
+            right_enclose_str = ")"
+            list_like_obj = sorted(list_like_obj)
         else:
             raise RuntimeError(f"Unhandled type: {type(list_like_obj)}")
 
@@ -317,7 +323,7 @@ def _handle_any_obj(self, obj: Any, remaining_line_width: Optional[int]) -> str:
         if isinstance(obj, Enum):
             return obj.name
 
-        if isinstance(obj, (list, tuple)):
+        if isinstance(obj, (list, tuple, set, frozenset)):
             return self._handle_sequence_obj(obj, remaining_line_width=remaining_line_width)
 
         if isinstance(obj, dict):

diff --git a/...n/test_ambiguous_metric_time_in_query_filter__accumulate_last_2_months_metric__result.txt b/...n/test_ambiguous_metric_time_in_query_filter__accumulate_last_2_months_metric__result.txt
@@ -13,7 +13,7 @@ GroupByItemResolution(
           ),
           element_name='metric_time',
           dimension_type=TIME,
-          properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+          properties=frozenset(METRIC_TIME,),
           time_granularity=MONTH,
         ),
       ),

diff --git a/...metric_time_in_query_filter__derived_metric_with_different_parent_time_grains__result.txt b/...metric_time_in_query_filter__derived_metric_with_different_parent_time_grains__result.txt
@@ -25,7 +25,9 @@ GroupByItemResolution(
                     ),
                     element_name='metric_time',
                     dimension_type=TIME,
-                    properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                    properties=frozenset(
+                      METRIC_TIME,
+                    ),
                     time_granularity=MONTH,
                   ),
                 ),
@@ -63,7 +65,9 @@ GroupByItemResolution(
                     ),
                     element_name='metric_time',
                     dimension_type=TIME,
-                    properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                    properties=frozenset(
+                      METRIC_TIME,
+                    ),
                     time_granularity=YEAR,
                   ),
                 ),

diff --git a/...uous_metric_time_in_query_filter__derived_metric_with_same_parent_time_grains__result.txt b/...uous_metric_time_in_query_filter__derived_metric_with_same_parent_time_grains__result.txt
@@ -13,7 +13,7 @@ GroupByItemResolution(
           ),
           element_name='metric_time',
           dimension_type=TIME,
-          properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+          properties=frozenset(METRIC_TIME,),
           time_granularity=MONTH,
         ),
       ),

diff --git a/...est_ambiguous_metric_time_in_query_filter__metrics_with_different_time_grains__result.txt b/...est_ambiguous_metric_time_in_query_filter__metrics_with_different_time_grains__result.txt
@@ -22,7 +22,9 @@ GroupByItemResolution(
                     ),
                     element_name='metric_time',
                     dimension_type=TIME,
-                    properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                    properties=frozenset(
+                      METRIC_TIME,
+                    ),
                     time_granularity=MONTH,
                   ),
                 ),
@@ -58,7 +60,9 @@ GroupByItemResolution(
                     ),
                     element_name='metric_time',
                     dimension_type=TIME,
-                    properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                    properties=frozenset(
+                      METRIC_TIME,
+                    ),
                     time_granularity=YEAR,
                   ),
                 ),

diff --git a/...ion/test_ambiguous_metric_time_in_query_filter__metrics_with_same_time_grains__result.txt b/...ion/test_ambiguous_metric_time_in_query_filter__metrics_with_same_time_grains__result.txt
@@ -13,7 +13,7 @@ GroupByItemResolution(
           ),
           element_name='metric_time',
           dimension_type=TIME,
-          properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+          properties=frozenset(METRIC_TIME,),
           time_granularity=MONTH,
         ),
       ),

diff --git a/.../GroupByItemResolution/test_ambiguous_metric_time_in_query_filter__no_metrics__result.txt b/.../GroupByItemResolution/test_ambiguous_metric_time_in_query_filter__no_metrics__result.txt
@@ -10,7 +10,7 @@ GroupByItemResolution(
         LinkableDimension(
           element_name='metric_time',
           dimension_type=TIME,
-          properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+          properties=frozenset(METRIC_TIME,),
           time_granularity=DAY,
         ),
       ),

diff --git a/...oupByItemResolution/test_ambiguous_metric_time_in_query_filter__simple_metric__result.txt b/...oupByItemResolution/test_ambiguous_metric_time_in_query_filter__simple_metric__result.txt
@@ -13,7 +13,7 @@ GroupByItemResolution(
           ),
           element_name='metric_time',
           dimension_type=TIME,
-          properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+          properties=frozenset(METRIC_TIME,),
           time_granularity=MONTH,
         ),
       ),

diff --git a/...py/str/test_filter_resolution_for_derived_metrics_with_common_filtered_metric__result.txt b/...py/str/test_filter_resolution_for_derived_metrics_with_common_filtered_metric__result.txt
@@ -35,7 +35,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),
@@ -91,7 +93,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),

diff --git a/...hots/test_spec_lookup.py/str/test_filter_resolution_for_invalid_metric_filter__result.txt b/...hots/test_spec_lookup.py/str/test_filter_resolution_for_invalid_metric_filter__result.txt
@@ -54,7 +54,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=MONTH,
                       ),
                     ),
@@ -92,7 +94,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=YEAR,
                       ),
                     ),

diff --git a/...est_spec_lookup.py/str/test_filter_resolution_for_invalid_metric_input_filter__result.txt b/...est_spec_lookup.py/str/test_filter_resolution_for_invalid_metric_input_filter__result.txt
@@ -55,7 +55,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=MONTH,
                       ),
                     ),
@@ -95,7 +97,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=YEAR,
                       ),
                     ),

diff --git a/...pshots/test_spec_lookup.py/str/test_filter_resolution_for_valid_metric_filter__result.txt b/...pshots/test_spec_lookup.py/str/test_filter_resolution_for_valid_metric_filter__result.txt
@@ -35,7 +35,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),

diff --git a/.../test_spec_lookup.py/str/test_filter_resolution_for_valid_metric_input_filter__result.txt b/.../test_spec_lookup.py/str/test_filter_resolution_for_valid_metric_input_filter__result.txt
@@ -35,7 +35,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),

diff --git a/...ec_lookup.py/str/test_filter_spec_resolution__accumulate_last_2_months_metric__result.txt b/...ec_lookup.py/str/test_filter_spec_resolution__accumulate_last_2_months_metric__result.txt
@@ -35,7 +35,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),

diff --git a/...test_filter_spec_resolution__derived_metric_with_different_parent_time_grains__result.txt b/...test_filter_spec_resolution__derived_metric_with_different_parent_time_grains__result.txt
@@ -54,7 +54,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=MONTH,
                       ),
                     ),
@@ -92,7 +94,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=YEAR,
                       ),
                     ),

diff --git a/.../str/test_filter_spec_resolution__derived_metric_with_same_parent_time_grains__result.txt b/.../str/test_filter_spec_resolution__derived_metric_with_same_parent_time_grains__result.txt
@@ -35,7 +35,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),

diff --git a/...lookup.py/str/test_filter_spec_resolution__metrics_with_different_time_grains__result.txt b/...lookup.py/str/test_filter_spec_resolution__metrics_with_different_time_grains__result.txt
@@ -56,7 +56,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=MONTH,
                       ),
                     ),
@@ -92,7 +94,9 @@ FilterSpecResolutionLookUp(
                         ),
                         element_name='metric_time',
                         dimension_type=TIME,
-                        properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+                        properties=frozenset(
+                          METRIC_TIME,
+                        ),
                         time_granularity=YEAR,
                       ),
                     ),

diff --git a/...spec_lookup.py/str/test_filter_spec_resolution__metrics_with_same_time_grains__result.txt b/...spec_lookup.py/str/test_filter_spec_resolution__metrics_with_same_time_grains__result.txt
@@ -38,7 +38,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),

diff --git a/.../snapshots/test_spec_lookup.py/str/test_filter_spec_resolution__simple_metric__result.txt b/.../snapshots/test_spec_lookup.py/str/test_filter_spec_resolution__simple_metric__result.txt
@@ -35,7 +35,9 @@ FilterSpecResolutionLookUp(
               ),
               element_name='metric_time',
               dimension_type=TIME,
-              properties=frozenset({<LinkableElementProperty.METRIC_TIME: 'metric_time'>}),
+              properties=frozenset(
+                METRIC_TIME,
+              ),
               time_granularity=MONTH,
             ),
           ),