Merge pull request #414 from Crunch-io/ZC-2037-add-table-code

ZC-2037: Add table code

Author: tiagocoutinho

src/cr/cube/cubepart.py

@@ -1630,6 +1630,26 @@ def table_name(self):
             return f"{title}: {table_name}"
         return None
 
+    @lazyproperty
+    def table_label(self):
+        """Optional table label for this Slice"""
+        if self._cube.ndim < 3:
+            return None
+        valid_elements = self._cube.dimensions[0].valid_elements
+        if valid_elements.element_ids:
+            return valid_elements[self._slice_idx].label
+        return None
+
+    @lazyproperty
+    def table_code(self):
+        """Optional table code for this Slice"""
+        if self._cube.ndim < 3:
+            return None
+        valid_elements = self._cube.dimensions[0].valid_elements
+        if valid_elements.element_ids:
+            return valid_elements[self._slice_idx].element_id
+        return None
+
     @lazyproperty
     def table_percentages(self):
         return self.table_proportions * 100
@@ -2436,6 +2456,28 @@ def table_name(self):
             return f"{title}: {table_name}"
         return None
 
+    @lazyproperty
+    def table_label(self):
+        """Optional table label for this strand
+
+        Only for CA-as-0th case, provides differentiated labels for stacked tables.
+        """
+        valid_elements = self._cube.dimensions[0].valid_elements
+        if valid_elements.element_ids:
+            return valid_elements[self._slice_idx].label
+        return None
+
+    @lazyproperty
+    def table_code(self):
+        """Optional table code for this strand
+
+        Only for CA-as-0th case, provides differentiated codes for stacked tables.
+        """
+        valid_elements = self._cube.dimensions[0].valid_elements
+        if valid_elements.element_ids:
+            return valid_elements[self._slice_idx].element_id
+        return None
+
     @lazyproperty
     def table_percentages(self):
         """1D np.float64 ndarray of table-percentage for each row.
@@ -2586,6 +2628,14 @@ def table_base(self):
     def table_name(self):
         return None
 
+    @lazyproperty
+    def table_label(self):
+        return None
+
+    @lazyproperty
+    def table_code(self):
+        return None
+
     @lazyproperty
     def unweighted_count(self):
         """Integer scalar of total unweighted count of the table"""

tests/integration/test_cubepart.py

@@ -139,6 +139,8 @@ def test_it_provides_values_for_cat_x_cat(self):
         assert slice_.tab_alias == ""
         assert slice_.table_margin == 15
         assert slice_.table_name is None
+        assert slice_.table_code is None
+        assert slice_.table_label is None
         assert pytest.approx(slice_.table_percentages) == [
             [33.33333, 13.33333],
             [33.33333, 20.00000],
@@ -270,6 +272,8 @@ def test_it_provides_values_for_cat_hs_mt_x_cat_hs_mt(self):
         )
         assert slice_.table_base == 91
         assert slice_.table_name is None
+        assert slice_.table_code is None
+        assert slice_.table_label is None
         np.testing.assert_almost_equal(
             slice_.table_std_dev,
             [
@@ -2203,6 +2207,8 @@ def test_it_provides_values_for_ca_as_0th(self):
         assert strand.tab_alias == "Q1_1"
         assert strand.tab_label == "ATP Men's T"
         assert strand.table_name == "Level of in: ATP Men's T"
+        assert strand.table_code == "Q1_1"
+        assert strand.table_label == "ATP Men's T"
         assert strand.weighted_bases == pytest.approx([27292.0] * 4)
 
     def test_it_provides_values_for_univariate_cat(self):
@@ -2271,6 +2277,8 @@ def test_it_provides_values_for_univariate_cat(self):
         assert strand.table_base_range.tolist() == [15, 15]
         assert strand.table_margin_range.tolist() == [15, 15]
         assert strand.table_name == "v7: C"
+        assert strand.table_code == 1
+        assert strand.table_label == "C"
         assert strand.table_percentages == pytest.approx([66.66667, 33.33333])
         assert strand.table_proportion_moes == pytest.approx([0.2385592, 0.2385592])
         assert strand.table_proportion_stddevs == pytest.approx([0.4714045, 0.4714045])
@@ -2365,6 +2373,8 @@ def test_it_provides_values_for_univariate_mr_hs(self):
         assert strand.rows_dimension_type == DT.MR
         assert strand.scale_mean is None
         assert strand.table_name == "Paid for ne: A newspaper"
+        assert strand.table_code == "Q17_1"
+        assert strand.table_label == "A newspaper"
         assert strand.table_proportion_stddevs == pytest.approx(
             [
                 0.4642672,
@@ -2684,6 +2694,8 @@ def test_mean_no_dims(self):
         np.testing.assert_almost_equal(nub.table_base, np.array([49.095]))
         np.testing.assert_array_equal(nub.unweighted_count, 1000)
         assert nub.table_name is None
+        assert nub.table_code is None
+        assert nub.table_label is None
 
 
 class Test_LegacySlice:
@@ -3910,6 +3922,8 @@ def test_ca_x_mr_margin_prune(self):
             slice_.columns_base, np.array([504, 215, 224, 76, 8, 439])
         )
         assert slice_.table_name == "q1. Aftensmad: K\xf8d (svin/lam/okse)"
+        assert slice_.table_code == "q1_1"
+        assert slice_.table_label == "K\xf8d (svin/lam/okse)"
 
     def test_mr_x_cat_x_mr_pruning(self):
         # No pruning

tests/unit/test_cubepart.py

@@ -308,7 +308,7 @@ def test_it_knows_its_selected_category_labels(
         assert slice_.selected_category_labels == expected_value
 
     @pytest.mark.parametrize("ndim, element_ids", ((2, (1, 2, 3)), (3, ())))
-    def test_it_knows_when_its_table_name_is_None(
+    def test_it_knows_when_its_table_name_code_and_label_are_None(
         self, request, dimension_, _dimensions_prop_, cube_, ndim, element_ids
     ):
         valid_elements_ = instance_mock(request, Elements)
@@ -319,6 +319,8 @@ def test_it_knows_when_its_table_name_is_None(
         slice_ = _Slice(cube_, 0, None, None, None)
 
         assert slice_.table_name is None
+        assert slice_.table_code is None
+        assert slice_.table_label is None
 
     # fixture components ---------------------------------------------
 
@@ -423,7 +425,7 @@ def test_it_knows_its_selected_categories_labels(self, _dimensions_prop_):
 
         assert strand_.selected_category_labels == ()
 
-    def test_it_knows_when_its_table_name_is_None(
+    def test_it_knows_when_its_table_name_code_and_code_are_None(
         self, request, dimension_, _dimensions_prop_, cube_
     ):
         valid_elements_ = instance_mock(request, Elements)
@@ -433,6 +435,8 @@ def test_it_knows_when_its_table_name_is_None(
         strand = _Strand(cube_, 0, None, None, None, None)
 
         assert strand.table_name is None
+        assert strand.table_code is None
+        assert strand.table_label is None
 
     # fixture components ---------------------------------------------