edq-utils 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

edq/__init__.py

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

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]:
@@ -862,13 +887,14 @@ def parse_content_dispositions(headers: typing.Union[email.message.Message, typi
 
 def parse_query_string(text: str,
         replace_single_lists: bool = True,
-        ) -> typing.Dict[str, typing.Any]:
+        keep_blank_values: bool = True,
+        **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
     """
     Parse a query string (like urllib.parse.parse_qs()), and normalize the result.
     If specified, lists with single values (as returned from urllib.parse.parse_qs()) will be replaced with the single value.
     """
 
-    results = urllib.parse.parse_qs(text)
+    results = urllib.parse.parse_qs(text, keep_blank_values = True)
     for (key, value) in results.items():
         if (replace_single_lists and (len(value) == 1)):
             results[key] = value[0]  # type: ignore[assignment]

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.4.dist-info → edq_utils-0.1.6.dist-info}/METADATA

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

{edq_utils-0.1.4.dist-info → edq_utils-0.1.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-edq/__init__.py,sha256=ree5ufpagQ7Rc8mHF4u_O4s_xXLJIXNPv8KTxEZhWww,86
+edq/__init__.py,sha256=zzlJP1062nfEQu7AZNJwQURNoVHqDTUn7JuBdLU9Y4M,86
 edq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 edq/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 edq/cli/version.py,sha256=SxarRVD_AVA-nD4pLVMe6ZjSJpMr7h_r3DgYYs42vjE,591
@@ -68,14 +68,15 @@ edq/util/hash.py,sha256=yjXGBCZNvMm49RaPCi9Ygf5FLUpGUrbVU7v8l8hn5Hc,1369
 edq/util/hash_test.py,sha256=GzvCwgPdzsOn5o63lE8cUurAnj-4arHnYCUcctTnWMQ,2714
 edq/util/json.py,sha256=nl_cxrlP97RX1BFtys8IT_3IfO0-XvBDQBe6YdrblB4,5936
 edq/util/json_test.py,sha256=utUVRbw3z42ke4fpRVI294RrFHcMKms8khVYRkISNk4,8009
-edq/util/net.py,sha256=UNaFNEyVFxITATHS4-2IcFPkW29WDiIm22fiN7-wUOs,33403
+edq/util/net.py,sha256=rrm7ZmtvMMtvIpQmxRLOg6OUtrWXBlyCmLpI1RyjuMM,34613
+edq/util/parse.py,sha256=zA-GGbY5WF-rfAcWFlnYjDXQaNkxhoyLJ8X81UceCLw,786
 edq/util/pyimport.py,sha256=26OIuCXELyqtwlooMqDEs4GJQrkrAgxnXNYTlqqtsBY,2852
 edq/util/pyimport_test.py,sha256=Xno0MIa3yMTfBfoTgjKCIMpr1ZShU6bvo9rBRdecXQU,4202
 edq/util/reflection.py,sha256=jPcW6h0fwSDYh04O5rUxlgoF7HK6fVQ2mq7DD9qPrEg,972
 edq/util/time.py,sha256=anoNM_KniARLombv2BnsoHuCzDqMKiDdIzV7RUe2ZOk,2648
 edq/util/time_test.py,sha256=iQZwzVTVQQ4TdXrLb9MUMCYlKrIe8qyF-hiC9YLTaMo,4610
-edq_utils-0.1.4.dist-info/licenses/LICENSE,sha256=MS4iYEl4rOxMoprZuc86iYVoyk4YgaVoMt7WmGvVF8w,1064
-edq_utils-0.1.4.dist-info/METADATA,sha256=XlmW8vEdFxmnAUURP0LDyHRAEAH8YYN1dkQ4QJ3NhbM,7535
-edq_utils-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-edq_utils-0.1.4.dist-info/top_level.txt,sha256=znBHSj6tgXtcMKrUVtovLli5fIEJCb7d-BMxTLRK4zk,4
-edq_utils-0.1.4.dist-info/RECORD,,
+edq_utils-0.1.6.dist-info/licenses/LICENSE,sha256=MS4iYEl4rOxMoprZuc86iYVoyk4YgaVoMt7WmGvVF8w,1064
+edq_utils-0.1.6.dist-info/METADATA,sha256=HD5uwUBWkF0QuE8DO7iuxTVdviSOPyrm-yc_AipERWA,7535
+edq_utils-0.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+edq_utils-0.1.6.dist-info/top_level.txt,sha256=znBHSj6tgXtcMKrUVtovLli5fIEJCb7d-BMxTLRK4zk,4
+edq_utils-0.1.6.dist-info/RECORD,,