pyxecm 1.4__py3-none-any.whl → 1.6__py3-none-any.whl

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

@@ -73,11 +73,31 @@ class Assoc:
 
     @classmethod
     def is_html_escaped(cls, assoc_string: str) -> bool:
+        """Class method to check if an Extended ECM Assoc String
+           is HTML escaped.
+
+        Args:
+            assoc_string (str): the string to test for HTML escaping
+
+        Returns:
+            bool: True = string is HTML escaped, False if now
+        """
+
         decoded_string = html.unescape(assoc_string)
+
         return assoc_string != decoded_string
 
     @classmethod
     def unescape_html(cls, assoc_string: str) -> str:
+        """HTML unescape a a string
+
+        Args:
+            assoc_string (str): the string to unescape.
+
+        Returns:
+            str: unescaped string
+        """
+
         decoded_string = html.unescape(assoc_string)
         return decoded_string
 
@@ -165,7 +185,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
@@ -179,6 +211,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: