ae-base 0.3.70__tar.gz → 0.3.72__tar.gz

{ae_base-0.3.70/ae_base.egg-info → ae_base-0.3.72}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.70
+Version: 0.3.72
 Summary: ae namespace module portion base: basic constants, helper functions and context managers
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -65,13 +65,13 @@ Dynamic: summary
 
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.97 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.19 -->
-# base 0.3.70
+# base 0.3.72
 
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_base/develop?logo=python)](
     https://gitlab.com/ae-group/ae_base)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.70?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.70)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.72?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.72)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 

{ae_base-0.3.70 → ae_base-0.3.72}/README.md

@@ -1,12 +1,12 @@
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.97 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.19 -->
-# base 0.3.70
+# base 0.3.72
 
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_base/develop?logo=python)](
     https://gitlab.com/ae-group/ae_base)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.70?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.70)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.72?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.72)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 

{ae_base-0.3.70 → ae_base-0.3.72}/ae/base.py

@@ -246,7 +246,7 @@ from types import ModuleType
 from typing import Any, Callable, Generator, Iterable, MutableMapping, Optional, Union, cast
 
 
-__version__ = '0.3.70'
+__version__ = '0.3.72'
 
 
 os_path_abspath = os.path.abspath
@@ -1048,8 +1048,17 @@ def parse_dotenv(file_path: str) -> dict[str, str]:
     :param file_path:           string with the name/path of an existing ``.env``/:data:`DOTENV_FILE_NAME` file.
     :return:                    dict with environment variable names and values
     """
-    env_vars: dict[str, str] = {}
+    lines = []          # unwrap multi-line .env variable values with backslash at line end (Docker/UNIX-style format)
+    prev_lines = ""
     for line in cast(str, read_file(file_path)).splitlines():
+        if line.endswith('\\'):
+            prev_lines += line[:-1]
+            continue
+        lines.append(prev_lines + line)
+        prev_lines = ""
+
+    env_vars: dict[str, str] = {}
+    for line in lines:
         match = _env_line.search(line)
         if not match:
             if not re.search(r'^\s*(?:#.*)?$', line):  # not comment or blank
@@ -1362,17 +1371,20 @@ def url_failure(url: str, token: str = "", username: str = "", password: str = "
         return f"{exception.code} {mask_url(url)} raised HTTPError {exception.reason=}"
 
     except URLError as exception:
-        err_prefix = f"996 {mask_url(url)} raised {exception.errno=} {exception.reason=};"
+        err_msg = f" {mask_url(url)} raised {exception.errno=} {exception.reason=};"
         if isinstance(exception.reason, socket.gaierror):
-            return f"{err_prefix} could not resolve hostname"
-        if isinstance(exception.reason, socket.timeout):
-            return f"{err_prefix} connection timed out after {timeout} seconds"
+            return '995' + f"{err_msg} could not resolve hostname"
         if isinstance(exception.reason, ssl.SSLCertVerificationError):
-            return f"{err_prefix} SSL certificate verification failed"
-        return f"{err_prefix} could not reach the server"
+            return '996' + f"{err_msg} SSL certificate verification failed"
+        if isinstance(exception.reason, socket.timeout):
+            return '997' + f"{err_msg} connection timed out after {timeout} seconds"
+        return '998' + f"{err_msg} could not reach the server"
+
+    except socket.timeout as _exception:    # noqa: F841 # str(_exception) could contain password|token
+        return '997' + f" {mask_url(url)} raised socket-timeout exception after {timeout} seconds"
 
-    except Exception:                                               # pylint: disable=broad-exception-caught
-        return f"999 {mask_url(url)} raised unexpected exception"   # NOT put str(_exception) because contains password
+    except Exception as _exception:         # noqa: F841 # pylint: disable=broad-exception-caught
+        return '999' + f" {mask_url(url)} raised unexpected exception"   # str(_exception) COULD contain password
 
 
 def utc_datetime() -> datetime.datetime:

{ae_base-0.3.70 → ae_base-0.3.72/ae_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.70
+Version: 0.3.72
 Summary: ae namespace module portion base: basic constants, helper functions and context managers
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -65,13 +65,13 @@ Dynamic: summary
 
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.97 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.19 -->
-# base 0.3.70
+# base 0.3.72
 
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_base/develop?logo=python)](
     https://gitlab.com/ae-group/ae_base)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.70?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.70)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.72?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.72)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 

{ae_base-0.3.70 → ae_base-0.3.72}/setup.py

@@ -25,13 +25,13 @@ setup_kwargs = {
     'license': 'GPL-3.0-or-later',
     'long_description': ('<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.97 -->\n'
  '<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.19 -->\n'
- '# base 0.3.70\n'
+ '# base 0.3.72\n'
  '\n'
  '[![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_base/develop?logo=python)](\n'
  '    https://gitlab.com/ae-group/ae_base)\n'
  '[![LatestPyPIrelease](\n'
- '    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.70?logo=python)](\n'
- '    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.70)\n'
+ '    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.72?logo=python)](\n'
+ '    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.72)\n'
  '[![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](\n'
  '    https://pypi.org/project/ae-base/#history)\n'
  '\n'
@@ -108,7 +108,7 @@ setup_kwargs = {
         'Source': 'https://ae.readthedocs.io/en/latest/_modules/ae/base.html'},
     'python_requires': '>=3.9',
     'url': 'https://gitlab.com/ae-group/ae_base',
-    'version': '0.3.70',
+    'version': '0.3.72',
     'zip_safe': True,
 }
 

{ae_base-0.3.70 → ae_base-0.3.72}/tests/test_base.py

@@ -1,9 +1,6 @@
 """ ae.base unit tests """
 import datetime
 import os
-import time
-
-import pytest
 import shutil
 import socket
 import ssl
@@ -11,16 +8,20 @@ import string
 import sys
 import tempfile
 import textwrap
+import time
+import timeit
 
 from collections import OrderedDict
 from configparser import ConfigParser
 # noinspection PyProtectedMember
 from http.client import HTTPMessage
 from types import ModuleType
-from typing import cast, Any
+from typing import cast, Any, Optional
 from unittest.mock import patch
 from urllib.error import HTTPError, URLError
 
+import pytest
+
 # noinspection PyProtectedMember
 from ae.base import (
     ASCII_TO_UNICODE, ASCII_UNICODE, BUILD_CONFIG_FILE, DOTENV_FILE_NAME, PY_EXT, PY_INIT, PY_MAIN, TESTS_FOLDER,
@@ -69,15 +70,32 @@ def os_env_test_env():
 module_test_var = 'module_test_var_val'   # used for stack_var()/try_exec() tests
 
 
-def test_unset_truthiness():
+def test_unset_truthiness_and_null_length():
     assert not UNSET
     assert bool(UNSET) is False
 
-
-def test_unset_null_length():
     assert len(UNSET) == 0
 
 
+def test_proof_os_path_shortcuts_performance_win():
+    att_call_setup = textwrap.dedent("""
+    import os
+    path1, path2, path3 = "folder1", "folder2", "file.tst"
+    """)
+    sho_call_setup = att_call_setup + textwrap.dedent("""
+    os_path_join = os.path.join
+    """)
+
+    att_call_code = "os.path.join(path1, path2, path3)"
+    sho_call_code = "os_path_join(path1, path2, path3)"
+
+    time_att = timeit.timeit(att_call_code, setup=att_call_setup, number=3_000_000)
+    time_sho = timeit.timeit(sho_call_code, setup=sho_call_setup, number=3_000_000)
+
+    assert time_sho < time_att
+    print(f"\n¡!¡!¡! os_path_* shortcuts are ~{((time_att - time_sho) / time_att) * 100:.2f}% faster")
+
+
 class TestErrorMsgMixin:
     def test_instantiation(self):
         ins = ErrorMsgMixin()
@@ -828,6 +846,24 @@ class TestBaseHelpers:
             loaded = parse_dotenv(fp.name)
             assert 'var_nam' not in loaded      # added warning
 
+    def test_parse_dotenv_literal_dict_with_list(self):
+        with tempfile.NamedTemporaryFile(mode="w") as fp:
+            var_val = "{'key': {'sub-key': ['list-item', 'list-item with = char', ]}}"
+            fp.write("var_nam=" + var_val)
+            fp.seek(0)
+            loaded = parse_dotenv(fp.name)
+            assert 'var_nam' in loaded
+            assert loaded['var_nam'] == var_val
+
+    def test_parse_dotenv_multi_line_var_value(self):
+        with tempfile.NamedTemporaryFile(mode="w") as fp:
+            var_val = "{'key': {'sub-key':\\\n    ['list-item',\\\n     'list-item with = char', ]}}"
+            fp.write("var_nam=" + var_val)
+            fp.seek(0)
+            loaded = parse_dotenv(fp.name)
+            assert 'var_nam' in loaded
+            assert loaded['var_nam'] == var_val.replace('\\\n', "")
+
     def test_parse_dotenv_single_in_double_quoted_value(self):
         with tempfile.NamedTemporaryFile(mode="w") as fp:
             fp.write('''var_nam="'var val'"''')
@@ -844,15 +880,6 @@ class TestBaseHelpers:
             assert 'var_nam' in loaded
             assert loaded['var_nam'] == "var val"
 
-    def test_parse_dotenv_literal_dict_with_list(self):
-        with tempfile.NamedTemporaryFile(mode="w") as fp:
-            var_val = "{'key': {'sub-key': ['list-item', 'list-item with = char', ]}}"
-            fp.write("var_nam=" + var_val)
-            fp.seek(0)
-            loaded = parse_dotenv(fp.name)
-            assert 'var_nam' in loaded
-            assert loaded['var_nam'] == var_val
-
     def test_parse_dotenv_literal_dict_with_list_quoted(self):
         with tempfile.NamedTemporaryFile(mode="w") as fp:
             var_val = "{'key': {'sub-key': ['list-item', 'list-item with = char']}}"
@@ -1069,6 +1096,17 @@ class TestBaseHelpers:
         assert to_ascii('ß') == 'ss'
         assert to_ascii('€') == 'Euro'
 
+    @staticmethod
+    def url_failure_httpbin_503_retryer(url: str, timeout: Optional[float] = None) -> tuple[str, str]:
+        retries = 9
+        while True:
+            err_msg = url_failure(url, timeout=timeout)
+            if not err_msg or int(err_msg[:3]) != 503 or retries == 0:
+                break
+            time.sleep(3)
+            retries -= 1
+        return err_msg, f"url_failure({url=}, {timeout=}) httpbin is sometimes unavailable/503. retry later; {err_msg=}"
+
     def test_url_failure(self):
         assert not url_failure("https://gitlab.com/ae-group/ae_base")
 
@@ -1078,14 +1116,8 @@ class TestBaseHelpers:
 
         assert not url_failure("https://www.google.com")
 
-        retries = 9
-        while True:
-            err_msg = url_failure(f"https://httpbin.org/status/200")
-            if not err_msg or retries == 0:
-                break
-            time.sleep(3)
-            retries -= 1
-        assert not err_msg, f"httpbin is sometimes unavailable with error 503 - retry later; {err_msg=}"
+        ret, message = self.url_failure_httpbin_503_retryer("https://httpbin.org/status/200")
+        assert not ret, message
 
     def test_url_failure_authentication_errors(self):
         password, domain, path = "toBeMaskedPassword", "any-not_existing-host_domain.zzz", "any/not/existing/url/path"
@@ -1215,19 +1247,19 @@ class TestBaseHelpers:
         assert int(ret[:3]) > 0
 
     def test_url_failure_timeout_errors(self):
-        ret = url_failure(f"https://httpbin.org/delay/3", timeout=0.9)
+        ret, message = self.url_failure_httpbin_503_retryer("https://httpbin.org/delay/3", timeout=0.9)
 
-        assert ret
-        assert int(ret[:3]) > 0
+        assert ret, message
+        assert ret[:3] == '997', message
 
     def test_url_failure_url_errors(self):
         assert url_failure("")
 
-        ret = url_failure(url2 := f"https://httpbin.org/status/504")
+        ret, message = self.url_failure_httpbin_503_retryer(url2 := "https://httpbin.org/status/504")
 
-        assert ret
-        assert int(ret[:3]) == 504
-        assert ret[4:].startswith(mask_url(url2))
+        assert ret, message
+        assert ret[:3] == '504', message
+        assert ret[4:].startswith(mask_url(url2)), message
 
         with pytest.raises(AttributeError):
             url_failure(cast(str, 123456))