edq-utils 0.1.2__tar.gz → 0.1.4__tar.gz

{edq_utils-0.1.2 → edq_utils-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edq-utils
-Version: 0.1.2
+Version: 0.1.4
 Summary: Common utilities used by EduLinq Python projects.
 Author-email: Eriq Augustine <eriq@edulinq.org>
 License: MIT License

{edq_utils-0.1.2 → edq_utils-0.1.4}/edq/__init__.py

@@ -2,4 +2,4 @@
 General Python tools used by several EduLinq projects.
 """
 
-__version__ = '0.1.2'
+__version__ = '0.1.4'

{edq_utils-0.1.2 → edq_utils-0.1.4}/edq/testing/cli.py

@@ -214,6 +214,22 @@ class CLITestInfo:
 
         return CLITestInfo(test_name, base_dir, data_dir, temp_dir, **options)
 
+@typing.runtime_checkable
+class TestMethodWrapperFunction(typing.Protocol):
+    """
+    A function that can be used to wrap/modify a CLI test method before it is attached to the test class.
+    """
+
+    def __call__(self,
+            test_method: typing.Callable,
+            test_info_path: str,
+            ) -> typing.Callable:
+        """
+        Wrap and/or modify the CLI test method before it is attached to the test class.
+        See _get_test_method() for the input method.
+        The returned method will be used in-place of the input one.
+        """
+
 def read_test_file(path: str) -> typing.Tuple[typing.Dict[str, typing.Any], str]:
     """ Read a test case file and split the output into JSON data and text. """
 
@@ -257,7 +273,9 @@ def replace_path_pattern(text: str, key: str, target_dir: str) -> str:
 def _get_test_method(test_name: str, path: str, data_dir: str) -> typing.Callable:
     """ Get a test method that represents the test case at the given path. """
 
-    def __method(self: edq.testing.unittest.BaseTest) -> None:
+    def __method(self: edq.testing.unittest.BaseTest,
+            reraise_exception_types: typing.Union[typing.Tuple[typing.Type], None] = None,
+            **kwargs: typing.Any) -> None:
         test_info = CLITestInfo.load_path(path, test_name, getattr(self, BASE_TEMP_DIR_ATTR), data_dir)
 
         # Allow the test class a chance to modify the test info before the test runs.
@@ -281,6 +299,9 @@ def _get_test_method(test_name: str, path: str, data_dir: str) -> typing.Callabl
             if (test_info.error):
                 self.fail(f"No error was not raised when one was expected ('{str(test_info.expected_stdout)}').")
         except BaseException as ex:
+            if ((reraise_exception_types is not None) and isinstance(ex, reraise_exception_types)):
+                raise ex
+
             if (not test_info.error):
                 raise ex
 
@@ -306,7 +327,8 @@ def _get_test_method(test_name: str, path: str, data_dir: str) -> typing.Callabl
 
     return __method
 
-def add_test_paths(target_class: type, data_dir: str, paths: typing.List[str]) -> None:
+def add_test_paths(target_class: type, data_dir: str, paths: typing.List[str],
+        test_method_wrapper: typing.Union[TestMethodWrapperFunction, None] = None) -> None:
     """ Add tests from the given test files. """
 
     # Attach a temp directory to the testing class so all tests can share a common base temp dir.
@@ -321,12 +343,18 @@ def add_test_paths(target_class: type, data_dir: str, paths: typing.List[str]) -
         test_name = 'test_cli__' + basename
 
         try:
-            setattr(target_class, test_name, _get_test_method(test_name, path, data_dir))
+            test_method = _get_test_method(test_name, path, data_dir)
         except Exception as ex:
             raise ValueError(f"Failed to parse test case '{path}'.") from ex
 
-def discover_test_cases(target_class: type, test_cases_dir: str, data_dir: str) -> None:
+        if (test_method_wrapper is not None):
+            test_method = test_method_wrapper(test_method, path)
+
+        setattr(target_class, test_name, test_method)
+
+def discover_test_cases(target_class: type, test_cases_dir: str, data_dir: str,
+        test_method_wrapper: typing.Union[TestMethodWrapperFunction, None] = None) -> None:
     """ Look in the text cases directory for any test cases and add them as test methods to the test class. """
 
     paths = list(sorted(glob.glob(os.path.join(test_cases_dir, "**", "*.txt"), recursive = True)))
-    add_test_paths(target_class, data_dir, paths)
+    add_test_paths(target_class, data_dir, paths, test_method_wrapper = test_method_wrapper)

edq_utils-0.1.4/edq/util/hash.py

@@ -0,0 +1,38 @@
+import hashlib
+import typing
+
+import edq.util.dirent
+
+DEFAULT_CLIP_HASH_LENGTH: int = 8
+
+def sha256_hex(payload: typing.Any, encoding: str = edq.util.dirent.DEFAULT_ENCODING) -> str:
+    """ Compute and return the hex string of the SHA3-256 encoding of the payload. """
+
+    digest = hashlib.new('sha256')
+    digest.update(payload.encode(encoding))
+    return digest.hexdigest()
+
+def clip_text(text: str, max_length: int, hash_length: int = DEFAULT_CLIP_HASH_LENGTH) -> str:
+    """
+    Return a clipped version of the input text that is no longer than the specified length.
+    If the base text is found to be too long,
+    then enough if the tail of the text will be removed to insert a note about the clipping
+    and the first |hash_length| characters of the hash from sha256_hex().
+
+    Note that the max length is actually a soft cap.
+    Longer strings can be generated if the original text is shorter than the notification
+    that will be inserted into the clipped text.
+    """
+
+    if (len(text) <= max_length):
+        return text
+
+    hash_hex = sha256_hex(text)
+    notification = f"[text clipped {hash_hex[0:hash_length]}]"
+
+    # Don't clip the text if the final string would be longer.
+    if (len(notification) >= len(text)):
+        return text
+
+    keep_length = max(0, max_length - len(notification))
+    return text[0:keep_length] + notification

edq_utils-0.1.4/edq/util/hash_test.py

@@ -0,0 +1,89 @@
+import edq.testing.unittest
+import edq.util.hash
+
+class TestHash(edq.testing.unittest.BaseTest):
+    """ Test hash-based operations. """
+
+    def test_sha256_hex_base(self):
+        """ Test the base sha256 hash. """
+
+        # [(input, expected), ...]
+        test_cases = [
+            ('foo', '2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae'),
+            ('abcdefghijklmnopqrstuvwxyz1234567890', '77d721c817f9d216c1fb783bcad9cdc20aaa2427402683f1f75dd6dfbe657470'),
+            ('', 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'),
+        ]
+
+        for (i, test_case) in enumerate(test_cases):
+            (text, expected) = test_case
+
+            with self.subTest(msg = f"Case {i} ('{text}'):"):
+                actual = edq.util.hash.sha256_hex(text)
+                self.assertEqual(expected, actual)
+
+    def test_clip_text_base(self):
+        """ Test the base functionality of clip_text(). """
+
+        # [(text, max length, kwargs, expected), ...]
+        test_cases = [
+            # No Clip
+            (
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+                100,
+                {},
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+            ),
+
+            # Base Clip
+            (
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+                30,
+                {},
+                'abcdefg[text clipped 77d721c8]',
+            ),
+
+            # Full Clip
+            (
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+                23,
+                {},
+                '[text clipped 77d721c8]',
+            ),
+
+            # Over Clip
+            (
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+                10,
+                {},
+                '[text clipped 77d721c8]',
+            ),
+
+            # Different Hash Length
+            (
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+                30,
+                {'hash_length': 10},
+                'abcde[text clipped 77d721c817]',
+            ),
+
+            # Notification Longer Than Text
+            (
+                'abc',
+                1,
+                {},
+                'abc',
+            ),
+            (
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+                10,
+                {'hash_length': 64},
+                'abcdefghijklmnopqrstuvwxyz1234567890',
+            ),
+        ]
+
+        for (i, test_case) in enumerate(test_cases):
+            (text, max_length, kwargs, expected) = test_case
+
+            with self.subTest(msg = f"Case {i} ('{text}'):"):
+                actual = edq.util.hash.clip_text(text, max_length, **kwargs)
+                self.assertEqual(expected, actual)

{edq_utils-0.1.2 → edq_utils-0.1.4}/edq/util/net.py

@@ -19,6 +19,7 @@ import requests
 import requests_toolbelt.multipart.decoder
 
 import edq.util.dirent
+import edq.util.hash
 import edq.util.json
 import edq.util.pyimport
 
@@ -30,6 +31,9 @@ DEFAULT_REQUEST_TIMEOUT_SECS: float = 10.0
 
 DEFAULT_HTTP_EXCHANGE_EXTENSION: str= '.httpex.json'
 
+QUERY_CLIP_LENGTH: int = 100
+""" If the query portion of an HTTPExhange being saved is longer than this, then clip the name. """
+
 ANCHOR_HEADER_KEY: str = 'edq-anchor'
 """
 By default, requests made via make_request() will send a header with this key that includes the anchor component of the URL.
@@ -729,8 +733,11 @@ def make_request(method: str, url: str,
 
         query = urllib.parse.urlencode(exchange.parameters)
         if (query != ''):
+            # The query can get very long, so we may have to clip it.
+            query_text = edq.util.hash.clip_text(query, QUERY_CLIP_LENGTH)
+
             # Note that the '?' is URL encoded.
-            path += f"%3F{query}"
+            path += f"%3F{query_text}"
 
         path += f"_{method}{http_exchange_extension}"
 

{edq_utils-0.1.2 → edq_utils-0.1.4}/edq_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edq-utils
-Version: 0.1.2
+Version: 0.1.4
 Summary: Common utilities used by EduLinq Python projects.
 Author-email: Eriq Augustine <eriq@edulinq.org>
 License: MIT License

{edq_utils-0.1.2 → edq_utils-0.1.4}/edq_utils.egg-info/SOURCES.txt

@@ -73,6 +73,8 @@ edq/testing/testdata/http/files/tiny.png
 edq/util/__init__.py
 edq/util/dirent.py
 edq/util/dirent_test.py
+edq/util/hash.py
+edq/util/hash_test.py
 edq/util/json.py
 edq/util/json_test.py
 edq/util/net.py