format: reformat the whole project with black

Author: onefloid

TM1py/Exceptions/Exceptions.py

@@ -44,31 +44,33 @@ def __init__(self, function: str):
     def __str__(self):
         return f"Function '{self.function}' requires admin permissions"
 
+
 class TM1pyNotDataAdminException(Exception):
     def __init__(self, function: str):
         self.function = function
 
     def __str__(self):
         return f"Function '{self.function}' requires DataAdmin permissions"
-    
+
+
 class TM1pyNotSecurityAdminException(Exception):
     def __init__(self, function: str):
         self.function = function
 
     def __str__(self):
         return f"Function '{self.function}' requires SecurityAdmin permissions"
-    
+
+
 class TM1pyNotOpsAdminException(Exception):
     def __init__(self, function: str):
         self.function = function
 
     def __str__(self):
         return f"Function '{self.function}' requires OperationsAdmin permissions"
 
-class TM1pyException(Exception):
-    """ The default exception for TM1py
 
-    """
+class TM1pyException(Exception):
+    """The default exception for TM1py"""
 
     def __init__(self, message):
         self.message = message
@@ -78,9 +80,7 @@ def __str__(self):
 
 
 class TM1pyRestException(TM1pyException):
-    """ Exception for failing REST operations
-
-    """
+    """Exception for failing REST operations"""
 
     def __init__(self, response: str, status_code: int, reason: str, headers: Mapping):
         super(TM1pyRestException, self).__init__(response)
@@ -106,10 +106,8 @@ def headers(self):
 
     def __str__(self):
         return "Text: '{}' - Status Code: {} - Reason: '{}' - Headers: {}".format(
-            self.message,
-            self._status_code,
-            self._reason,
-            self._headers)
+            self.message, self._status_code, self._reason, self._headers
+        )
 
 
 class TM1pyWriteFailureException(TM1pyException):
@@ -129,6 +127,8 @@ def __init__(self, statuses: List[str], error_log_files: List[str], attempts: in
         self.error_log_files = error_log_files
         self.attempts = attempts
 
-        message = f"{len(self.statuses)} out of {self.attempts} write operations failed partially. " \
-                  f"Details: {self.error_log_files}"
+        message = (
+            f"{len(self.statuses)} out of {self.attempts} write operations failed partially. "
+            f"Details: {self.error_log_files}"
+        )
         super(TM1pyWritePartialFailureException, self).__init__(message)

TM1py/Exceptions/__init__.py

@@ -1,2 +1,9 @@
-from TM1py.Exceptions.Exceptions import TM1pyRestException, TM1pyException, TM1pyTimeout, TM1pyVersionException, \
-    TM1pyNotAdminException, TM1pyWriteFailureException, TM1pyWritePartialFailureException
+from TM1py.Exceptions.Exceptions import (
+    TM1pyRestException,
+    TM1pyException,
+    TM1pyTimeout,
+    TM1pyVersionException,
+    TM1pyNotAdminException,
+    TM1pyWriteFailureException,
+    TM1pyWritePartialFailureException,
+)

TM1py/Objects/Annotation.py

@@ -2,24 +2,33 @@
 
 import collections
 import json
-from typing import Iterable, Dict, List
+from typing import Dict, Iterable, List
 
 from TM1py.Objects.TM1Object import TM1Object
 from TM1py.Utils import format_url
 
 
 class Annotation(TM1Object):
-    """ Abtraction of TM1 Annotation
+    """Abtraction of TM1 Annotation
 
-        :Notes:
-            - Class complete, functional and tested.
-            - doesn't cover Attachments though
+    :Notes:
+        - Class complete, functional and tested.
+        - doesn't cover Attachments though
     """
 
-    def __init__(self, comment_value: str, object_name: str, dimensional_context: Iterable[str],
-                 comment_type: str = 'ANNOTATION', annotation_id: str = None,
-                 text: str = '', creator: str = None, created: str = None, last_updated_by: str = None,
-                 last_updated: str = None):
+    def __init__(
+        self,
+        comment_value: str,
+        object_name: str,
+        dimensional_context: Iterable[str],
+        comment_type: str = "ANNOTATION",
+        annotation_id: str = None,
+        text: str = "",
+        creator: str = None,
+        created: str = None,
+        last_updated_by: str = None,
+        last_updated: str = None,
+    ):
         self._id = annotation_id
         self._text = text
         self._creator = creator
@@ -32,26 +41,35 @@ def __init__(self, comment_value: str, object_name: str, dimensional_context: It
         self._object_name = object_name
 
     @classmethod
-    def from_json(cls, annotation_as_json: str) -> 'Annotation':
-        """ Alternative constructor
+    def from_json(cls, annotation_as_json: str) -> "Annotation":
+        """Alternative constructor
 
-            :param annotation_as_json: String, JSON
-            :return: instance of TM1py.Process
+        :param annotation_as_json: String, JSON
+        :return: instance of TM1py.Process
         """
         annotation_as_dict = json.loads(annotation_as_json)
-        annotation_id = annotation_as_dict['ID']
-        text = annotation_as_dict['Text']
-        creator = annotation_as_dict['Creator']
-        created = annotation_as_dict['Created']
-        last_updated_by = annotation_as_dict['LastUpdatedBy']
-        last_updated = annotation_as_dict['LastUpdated']
-        dimensional_context = [item['Name'] for item in annotation_as_dict['DimensionalContext']]
-        comment_type = annotation_as_dict['commentType']
-        comment_value = annotation_as_dict['commentValue']
-        object_name = annotation_as_dict['objectName']
-        return cls(comment_value=comment_value, object_name=object_name, dimensional_context=dimensional_context,
-                   comment_type=comment_type, annotation_id=annotation_id, text=text, creator=creator, created=created,
-                   last_updated_by=last_updated_by, last_updated=last_updated)
+        annotation_id = annotation_as_dict["ID"]
+        text = annotation_as_dict["Text"]
+        creator = annotation_as_dict["Creator"]
+        created = annotation_as_dict["Created"]
+        last_updated_by = annotation_as_dict["LastUpdatedBy"]
+        last_updated = annotation_as_dict["LastUpdated"]
+        dimensional_context = [item["Name"] for item in annotation_as_dict["DimensionalContext"]]
+        comment_type = annotation_as_dict["commentType"]
+        comment_value = annotation_as_dict["commentValue"]
+        object_name = annotation_as_dict["objectName"]
+        return cls(
+            comment_value=comment_value,
+            object_name=object_name,
+            dimensional_context=dimensional_context,
+            comment_type=comment_type,
+            annotation_id=annotation_id,
+            text=text,
+            creator=creator,
+            created=created,
+            last_updated_by=last_updated_by,
+            last_updated=last_updated,
+        )
 
     @property
     def body(self) -> str:
@@ -98,55 +116,55 @@ def id(self) -> str:
         return self._id
 
     def move(self, dimension_order: Iterable[str], dimension: str, target_element: str, source_element: str = None):
-        """ Move annotation on given dimension from source_element to target_element
-        
-            :param dimension_order: List, order of the dimensions in the cube
-            :param dimension: dimension name
-            :param target_element: target element name
-            :param source_element:  source element name
-            :return: 
+        """Move annotation on given dimension from source_element to target_element
+
+        :param dimension_order: List, order of the dimensions in the cube
+        :param dimension: dimension name
+        :param target_element: target element name
+        :param source_element:  source element name
+        :return:
         """
         for i, dimension_name in enumerate(dimension_order):
             if dimension_name.lower() == dimension.lower():
                 if not source_element or self._dimensional_context[i] == source_element:
                     self._dimensional_context[i] = target_element
 
     def _construct_body(self) -> Dict:
-        """ construct the ODATA conform JSON represenation for the Annotation entity.
+        """construct the ODATA conform JSON represenation for the Annotation entity.
 
-            :return: string, the valid JSON
+        :return: string, the valid JSON
         """
-        dimensional_context = [{'Name': element} for element in self._dimensional_context]
+        dimensional_context = [{"Name": element} for element in self._dimensional_context]
         body = collections.OrderedDict()
-        body['ID'] = self._id
-        body['Text'] = self._text
-        body['Creator'] = self._creator
-        body['Created'] = self._created
-        body['LastUpdatedBy'] = self._last_updated_by
-        body['LastUpdated'] = self._last_updated
-        body['DimensionalContext'] = dimensional_context
-        comment_locations = ','.join(self._dimensional_context)
-        body['commentLocation'] = comment_locations[1:]
-        body['commentType'] = self._comment_type
-        body['commentValue'] = self._comment_value
-        body['objectName'] = self._object_name
+        body["ID"] = self._id
+        body["Text"] = self._text
+        body["Creator"] = self._creator
+        body["Created"] = self._created
+        body["LastUpdatedBy"] = self._last_updated_by
+        body["LastUpdated"] = self._last_updated
+        body["DimensionalContext"] = dimensional_context
+        comment_locations = ",".join(self._dimensional_context)
+        body["commentLocation"] = comment_locations[1:]
+        body["commentType"] = self._comment_type
+        body["commentValue"] = self._comment_value
+        body["objectName"] = self._object_name
         return body
 
     def construct_body_for_post(self, cube_dimensions) -> Dict:
         body = collections.OrderedDict()
         body["Text"] = self.text
-        body["ApplicationContext"] = [{
-            "[email protected]": "ApplicationContextFacets('}Cubes')",
-            "Value": self.object_name}]
+        body["ApplicationContext"] = [
+            {"[email protected]": "ApplicationContextFacets('}Cubes')", "Value": self.object_name}
+        ]
         body["[email protected]"] = []
 
         for dimension, element in zip(cube_dimensions, self.dimensional_context):
             coordinates = format_url("Dimensions('{}')/Hierarchies('{}')/Members('{}')", dimension, dimension, element)
             body["[email protected]"].append(coordinates)
 
-        body['objectName'] = self.object_name
-        body['commentValue'] = self.comment_value
-        body['commentType'] = 'ANNOTATION'
-        body['commentLocation'] = ','.join(self.dimensional_context)
+        body["objectName"] = self.object_name
+        body["commentValue"] = self.comment_value
+        body["commentType"] = "ANNOTATION"
+        body["commentLocation"] = ",".join(self.dimensional_context)
 
         return body

TM1py/Objects/Application.py

@@ -8,7 +8,7 @@
 from TM1py.Objects.TM1Object import TM1Object
 from TM1py.Utils import format_url
 
-ApplicationType = namedtuple('ApplicationType', ['value', 'suffix', 'odata_type'])
+ApplicationType = namedtuple("ApplicationType", ["value", "suffix", "odata_type"])
 
 
 class ApplicationTypes(Enum):
@@ -43,7 +43,7 @@ def __init__(self, path: str, name: str, application_type: Union[ApplicationType
         self.path = path
         # remove suffix from name
         if application_type.suffix and name.endswith(application_type.suffix):
-            self.name = name[: - len(application_type.suffix)]
+            self.name = name[: -len(application_type.suffix)]
         else:
             self.name = name
         # raise ValueError if not a valid type
@@ -103,8 +103,9 @@ def body(self) -> str:
 
 
 class DocumentApplication(Application):
-    def __init__(self, path: str, name: str, content: bytes, file_id: str = None, file_name: str = None,
-                 last_updated: str = None):
+    def __init__(
+        self, path: str, name: str, content: bytes, file_id: str = None, file_name: str = None, last_updated: str = None
+    ):
         super().__init__(path, name, ApplicationTypes.DOCUMENT)
         self.content = content
         # below fields only populated for retrieved applications
@@ -113,10 +114,7 @@ def __init__(self, path: str, name: str, content: bytes, file_id: str = None, fi
         self.last_updated = last_updated
 
     def to_xlsx(self, path_to_file: str):
-        warnings.warn(
-            f"Function 'to_xlsx' is deprecated. Use 'to_file' instead",
-            DeprecationWarning,
-            stacklevel=2)
+        warnings.warn(f"Function 'to_xlsx' is deprecated. Use 'to_file' instead", DeprecationWarning, stacklevel=2)
         return self.to_file(path_to_file=path_to_file)
 
     def to_file(self, path_to_file: str):
@@ -170,7 +168,10 @@ def body(self) -> str:
         body_as_dict = self.body_as_dict
         body_as_dict["[email protected]"] = format_url(
             "Dimensions('{}')/Hierarchies('{}')/Subsets('{}')",
-            self.dimension_name, self.hierarchy_name, self.subset_name)
+            self.dimension_name,
+            self.hierarchy_name,
+            self.subset_name,
+        )
         return json.dumps(body_as_dict, ensure_ascii=False)