pyxecm 3.0.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

pyxecm/avts.py

@@ -33,8 +33,8 @@ USER_AGENT = (
 
 REQUEST_HEADERS = {"User-Agent": USER_AGENT, "accept": "application/json", "Content-Type": "application/json"}
 
-REQUEST_TIMEOUT = 60
-REQUEST_RETRY_DELAY = 20
+REQUEST_TIMEOUT = 60.0
+REQUEST_RETRY_DELAY = 20.0
 REQUEST_MAX_RETRIES = 2
 
 default_logger = logging.getLogger(MODULE_NAME)
@@ -157,7 +157,7 @@ class AVTS:
         data: dict | list | None = None,
         json_data: dict | None = None,
         files: dict | None = None,
-        timeout: int | None = REQUEST_TIMEOUT,
+        timeout: float | None = REQUEST_TIMEOUT,
         show_error: bool = True,
         failure_message: str = "",
         success_message: str = "",
@@ -181,7 +181,7 @@ class AVTS:
                 Dictionary of {"name": file-tuple} for multipart encoding upload.
                 The file-tuple can be a 2-tuple ("filename", fileobj) or a 3-tuple
                 ("filename", fileobj, "content_type").
-            timeout (int | None, optional):
+            timeout (float | None, optional):
                 Timeout for the request in seconds. Defaults to REQUEST_TIMEOUT.
             show_error (bool, optional):
                 Whether or not an error should be logged in case of a failed REST call.

pyxecm/coreshare.py

@@ -53,8 +53,8 @@ REQUEST_LOGIN_HEADERS = {
     "Accept": "application/json",
 }
 
-REQUEST_TIMEOUT = 60
-REQUEST_RETRY_DELAY = 20
+REQUEST_TIMEOUT = 60.0
+REQUEST_RETRY_DELAY = 20.0
 REQUEST_MAX_RETRIES = 2
 
 CONTENT_MANAGER_ROLE_ID = 5
@@ -303,7 +303,7 @@ class CoreShare:
         data: dict | None = None,
         json_data: dict | None = None,
         files: dict | None = None,
-        timeout: int | None = REQUEST_TIMEOUT,
+        timeout: float | None = REQUEST_TIMEOUT,
         show_error: bool = True,
         show_warning: bool = False,
         warning_message: str = "",
@@ -331,7 +331,7 @@ class CoreShare:
             files (dict | None, optional):
                 Dictionary of {"name": file-tuple} for multipart encoding upload.
                 The file-tuple can be a 2-tuple ("filename", fileobj) or a 3-tuple ("filename", fileobj, "content_type")
-            timeout (int | None, optional):
+            timeout (float | None, optional):
                 Timeout for the request in seconds. Defaults to REQUEST_TIMEOUT.
             show_error (bool, optional):
                 Whether or not an error should be logged in case of a failed REST call.
@@ -463,7 +463,7 @@ class CoreShare:
                     time.sleep(REQUEST_RETRY_DELAY)  # Add a delay before retrying
                 else:
                     self.logger.error(
-                        "%s; timeout error.",
+                        "%s; timeout error!",
                         failure_message,
                     )
                     if retry_forever:
@@ -482,7 +482,7 @@ class CoreShare:
                     time.sleep(REQUEST_RETRY_DELAY)  # Add a delay before retrying
                 else:
                     self.logger.error(
-                        "%s; connection error.",
+                        "%s; connection error!",
                         failure_message,
                     )
                     if retry_forever:
@@ -2206,7 +2206,7 @@ class CoreShare:
 
         # Check if the photo file exists
         if not os.path.isfile(photo_path):
-            self.logger.error("Photo file -> %s not found!", photo_path)
+            self.logger.error("Photo file -> '%s' not found for Core Share user with ID -> %s!", photo_path, user_id)
             return None
 
         try:
@@ -2216,8 +2216,7 @@ class CoreShare:
         except OSError:
             # Handle any errors that occurred while reading the photo file
             self.logger.error(
-                "Error reading photo file -> %s",
-                photo_path,
+                "Error reading photo file -> '%s' for Core Share user with ID -> '%s'!", photo_path, user_id
             )
             return None
 
@@ -2238,7 +2237,7 @@ class CoreShare:
             headers=self.request_header_user(content_type=""),
             files=files,
             timeout=REQUEST_TIMEOUT,
-            failure_message="Failed to update profile photo of Core Share user with ID -> {}".format(
+            failure_message="Failed to update profile photo of Core Share user with ID -> '{}'".format(
                 user_id,
             ),
             user_credentials=True,
@@ -2668,7 +2667,7 @@ class CoreShare:
                         response = self.delete_document(item["id"])
                     else:
                         self.logger.error(
-                            "Unsupport resource type -> '%s'",
+                            "Unsupport resource type -> '%s'!",
                             item["resourceType"],
                         )
                         response = None
@@ -2756,7 +2755,7 @@ class CoreShare:
         )
 
         self.logger.debug(
-            "Revoke sharing of folder -> %s with group -> %s; calling -> %s",
+            "Revoke sharing of folder with ID -> '%s' with group with ID -> '%s'; calling -> %s",
             resource_id,
             group_id,
             request_url,
@@ -2767,7 +2766,7 @@ class CoreShare:
             method="DELETE",
             headers=request_header,
             timeout=REQUEST_TIMEOUT,
-            failure_message="Failed to revoke sharing Core Share folder with ID -> {} with group with ID -> {}".format(
+            failure_message="Failed to revoke sharing Core Share folder with ID -> '{}' with group with ID -> '{}'!".format(
                 resource_id,
                 group_id,
             ),
@@ -2794,7 +2793,7 @@ class CoreShare:
         response = self.get_group_shares(group_id=group_id)
 
         if not response or not response["shares"]:
-            self.logger.info("Group -> %s has no shares to revoke!", group_id)
+            self.logger.info("Group -> %s has no shares to revoke.", group_id)
             return True
 
         success = True
@@ -2802,7 +2801,7 @@ class CoreShare:
         items = response["shares"]
         for item in items:
             self.logger.info(
-                "Revoke sharing of folder -> %s (%s) with group -> %s...",
+                "Revoke sharing of folder -> '%s' (%s) with group -> %s...",
                 item["name"],
                 item["id"],
                 group_id,

pyxecm/helper/data.py

@@ -1484,10 +1484,11 @@ class Data:
             remainder = 0
 
         self.logger.info(
-            "Data frame has -> %s elements. We split it into -> %s partitions with -> %s rows and remainder -> %s...",
+            "Data frame has -> %s elements. We split it into -> %s partitions with -> %s row%s and remainder -> %s...",
             str(size),
             str(number),
             str(partition_size),
+            "s" if partition_size > 1 else "",
             str(remainder),
         )
 

pyxecm/helper/web.py

@@ -36,8 +36,8 @@ REQUEST_FORM_HEADERS = {
     "User-Agent": USER_AGENT,
     "Content-Type": "application/x-www-form-urlencoded",
 }
-REQUEST_TIMEOUT = 120
-REQUEST_RETRY_DELAY = 20
+REQUEST_TIMEOUT = 120.0
+REQUEST_RETRY_DELAY = 20.0
 REQUEST_MAX_RETRIES = 2
 
 default_logger = logging.getLogger(MODULE_NAME)
@@ -109,9 +109,9 @@ class HTTP:
         method: str = "POST",
         payload: dict | None = None,
         headers: dict | None = None,
-        timeout: int = REQUEST_TIMEOUT,
+        timeout: float | None = REQUEST_TIMEOUT,
         retries: int = REQUEST_MAX_RETRIES,
-        wait_time: int = REQUEST_RETRY_DELAY,
+        wait_time: float = REQUEST_RETRY_DELAY,
         wait_on_status: list | None = None,
         show_error: bool = True,
         stream: bool = False,
@@ -128,7 +128,7 @@ class HTTP:
             headers (dict, optional):
                 Request header. Defaults to None. If None then a default
                 value defined in REQUEST_FORM_HEADERS is used.
-            timeout (int, optional):
+            timeout (float | None, optional):
                 The timeout in seconds. Defaults to REQUEST_TIMEOUT.
             retries (int, optional):
                 The number of retries. If -1 then unlimited retries.
@@ -238,7 +238,7 @@ class HTTP:
             if retries == 0:
                 return None
 
-            if wait_time > 0:
+            if wait_time > 0.0:
                 self.logger.warning(
                     "Sleeping %s seconds and then trying once more...",
                     str(wait_time * try_counter),
@@ -255,9 +255,9 @@ class HTTP:
         self,
         url: str,
         filename: str,
-        timeout: int = REQUEST_TIMEOUT,
-        retries: int = REQUEST_MAX_RETRIES,
-        wait_time: int = REQUEST_RETRY_DELAY,
+        timeout: float = REQUEST_TIMEOUT,
+        retries: int | None = REQUEST_MAX_RETRIES,
+        wait_time: float = REQUEST_RETRY_DELAY,
         wait_on_status: list | None = None,
         chunk_size: int = 8192,
         show_error: bool = True,
@@ -269,11 +269,11 @@ class HTTP:
                 The URL to open / load.
             filename (str):
                 The filename to save the content.
-            timeout (int, optional):
+            timeout (float, optional):
                 The timeout in seconds.
             retries (int, optional):
                 The number of retries. If -1 then unlimited retries.
-            wait_time (int, optional):
+            wait_time (float, optional):
                 The number of seconds to wait after each try.
             wait_on_status (list, optional):
                 The list of status codes we want to wait on.

pyxecm/helper/xml.py

@@ -55,12 +55,16 @@ class XML:
     # end method definition
 
     @classmethod
-    def xml_to_dict(cls, xml_string: str) -> dict:
+    def xml_to_dict(cls, xml_string: str, encode: bool = False, include_attributes: bool = False) -> dict:
         """Parse XML string and return a dictionary without namespaces.
 
         Args:
             xml_string (str):
                 The XML string to process.
+            encode (bool, optional):
+                True if the XML string should be encoded to UTF-8 bytes. Defaults to False.
+            include_attributes (bool, optional):
+                True if XML attributes should be included in the dictionary. Defaults to False.
 
         Returns:
             dict:
@@ -80,20 +84,47 @@ class XML:
                     Dictionary representing the XML element
 
             """
+
             tag = cls.remove_xml_namespace(element.tag)
             children = list(element)
+            node_dict = {}
+
+            if element.attrib and include_attributes:
+                node_dict.update({"@{}".format(k): v for k, v in element.attrib.items()})
+
             if children:
-                return {
-                    tag: {
-                        cls.remove_xml_namespace(child.tag): xml_element_to_dict(child)[
-                            cls.remove_xml_namespace(child.tag)
-                        ]
-                        for child in children
-                    }
-                }
+                child_dict = {}
+                for child in children:
+                    child_tag = cls.remove_xml_namespace(child.tag)
+                    child_value = xml_element_to_dict(child)
+
+                    # child_dict is {child_tag: ...}, we want the value inside
+                    value = child_value[child_tag]
+
+                    # Handle multiple occurrences of the same tag:
+                    if child_tag in child_dict:
+                        # If the tag already exists, ensure it becomes a list
+                        if not isinstance(child_dict[child_tag], list):
+                            child_dict[child_tag] = [child_dict[child_tag]]
+                        child_dict[child_tag].append(value)
+                    else:
+                        child_dict[child_tag] = value
+
+                # Merge children into node_dict
+                node_dict.update(child_dict)
+
+            # Add text if present and meaningful
+            text = element.text.strip() if element.text and element.text.strip() else None
+            if text:
+                if node_dict:
+                    node_dict["#text"] = text
+                else:
+                    return {tag: text}
 
-            return {tag: element.text.strip() if element.text else None}
+            return {tag: node_dict if node_dict else text}
 
+        if encode:
+            xml_string = xml_string.encode("utf-8")
         root = etree.fromstring(xml_string)
 
         return xml_element_to_dict(root)

pyxecm/otac.py

@@ -43,7 +43,7 @@ REQUEST_JSON_HEADERS = {
     "Content-Type": "application/json",
 }
 
-REQUEST_TIMEOUT = 60
+REQUEST_TIMEOUT = 60.0
 
 default_logger = logging.getLogger(MODULE_NAME)
 

pyxecm/otawp.py

@@ -53,10 +53,10 @@ REQUEST_HEADERS_JSON = {
     "accept": "application/json",
 }
 
-REQUEST_TIMEOUT = 120
+REQUEST_TIMEOUT = 120.0
 REQUEST_MAX_RETRIES = 10
-REQUEST_RETRY_DELAY = 30
-SYNC_PUBLISH_REQUEST_TIMEOUT = 600
+REQUEST_RETRY_DELAY = 30.0
+SYNC_PUBLISH_REQUEST_TIMEOUT = 600.0
 
 default_logger = logging.getLogger(MODULE_NAME)
 
@@ -332,13 +332,13 @@ class OTAWP:
                 The hostname of Extended ECM server to communicate with.
             port (int):
                 The port number used to talk to the Extended ECM server.
-            username (str, optional):
+            username (str | None, optional):
                 The admin user name of OTAWP. Optional if otawp_ticket is provided.
-            password (str, optional):
+            password (str | None, optional):
                 The admin password of OTAWP. Optional if otawp_ticket is provided.
-            organization (str, optional):
+            organization (str | None, optional):
                 The AppWorks organization. Used in LDAP strings and base URL.
-            otawp_ticket (str, optional):
+            otawp_ticket (str | None, optional):
                 The authentication ticket of OTAWP.
             config_map_name (str | None, optional):
                 The AppWorks Kubernetes Config Map name. Defaults to None.
@@ -805,8 +805,8 @@ class OTAWP:
                 The key to find.
 
         Returns:
-            str:
-                The value for the key.
+            str | None:
+                The value for the key. None in case of an error.
 
         """
 
@@ -859,7 +859,7 @@ class OTAWP:
         data: dict | None = None,
         json_data: dict | None = None,
         files: dict | None = None,
-        timeout: int | None = REQUEST_TIMEOUT,
+        timeout: float | None = REQUEST_TIMEOUT,
         show_error: bool = True,
         show_warning: bool = False,
         warning_message: str = "",
@@ -886,7 +886,7 @@ class OTAWP:
             files (dict | None, optional):
                 Dictionary of {"name": file-tuple} for multipart encoding upload.
                 The file-tuple can be a 2-tuple ("filename", fileobj) or a 3-tuple ("filename", fileobj, "content_type")
-            timeout (int | None, optional):
+            timeout (float | None, optional):
                 Timeout for the request in seconds. Defaults to REQUEST_TIMEOUT.
             show_error (bool, optional):
                 Whether or not an error should be logged in case of a failed REST call.
@@ -995,9 +995,9 @@ class OTAWP:
         Args:
             response_object (object):
                 This is reponse object delivered by the request call.
-            additional_error_message (str):
+            additional_error_message (str, optional):
                 Print a custom error message.
-            show_error (bool):
+            show_error (bool, optional):
                 If True log an error, if False log a warning.
 
         Returns:
@@ -1111,7 +1111,7 @@ class OTAWP:
                 Whether an error or just a warning should be logged.
 
         Returns:
-            str | None:
+            str | int | None:
                 Value of the item with the given key, or None if no value is found.
 
         """
@@ -1982,7 +1982,7 @@ class OTAWP:
                 The trading name.
 
         Returns:
-            dict:
+            dict | None:
                 Request response (dictionary) or None if the REST call fails.
 
         """
@@ -2310,7 +2310,7 @@ class OTAWP:
             cookies=self.cookie(),
             json_data=create_category_data,
             timeout=REQUEST_TIMEOUT,
-            failure_message="Request to create category -> '{}' failed".format(name),
+            failure_message="Failed to create category -> '{}'".format(name),
         )
 
     # end method definition
@@ -2375,7 +2375,7 @@ class OTAWP:
             headers=REQUEST_HEADERS_JSON,
             cookies=self.cookie(),
             timeout=REQUEST_TIMEOUT,
-            failure_message="Request to get categories failed",
+            failure_message="Failed to get categories",
         )
 
     # end method definition
@@ -2480,7 +2480,7 @@ class OTAWP:
             cookies=self.cookie(),
             json_data=create_sub_category_data,
             timeout=REQUEST_TIMEOUT,
-            failure_message="Request to create sub-category -> '{}' with parent category ID -> {} failed".format(
+            failure_message="Failed to create sub-category -> '{}' with parent category ID -> {}".format(
                 name, parent_id
             ),
         )
@@ -2541,7 +2541,7 @@ class OTAWP:
             headers=REQUEST_HEADERS_JSON,
             cookies=self.cookie(),
             timeout=REQUEST_TIMEOUT,
-            failure_message="Request to get sub-categories for parent category with ID -> {} failed".format(parent_id),
+            failure_message="Failed to get sub-categories for parent category with ID -> {}".format(parent_id),
         )
 
     # end method definition