Fix parent_attribute handling in get_elements_dataframe for PA v12

Author: VadimMitsenko

TM1py/Services/ElementService.py

@@ -383,38 +383,29 @@ def get_elements_dataframe(
             depth = 0
             for calculated_name, level_name in levels_dict.items():
                 depth += 1
-                name_or_attribute = f"Properties('{parent_attribute}')" if parent_attribute else "NAME"
-                if not verify_version(required_version="12", version=self.version):
-                    member = f"""
-                    MEMBER [{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{calculated_name}] 
-                    AS [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * depth}{name_or_attribute}
-                    """
-                else:
-                    member = f"""
-                    MEMBER [{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{calculated_name}] 
-                    AS [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * depth}PROPERTIES('{name_or_attribute}')
-                    """
+
+                # Deliberately adding a trailing space to Properties after the attribute name
+                # to ensure the attribute "name" is accessed instead of the built-in NAME property
+                # when the original attribute is called "Name" (this behavior is relevant starting from v12 )
+                name_or_attribute = f"Properties('{parent_attribute} ')" if parent_attribute else "NAME"
+
+                member = f"""
+                MEMBER [{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{calculated_name}] 
+                AS [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * depth}{name_or_attribute}
+                """
                 calculated_members_definition.append(member)
 
                 parent_members.append(f"[{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{calculated_name}]")
 
                 if not skip_weights:
-                    if not verify_version(required_version="12", version=self.version):
-                        member_weight = f"""
-                        MEMBER [{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{level_name}_Weight] 
-                        AS IIF(
-                        [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * (depth - 1)}Properties('MEMBER_WEIGHT') = '',
-                        0,
-                        [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * (depth - 1)}Properties('MEMBER_WEIGHT'))
-                        """
-                    else:
-                        member_weight = f"""
-                        MEMBER [{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{level_name}_Weight]
-                        AS IIF(
-                        [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * ( depth - 1)}Properties('MEMBER_WEIGHT') = '',
-                        0,
-                        [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * ( depth - 1)}Properties('MEMBER_WEIGHT'))
-                        """
+                    member_weight = f"""
+                    MEMBER [{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{level_name}_Weight] 
+                    AS IIF(
+                    [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * (depth - 1)}Properties('MEMBER_WEIGHT') = '',
+                    0,
+                    [{dimension_name}].[{hierarchy_name}].CurrentMember.{'Parent.' * (depth - 1)}Properties('MEMBER_WEIGHT'))
+                    """
+
                     calculated_members_definition.append(member_weight)
 
                     weight_members.append(f"[{self.ELEMENT_ATTRIBUTES_PREFIX + dimension_name}].[{level_name}_Weight]")
@@ -517,7 +508,7 @@ def get_elements_dataframe(
 
         # format the columns
         df_data[cols_to_format] = df_data[cols_to_format].apply(pd.to_numeric)
-        df_data[cols_to_format] = df_data[cols_to_format].applymap(lambda x: "{:.6f}".format(x))
+        df_data[cols_to_format] = df_data[cols_to_format].apply(lambda col: col.map(lambda x: f"{x:.6f}"))
 
         # override colum types
         element_attributes = self.get_element_attributes(dimension_name, hierarchy_name)

Tests/ElementService_test.py

@@ -80,6 +80,8 @@ def setUp(self):
         self.tm1.cubes.cells.write_value("1989/90", self.attribute_cube_name, ("1990", "Financial Year"))
         self.tm1.cubes.cells.write_value("1990/91", self.attribute_cube_name, ("1991", "Financial Year"))
         self.tm1.cubes.cells.write_value("1991/92", self.attribute_cube_name, ("1992", "Financial Year"))
+        self.tm1.cubes.cells.write_value("All Years", self.attribute_cube_name, ("Total Years", "Financial Year"))
+        self.tm1.cubes.cells.write_value("All Consolidations", self.attribute_cube_name, ("All Consolidations", "Financial Year"))
 
         self.create_or_update_dimension_with_hierarchies()
 
@@ -560,6 +562,48 @@ def test_get_elements_dataframe_element_type_column(self):
     def test_get_elements_dataframe_element_type_column_use_blob(self):
         self.run_test_get_elements_dataframe_element_type_column(True)
 
+    def run_test_get_elements_dataframe_parent_attribute(self, use_blob):
+        df = self.tm1.elements.get_elements_dataframe(
+            dimension_name=self.dimension_name,
+            hierarchy_name=self.hierarchy_name,
+            elements=["1989", "1990"],
+            skip_consolidations=True,
+            attributes=["Next Year", "Previous Year"],
+            attribute_column_prefix="Attribute ",
+            skip_parents=False,
+            level_names=None,
+            parent_attribute="Financial Year",
+            skip_weights=False,
+            use_blob=use_blob,
+        )
+
+        expected_columns = (
+            self.dimension_name,
+            "Type",
+            "Attribute Next Year",
+            "Attribute Previous Year",
+            "level001_Weight",
+            "level000_Weight",
+            "level001",
+            "level000",
+        )
+
+        self.assertEqual((2, 8), df.shape)
+        self.assertEqual(expected_columns, tuple(df.columns))
+        row = df.loc[df[self.dimension_name] == "1989"]
+        self.assertEqual(
+            ("1989", "Numeric", "", "1988", "1.000000", "1.000000", "All Years", "All Consolidations"),
+            tuple(row.values[0]),
+        )
+
+    @skip_if_no_pandas
+    def test_get_elements_dataframe_parent_attribute(self):
+        self.run_test_get_elements_dataframe_parent_attribute(False)
+
+    @skip_if_no_pandas
+    def test_get_elements_dataframe_parent_attribute(self):
+        self.run_test_get_elements_dataframe_parent_attribute(True)
+
     def run_test_get_elements_dataframe_not_elements(self, use_blob: bool):
         df = self.tm1.elements.get_elements_dataframe(
             dimension_name=self.dimension_name,
@@ -590,6 +634,14 @@ def run_test_get_elements_dataframe_not_elements(self, use_blob: bool):
 
         self.assertTrue(df.equals(reference_df))
 
+    @skip_if_no_pandas
+    def test_get_elements_dataframe_not_elements(self):
+        self.run_test_get_elements_dataframe_not_elements(use_blob=False)
+
+    @skip_if_no_pandas
+    def test_get_elements_dataframe_use_blob_not_elements(self):
+        self.run_test_get_elements_dataframe_not_elements(use_blob=True)
+
     @skip_if_no_pandas
     def test_get_elements_dataframe_attribute_same_name(self):
         self.run_test_get_elements_dataframe_attribute_same_name(False)
@@ -661,13 +713,7 @@ def run_test_get_elements_dataframe_elements_via_mdx(self, use_blob: bool):
 
         self.assertTrue(df.equals(reference_df))
 
-    @skip_if_no_pandas
-    def test_get_elements_dataframe_not_elements(self):
-        self.run_test_get_elements_dataframe_not_elements(use_blob=False)
 
-    @skip_if_no_pandas
-    def test_get_elements_dataframe_use_blob_not_elements(self):
-        self.run_test_get_elements_dataframe_not_elements(use_blob=True)
 
     def test_get_element_names(self):
         element_names = self.tm1.dimensions.hierarchies.elements.get_element_names(
@@ -831,6 +877,7 @@ def test_get_all_element_identifiers(self):
             "1989/90",
             "1990/91",
             "1991/92",
+            "All Years",
             "Total Years",
             "All Consolidations",
             *self.years,