pyxecm 1.3.0__py3-none-any.whl → 1.5__py3-none-any.whl

pyxecm/customizer/translate.py

@@ -12,7 +12,7 @@ translateV3: Translate a string from one language to another using the Google Tr
 """
 
 __author__ = "Dr. Marc Diefenbruch"
-__copyright__ = "Copyright 2023, OpenText"
+__copyright__ = "Copyright 2024, OpenText"
 __credits__ = ["Kai-Philip Gatzweiler"]
 __maintainer__ = "Dr. Marc Diefenbruch"
 __email__ = "mdiefenb@opentext.com"
@@ -25,7 +25,7 @@ logger = logging.getLogger("pyxecm.customizer.translate")
 
 class Translator:
     """Class for translation of of strings based on the Google Translate API.
-       The class supports V2 and V3 translation APIs
+    The class supports V2 and V3 translation APIs
     """
 
     _config = None

pyxecm/helper/__init__.py

@@ -1,4 +1,6 @@
 """pyxecm helper classes, not for direct use"""
+
 from .assoc import Assoc
 from .web import HTTP
 from .xml import XML
+from .data import Data

pyxecm/helper/assoc.py

@@ -12,7 +12,7 @@ dictToString: converting an Assoc dict to an Assoc string
 """
 
 __author__ = "Dr. Marc Diefenbruch"
-__copyright__ = "Copyright 2023, OpenText"
+__copyright__ = "Copyright 2024, OpenText"
 __credits__ = ["Kai-Philip Gatzweiler"]
 __maintainer__ = "Dr. Marc Diefenbruch"
 __email__ = "mdiefenb@opentext.com"
@@ -22,8 +22,7 @@ import html
 
 
 class Assoc:
-    """Class to handle Extended ECM Assoc data structures.
-    """
+    """Class to handle Extended ECM Assoc data structures."""
 
     @classmethod
     def is_unicode_escaped(cls, assoc_string: str) -> bool:
@@ -41,7 +40,6 @@ class Assoc:
 
         return len(matches) > 0
 
-
     @classmethod
     def escape_unicode(cls, assoc_string: str) -> str:
         """Escape / Encode a given string in Unicode
@@ -53,11 +51,10 @@ class Assoc:
             str: Escaped string
         """
 
-        encoded_string = assoc_string.encode('unicode_escape') # .decode()
+        encoded_string = assoc_string.encode("unicode_escape")  # .decode()
 
         return encoded_string
 
-
     @classmethod
     def unescape_unicode(cls, assoc_string: str) -> str:
         """Unescape / Decode a given string
@@ -168,7 +165,19 @@ class Assoc:
     @classmethod
     def extract_substring(
         cls, input_string: str, start_sequence: str, stop_sequence: str
-    ):
+    ) -> str | None:
+        """A generic method to extract a substring that is delimited
+           by a strart and stop sequence.
+
+        Args:
+            input_string (str): Input string to search the delimited substring in.
+            start_sequence (str): Start esequence of characters.
+            stop_sequence (str): Stopß sequence of characters
+
+        Returns:
+            str | None: the deliminated substring or None if not found.
+        """
+
         start_index = input_string.find(start_sequence)
         if start_index == -1:
             return None
@@ -182,6 +191,17 @@ class Assoc:
 
     @classmethod
     def extract_assoc_string(cls, input_string: str, is_escaped: bool = False) -> str:
+        """Extract an Assoc from a string. The assoc is deliminated by A< ... >.
+
+        Args:
+            input_string (str): Input string that includes the Assoc as a substring.
+            is_escaped (bool, optional): Whether or not the input string includes the
+                                         assoc escaped or not.
+
+        Returns:
+            str: the assoc string
+        """
+
         if is_escaped:
             assoc_string = cls.extract_substring(input_string, "A&lt;", "&gt;")
         else: