TM1py 2.2.2__tar.gz → 2.2.4__tar.gz

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

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

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

@@ -8,16 +8,31 @@ from typing import Dict, Optional
 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):
     """Abstraction on TM1 MDX view
 
-    IMPORTANT. MDXViews can't be seen through the old TM1 clients (Archict, Perspectives). They do exist though!
+    IMPORTANT. MDXViews can't be seen through the old TM1 clients (Architect, Perspectives). They do exist though!
     """
 
-    def __init__(self, cube_name: str, view_name: str, MDX: str):
+    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
+        self._dynamic_properties = {}
+        self.dynamic_properties = dynamic_properties
 
     @property
     def mdx(self):
@@ -35,6 +50,14 @@ 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()
@@ -74,6 +97,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},
         )
 
     def construct_body(self) -> str:
@@ -81,4 +105,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})
         return json.dumps(mdx_view_as_dict, ensure_ascii=False)

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

@@ -1187,7 +1187,7 @@ class ElementService(ObjectService):
          to return, can be None or empty
         :param element_properties: list of element properties (e.g., Name, UniqueName, Type, Level, Index,
         Attributes/Color) to return, can be empty
-        :return: dictionary of members, unique names, weights, types, and parents
+        :return: dictionary of members, unique names, weights, types, and parents or async id when return_async_id is True
         """
 
         top = f"$top={top_records};" if top_records else ""
@@ -1241,8 +1241,11 @@ class ElementService(ObjectService):
 
         payload = {"MDX": mdx}
         response = self._rest.POST(url, json.dumps(payload, ensure_ascii=False), **kwargs)
-        raw_dict = response.json()
-        return [tuples["Members"] for tuples in raw_dict["Tuples"]]
+        if kwargs.get("return_async_id", False):
+            return response
+        else:
+            raw_dict = response.json()
+            return [tuples["Members"] for tuples in raw_dict["Tuples"]]
 
     def remove_edge(self, dimension_name: str, hierarchy_name: str, parent: str, component: str, **kwargs) -> Response:
         """Remove one edge from hierarchy. Fails if parent or child element doesn't exist.

{tm1py-2.2.2 → tm1py-2.2.4}/TM1py/Services/FileService.py

@@ -78,9 +78,25 @@ class FileService(ObjectService):
         path = Path(folder_name)
         url = self._construct_content_url(path, exclude_path_end=True, extension="Contents")
 
-        body = {"@odata.type": "#ibm.tm1.api.v1.Folder", "Name": folder_name.name}
+        body = {"@odata.type": "#ibm.tm1.api.v1.Folder", "Name": path.name}
         self._rest.POST(url, json.dumps(body), **kwargs)
 
+    @require_version(version="12")
+    def create_folder(self, folder_name: Union[str, Path], **kwargs):
+        """Create folder(s)
+
+        Supports recursive creation (e.g., 'folderA/folderB/folderC')
+
+        :param folder_name: folder name or path to nested folders
+        :return: None
+        """
+        path = Path(folder_name)
+        folder_path = Path()
+        for part in path.parts:
+            folder_path = folder_path.joinpath(part)
+            if not self.exists(folder_path, **kwargs):
+                self._create_folder(folder_name=folder_path, **kwargs)
+
     def _construct_content_url(self, path: Path, exclude_path_end: bool = True, extension: str = "Contents") -> str:
         """Dynamically construct URL to use in FileService functions
 

{tm1py-2.2.2 → tm1py-2.2.4}/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 MDXView
+from TM1py.Objects.MDXView import MDX_VIEW_EXCLUDED_KEYS, MDXView
 from TM1py.Objects.NativeView import NativeView
 from TM1py.Services.ObjectService import ObjectService
 from TM1py.Services.RestService import RestService
@@ -65,8 +65,11 @@ 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"])
+            return MDXView(
+                cube_name=cube_name, view_name=view_name, MDX=view_as_dict["MDX"], dynamic_properties=dynamic_properties
+            )
         else:
             return self.get_native_view(cube_name=cube_name, view_name=view_name, private=private)
 

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

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

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

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