TM1py 2.2.4__tar.gz → 2.2.5__tar.gz

{tm1py-2.2.4 → tm1py-2.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TM1py
-Version: 2.2.4
+Version: 2.2.5
 Summary: A python module for TM1.
 Author-email: Marius Wirtz <MWirtz@cubewise.com>
 License: MIT

tm1py-2.2.5/TM1py/Objects/DynamicPropertiesMixin.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+from typing import Dict, Optional
+
+
+class DynamicPropertiesMixin:
+    """Mixin that adds support for dynamic/extra properties from the TM1 REST API.
+
+    TM1 objects can carry additional properties beyond their known fields.
+    This mixin provides a common interface to store, filter, and serialize them.
+
+    Subclasses must define ``_DYNAMIC_PROPERTIES_EXCLUDED_KEYS`` as a frozenset
+    of keys that are already handled explicitly (e.g. "Name", "@odata.type").
+    """
+
+    _DYNAMIC_PROPERTIES_EXCLUDED_KEYS: frozenset = frozenset()
+
+    @property
+    def dynamic_properties(self) -> Dict:
+        return self._dynamic_properties
+
+    @dynamic_properties.setter
+    def dynamic_properties(self, value: Optional[Dict]) -> None:
+        self._dynamic_properties = value or {}
+
+    @classmethod
+    def _filter_dynamic_properties(cls, properties: Dict) -> Dict:
+        """Return a copy of *properties* with all reserved/excluded keys removed."""
+        return {k: v for k, v in properties.items() if k not in cls._DYNAMIC_PROPERTIES_EXCLUDED_KEYS}

{tm1py-2.2.4 → tm1py-2.2.5}/TM1py/Objects/MDXView.py

@@ -5,29 +5,30 @@ import json
 import re
 from typing import Dict, Optional
 
+from TM1py.Objects.DynamicPropertiesMixin import DynamicPropertiesMixin
 from TM1py.Objects.View import View
 from TM1py.Utils import case_and_space_insensitive_equals
 
-MDX_VIEW_EXCLUDED_KEYS = frozenset(
-    {
-        "@odata.type",
-        "@odata.context",
-        "@odata.etag",
-        "Name",
-        "MDX",
-        "Cube",
-        "Attributes",
-        "LocalizedAttributes",
-    }
-)
-
-
-class MDXView(View):
+
+class MDXView(DynamicPropertiesMixin, View):
     """Abstraction on TM1 MDX view
 
     IMPORTANT. MDXViews can't be seen through the old TM1 clients (Architect, Perspectives). They do exist though!
     """
 
+    _DYNAMIC_PROPERTIES_EXCLUDED_KEYS = frozenset(
+        {
+            "@odata.type",
+            "@odata.context",
+            "@odata.etag",
+            "Name",
+            "MDX",
+            "Cube",
+            "Attributes",
+            "LocalizedAttributes",
+        }
+    )
+
     def __init__(self, cube_name: str, view_name: str, MDX: str, dynamic_properties: Optional[Dict] = None):
         View.__init__(self, cube_name, view_name)
         self._mdx = MDX
@@ -50,14 +51,6 @@ class MDXView(View):
     def MDX(self, value: str):
         self._mdx = value
 
-    @property
-    def dynamic_properties(self) -> Dict:
-        return self._dynamic_properties
-
-    @dynamic_properties.setter
-    def dynamic_properties(self, value: Optional[Dict]) -> None:
-        self._dynamic_properties = value or {}
-
     @property
     def body(self) -> str:
         return self.construct_body()
@@ -97,7 +90,7 @@ class MDXView(View):
             cube_name=view_as_dict["Cube"]["Name"] if not cube_name else cube_name,
             view_name=view_as_dict["Name"],
             MDX=view_as_dict["MDX"],
-            dynamic_properties={k: v for k, v in view_as_dict.items() if k not in MDX_VIEW_EXCLUDED_KEYS},
+            dynamic_properties=cls._filter_dynamic_properties(view_as_dict),
         )
 
     def construct_body(self) -> str:
@@ -105,5 +98,5 @@ class MDXView(View):
         mdx_view_as_dict["@odata.type"] = "ibm.tm1.api.v1.MDXView"
         mdx_view_as_dict["Name"] = self._name
         mdx_view_as_dict["MDX"] = self._mdx
-        mdx_view_as_dict.update({k: v for k, v in self._dynamic_properties.items() if k not in MDX_VIEW_EXCLUDED_KEYS})
+        mdx_view_as_dict.update(self._filter_dynamic_properties(self._dynamic_properties))
         return json.dumps(mdx_view_as_dict, ensure_ascii=False)

{tm1py-2.2.4 → tm1py-2.2.5}/TM1py/Objects/NativeView.py

@@ -6,18 +6,37 @@ from typing import Dict, Iterable, List, Optional, Union
 from mdxpy import MdxBuilder, MdxHierarchySet, Member
 
 from TM1py.Objects.Axis import ViewAxisSelection, ViewTitleSelection
+from TM1py.Objects.DynamicPropertiesMixin import DynamicPropertiesMixin
 from TM1py.Objects.Subset import AnonymousSubset, Subset
 from TM1py.Objects.View import View
 from TM1py.Utils import case_and_space_insensitive_equals, read_object_name_from_url
 
 
-class NativeView(View):
+class NativeView(DynamicPropertiesMixin, View):
     """Abstraction of TM1 NativeView (classic cube view)
 
     :Notes:
         Complete, functional and tested
     """
 
+    _DYNAMIC_PROPERTIES_EXCLUDED_KEYS = frozenset(
+        {
+            "@odata.type",
+            "@odata.context",
+            "@odata.etag",
+            "Name",
+            "Columns",
+            "Rows",
+            "Titles",
+            "SuppressEmptyColumns",
+            "SuppressEmptyRows",
+            "FormatString",
+            "Cube",
+            "Attributes",
+            "LocalizedAttributes",
+        }
+    )
+
     def __init__(
         self,
         cube_name: str,
@@ -28,6 +47,7 @@ class NativeView(View):
         titles: Optional[Iterable[ViewTitleSelection]] = None,
         columns: Optional[Iterable[ViewAxisSelection]] = None,
         rows: Optional[Iterable[ViewAxisSelection]] = None,
+        dynamic_properties: Optional[Dict] = None,
     ):
         super().__init__(cube_name, view_name)
         self._suppress_empty_columns = suppress_empty_columns
@@ -36,6 +56,8 @@ class NativeView(View):
         self._titles = list(titles) if titles else []
         self._columns = list(columns) if columns else []
         self._rows = list(rows) if rows else []
+        self._dynamic_properties = {}
+        self.dynamic_properties = dynamic_properties
 
     @property
     def body(self) -> str:
@@ -270,6 +292,7 @@ class NativeView(View):
             titles=titles,
             columns=columns,
             rows=rows,
+            dynamic_properties=cls._filter_dynamic_properties(view_as_dict),
         )
 
     @classmethod
@@ -303,29 +326,19 @@ class NativeView(View):
 
         :return: string, the valid JSON
         """
-        top_json = '{"@odata.type": "ibm.tm1.api.v1.NativeView","Name": "' + self._name + '",'
-        columns_json = ",".join([column.body for column in self._columns])
-        rows_json = ",".join([row.body for row in self._rows])
-        titles_json = ",".join([title.body for title in self._titles])
-        bottom_json = (
-            '"SuppressEmptyColumns": '
-            + str(self._suppress_empty_columns).lower()
-            + ',"SuppressEmptyRows":'
-            + str(self._suppress_empty_rows).lower()
-            + ',"FormatString": "'
-            + self._format_string
-            + '"}'
-        )
-        return "".join(
-            [
-                top_json,
-                '"Columns":[',
-                columns_json,
-                '],"Rows":[',
-                rows_json,
-                '],"Titles":[',
-                titles_json,
-                "],",
-                bottom_json,
-            ]
-        )
+        body = {
+            "@odata.type": "ibm.tm1.api.v1.NativeView",
+            "Name": self._name,
+            "Columns": [json.loads(column.body) for column in self._columns],
+            "Rows": [json.loads(row.body) for row in self._rows],
+            "Titles": [json.loads(title.body) for title in self._titles],
+            "SuppressEmptyColumns": self._suppress_empty_columns,
+            "SuppressEmptyRows": self._suppress_empty_rows,
+            "FormatString": self._format_string,
+        }
+
+        dynamic_props = self._filter_dynamic_properties(self._dynamic_properties)
+        if dynamic_props:
+            body.update(dynamic_props)
+
+        return json.dumps(body, ensure_ascii=False)

{tm1py-2.2.4 → tm1py-2.2.5}/TM1py/Services/ElementService.py

@@ -136,32 +136,74 @@ class ElementService(ObjectService):
         use_ti: bool = False,
         use_blob: bool = False,
         remove_blob: bool = True,
+        skip_invalid_edges: bool = True,
         **kwargs,
     ):
+        """
+        Remove edges in TM1.
+
+        :param dimension_name: The name of the dimension.
+        :param hierarchy_name: The name of the hierarchy.
+        :param edges: A list of tuples representing the edges to remove, where each tuple contains a parent and a child.
+        :param use_ti: A boolean indicating whether to use a TI process to delete edges (default: False).
+        :param use_blob: A boolean indicating whether to use a blob file to delete edges (default: False).
+        :param remove_blob: A boolean indicating whether to remove the parent-child file after use (default: True).
+        :param skip_invalid_edges: A boolean indicating whether to skip invalid edges (default: True).
+        """
         if use_ti:
-            return self.delete_edges_use_ti(dimension_name, hierarchy_name, edges, **kwargs)
+            return self.delete_edges_use_ti(dimension_name, hierarchy_name, edges, skip_invalid_edges, **kwargs)
 
         if use_blob:
-            return self.delete_edges_use_blob(dimension_name, hierarchy_name, edges, remove_blob, **kwargs)
+            return self.delete_edges_use_blob(
+                dimension_name, hierarchy_name, edges, remove_blob, skip_invalid_edges, **kwargs
+            )
 
         h_service = self._get_hierarchy_service()
         h = h_service.get(dimension_name, hierarchy_name, **kwargs)
         for edge in edges:
+            if edge not in h.edges and not skip_invalid_edges:
+                raise TM1pyException(f"Edge {edge} does not exist in hierarchy [{dimension_name}].[{hierarchy_name}]")
             h.remove_edge(parent=edge[0], component=edge[1])
         h_service.update(h, **kwargs)
 
-    def delete_edges_use_ti(self, dimension_name: str, hierarchy_name: str, edges: List[str] = None, **kwargs):
+    def delete_edges_use_ti(
+        self,
+        dimension_name: str,
+        hierarchy_name: str,
+        edges: List[str] = None,
+        skip_invalid_edges: bool = True,
+        **kwargs,
+    ):
+        """
+        Remove edges in TM1 via an unbound TI process.
+        :param dimension_name: The name of the dimension.
+        :param hierarchy_name: The name of the hierarchy.
+        :param edges: A list of tuples representing the edges to remove, where each tuple contains a parent and a child.
+        :param skip_invalid_edges: A boolean indicating whether to skip invalid edges (default: True).
+        """
         if not edges:
             return
 
         def escape_single_quote(text):
             return text.replace("'", "''")
 
-        statements = [
-            f"HierarchyElementComponentDelete('{dimension_name}', '{hierarchy_name}', "
-            f"'{escape_single_quote(parent)}', '{escape_single_quote(child)}');"
-            for (parent, child) in edges
-        ]
+        statements = []
+        for parent, child in edges:
+            parent = escape_single_quote(parent)
+            child = escape_single_quote(child)
+            if skip_invalid_edges:
+                statements.extend(
+                    [
+                        f"IF(ElementIsParent('{dimension_name}','{hierarchy_name}','{parent}','{child}')=1);",
+                        f"HierarchyElementComponentDelete('{dimension_name}','{hierarchy_name}','{parent}','{child}');",
+                        "ENDIF;",
+                    ]
+                )
+
+            else:
+                statements.append(
+                    f"HierarchyElementComponentDelete('{dimension_name}', '{hierarchy_name}', '{parent}', '{child}');"
+                )
 
         unbound_process_name = self.suggest_unique_object_name()
 
@@ -174,7 +216,13 @@ class ElementService(ObjectService):
     @require_data_admin
     @require_ops_admin
     def delete_edges_use_blob(
-        self, dimension_name: str, hierarchy_name: str, edges: List[str] = None, remove_blob: bool = True, **kwargs
+        self,
+        dimension_name: str,
+        hierarchy_name: str,
+        edges: List[str] = None,
+        remove_blob: bool = True,
+        skip_invalid_edges: bool = True,
+        **kwargs,
     ):
         """
         Remove edges in TM1 via an unbound TI process having an uploaded CSV as the data source.
@@ -183,6 +231,7 @@ class ElementService(ObjectService):
         :param hierarchy_name: The name of the hierarchy.
         :param edges: A list of tuples representing the edges to remove, where each tuple contains a parent and a child.
         :param remove_blob: A boolean indicating whether to remove the parent-child file after use (default: True).
+        :param skip_invalid_edges: A boolean indicating whether to skip invalid edges (default: True).
         :param kwargs: Additional arguments for the process execution.
         :return: None
         """
@@ -209,6 +258,7 @@ class ElementService(ObjectService):
                 hierarchy_name=hierarchy_name,
                 process_name=unique_name,
                 blob_filename=file_name,
+                skip_invalid_edges=skip_invalid_edges,
             )
 
             success, status, log_file = process_service.execute_process_with_return(process=process, **kwargs)
@@ -223,7 +273,12 @@ class ElementService(ObjectService):
                 file_service.delete(file_name=file_name)
 
     def _build_unwind_hierarchy_edges_from_blob_process(
-        self, dimension_name: str, hierarchy_name: str, process_name: str, blob_filename: str
+        self,
+        dimension_name: str,
+        hierarchy_name: str,
+        process_name: str,
+        blob_filename: str,
+        skip_invalid_edges: bool = True,
     ) -> Process:
 
         # v11 automatically adds blb file extensions to documents created via the contents api
@@ -251,7 +306,15 @@ class ElementService(ObjectService):
         hierarchyupdate_process.add_variable(name=child_variable, variable_type="String")
 
         # Write the statement for delete component in hierarchy
-        delete_component = f"\rHierarchyElementComponentDelete('{dimension_name}', '{hierarchy_name}', {parent_variable}, {child_variable});"
+        if skip_invalid_edges:
+            delete_component = (
+                f"\r"
+                f"IF(ElementIsParent('{dimension_name}','{hierarchy_name}',{parent_variable},{child_variable})=1);"
+                f"HierarchyElementComponentDelete('{dimension_name}','{hierarchy_name}',{parent_variable},{child_variable});"
+                f"ENDIF;"
+            )
+        else:
+            delete_component = f"HierarchyElementComponentDelete('{dimension_name}','{hierarchy_name}',{parent_variable},{child_variable});"
 
         # Define Metadata section
         metadata_statement = delete_component

{tm1py-2.2.4 → tm1py-2.2.5}/TM1py/Services/ViewService.py

@@ -7,7 +7,7 @@ from requests import Response
 
 from TM1py.Exceptions.Exceptions import TM1pyRestException
 from TM1py.Objects import View
-from TM1py.Objects.MDXView import MDX_VIEW_EXCLUDED_KEYS, MDXView
+from TM1py.Objects.MDXView import MDXView
 from TM1py.Objects.NativeView import NativeView
 from TM1py.Services.ObjectService import ObjectService
 from TM1py.Services.RestService import RestService
@@ -65,11 +65,8 @@ class ViewService(ObjectService):
         url = format_url("/Cubes('{}')/{}('{}')?$expand=*", cube_name, view_type, view_name)
         response = self._rest.GET(url, **kwargs)
         view_as_dict = response.json()
-        dynamic_properties = {k: v for k, v in view_as_dict.items() if k not in MDX_VIEW_EXCLUDED_KEYS}
         if "MDX" in view_as_dict:
-            return MDXView(
-                cube_name=cube_name, view_name=view_name, MDX=view_as_dict["MDX"], dynamic_properties=dynamic_properties
-            )
+            return MDXView.from_dict(view_as_dict)
         else:
             return self.get_native_view(cube_name=cube_name, view_name=view_name, private=private)
 

{tm1py-2.2.4 → tm1py-2.2.5}/TM1py.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TM1py
-Version: 2.2.4
+Version: 2.2.5
 Summary: A python module for TM1.
 Author-email: Marius Wirtz <MWirtz@cubewise.com>
 License: MIT

{tm1py-2.2.4 → tm1py-2.2.5}/TM1py.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ TM1py/Objects/ChoreStartTime.py
 TM1py/Objects/ChoreTask.py
 TM1py/Objects/Cube.py
 TM1py/Objects/Dimension.py
+TM1py/Objects/DynamicPropertiesMixin.py
 TM1py/Objects/Element.py
 TM1py/Objects/ElementAttribute.py
 TM1py/Objects/Git.py

{tm1py-2.2.4 → tm1py-2.2.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "TM1py"
-version = "2.2.4"
+version = "2.2.5"
 description = "A python module for TM1."
 readme = "README.md"
 license = {text = "MIT"}