edq-utils 0.1.3__tar.gz → 0.1.5__tar.gz

{edq_utils-0.1.3 → edq_utils-0.1.5}/PKG-INFO

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

{edq_utils-0.1.3 → edq_utils-0.1.5}/edq/__init__.py

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

{edq_utils-0.1.3 → edq_utils-0.1.5}/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.3 → edq_utils-0.1.5}/edq/util/net.py

@@ -626,6 +626,22 @@ class HTTPExchange(edq.util.json.DictConverter):
 
         return HTTPExchange(**data)
 
+@typing.runtime_checkable
+class HTTPExchangeComplete(typing.Protocol):
+    """
+    A function that can be called after a request has been made (and exchange constructed).
+    """
+
+    def __call__(self,
+            exchange: HTTPExchange
+            ) -> str:
+        """
+        Called after an HTTP exchange has been completed.
+        """
+
+_make_request_exchange_complete_func: typing.Union[HTTPExchangeComplete, None] = None  # pylint: disable=invalid-name
+""" If not None, call this func after make_request() has created its HTTPExchange. """
+
 def find_open_port(
         start_port: int = DEFAULT_START_PORT, end_port: int = DEFAULT_END_PORT,
         wait_time: float = DEFAULT_PORT_SEARCH_WAIT_SEC) -> int:
@@ -671,6 +687,7 @@ def make_request(method: str, url: str,
         http_exchange_extension: str = DEFAULT_HTTP_EXCHANGE_EXTENSION,
         add_http_prefix: bool = True,
         additional_requests_options: typing.Union[typing.Dict[str, typing.Any], None] = None,
+        exchange_complete_func: typing.Union[HTTPExchangeComplete, None] = None,
         **kwargs: typing.Any) -> typing.Tuple[requests.Response, str]:
     """
     Make an HTTP request and return the response object and text body.
@@ -713,7 +730,7 @@ def make_request(method: str, url: str,
     else:
         options['data'] = data
 
-    logging.debug("Making %s request: '%s'.", method, url)
+    logging.debug("Making %s request: '%s' (options = %s).", method, url, options)
     response = requests.request(method, url, **options)
 
     body = response.text
@@ -726,9 +743,11 @@ def make_request(method: str, url: str,
 
         response.raise_for_status()
 
-    if (output_dir is not None):
+    exchange = None
+    if ((output_dir is not None) or (exchange_complete_func is not None) or (_make_request_exchange_complete_func is not None)):
         exchange = HTTPExchange.from_response(response, headers_to_skip = headers_to_skip, params_to_skip = params_to_skip)
 
+    if ((output_dir is not None) and (exchange is not None)):
         path = os.path.abspath(os.path.join(output_dir, *exchange.get_url().split('/')))
 
         query = urllib.parse.urlencode(exchange.parameters)
@@ -744,6 +763,12 @@ def make_request(method: str, url: str,
         edq.util.dirent.mkdir(os.path.dirname(path))
         edq.util.json.dump_path(exchange, path, indent = 4, sort_keys = False)
 
+    if ((exchange_complete_func is not None) and (exchange is not None)):
+        exchange_complete_func(exchange)
+
+    if ((_make_request_exchange_complete_func is not None) and (exchange is not None)):
+        _make_request_exchange_complete_func(exchange)  # pylint: disable=not-callable
+
     return response, body
 
 def make_get(url: str, **kwargs: typing.Any) -> typing.Tuple[requests.Response, str]:

edq_utils-0.1.5/edq/util/parse.py

@@ -0,0 +1,33 @@
+import typing
+
+BOOL_TRUE_STRINGS: typing.Set[str] = {
+    'true', 't',
+    'yes', 'y',
+    '1',
+}
+
+BOOL_FALSE_STRINGS: typing.Set[str] = {
+    'false', 'f',
+    'no', 'n',
+    '0',
+}
+
+def boolean(raw_text: typing.Union[str, bool]) -> bool:
+    """
+    Parse a boolean from a string using common string representations for true/false.
+    This function assumes the entire string is the boolean (not just a part of it).
+    If the string is not true or false, then raise an exception.
+    """
+
+    if (isinstance(raw_text, bool)):
+        return raw_text
+
+    text = str(raw_text).lower().strip()
+
+    if (text in BOOL_TRUE_STRINGS):
+        return True
+
+    if (text in BOOL_FALSE_STRINGS):
+        return False
+
+    raise ValueError(f"Could not convert text to boolean: '{raw_text}'.")

{edq_utils-0.1.3 → edq_utils-0.1.5}/edq_utils.egg-info/PKG-INFO

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

{edq_utils-0.1.3 → edq_utils-0.1.5}/edq_utils.egg-info/SOURCES.txt

@@ -78,6 +78,7 @@ edq/util/hash_test.py
 edq/util/json.py
 edq/util/json_test.py
 edq/util/net.py
+edq/util/parse.py
 edq/util/pyimport.py
 edq/util/pyimport_test.py
 edq/util/reflection.py