ae-base 0.3.52__tar.gz → 0.3.54__tar.gz

{ae_base-0.3.52/ae_base.egg-info → ae_base-0.3.54}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.52
+Version: 0.3.54
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -69,17 +69,17 @@ Dynamic: summary
 
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.95 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_namespace_root V0.3.14 -->
-# base 0.3.52
+# base 0.3.54
 
 [![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.51?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.51)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.53?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.53)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.52.
+>ae_base module 0.3.54.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.52 → ae_base-0.3.54}/README.md

@@ -1,16 +1,16 @@
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.95 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_namespace_root V0.3.14 -->
-# base 0.3.52
+# base 0.3.54
 
 [![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.51?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.51)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.53?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.53)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.52.
+>ae_base module 0.3.54.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.52 → ae_base-0.3.54}/ae/base.py

@@ -32,6 +32,9 @@ sortable and compact string from a timestamp.
 base helper functions
 ---------------------
 
+in order to convert and transfer Unicode character outside the 7-bit ASCII range via internet transport protocols,
+like http, use the helper functions :func:`ascii_str` and :func:`str_ascii`.
+
 :func:`now_str` creates a timestamp string with the actual UTC date and time. the :func:`utc_datetime` provides the
 actual UTC date and time as datetime object.
 
@@ -155,6 +158,7 @@ import sys
 import unicodedata
 import warnings
 
+from ast import literal_eval
 from configparser import ConfigParser, ExtendedInterpolation
 from contextlib import contextmanager
 from importlib.machinery import ModuleSpec
@@ -163,7 +167,7 @@ from types import ModuleType
 from typing import Any, Callable, Generator, Iterable, Optional, Union, cast
 
 
-__version__ = '0.3.52'
+__version__ = '0.3.54'
 
 
 os_path_abspath = os.path.abspath
@@ -176,7 +180,7 @@ os_path_join = os.path.join
 os_path_normpath = os.path.normpath
 os_path_realpath = os.path.realpath
 os_path_relpath = os.path.relpath
-os_path_sep = os.path.sep
+os_path_sep = os.path.sep                       # pylint: disable=invalid-name
 os_path_splitext = os.path.splitext
 
 
@@ -275,6 +279,24 @@ def app_name_guess() -> str:
     return defuse(app_name)
 
 
+def ascii_str(unicode_str: str) -> str:
+    """ convert non-ASCII chars in str object to a revertible 7-bit/ASCII representation, e.g. to put in a http header.
+
+    :param unicode_str:         string to encode/convert.
+    :return:                    revertible representation of the specified string, using only ASCII characters.
+    """
+    return repr(unicode_str.encode())
+
+
+def str_ascii(encoded_str: str) -> str:
+    """ convert non-ASCII chars in str object encoded with :func:`ascii_str` back to their corresponding Unicode chars.
+
+    :param encoded_str:         string to decode (covert contained ASCII-encoded characters back Unicode chars).
+    :return:                    decoded string.
+    """
+    return literal_eval(encoded_str).decode()
+
+
 def build_config_variable_values(*names_defaults: tuple[str, Any], section: str = 'app') -> tuple[Any, ...]:
     """ determine build config variable values from the ``buildozer.spec`` file in the current directory.
 
@@ -342,6 +364,8 @@ ASCII_UNICODE = (
     (')', '⟯'),     # U+27EF: MATHEMATICAL RIGHT FLATTENED PARENTHESIS
     ('[', '⟦'),     # U+27E6: MATHEMATICAL LEFT WHITE SQUARE BRACKET
     (']', '⟧'),     # U+27E7: MATHEMATICAL RIGHT WHITE SQUARE BRACKET
+    ('{', '﹛'),     # U+FE5B: Small Left Curly Bracket
+    ('}', '﹜'),     # U+FE5C: Small Right Curly Bracket
     ('#', '﹟'),     # U+FE5F: Small Number Sign
     (';', '﹔'),     # U+FE54: Small Semicolon
     ('@', '﹫'),     # U+FE6B: Small Commercial At
@@ -476,13 +500,14 @@ def force_encoding(text: Union[str, bytes], encoding: str = DEF_ENCODING, errors
     return enc_str.decode(encoding=encoding)
 
 
-class UnformattedValue:
+class UnformattedValue:                     # pylint: disable=too-few-public-methods
     """ helper class for :func:`~ae.base.format_given` to keep placeholder with format unchanged if not found. """
     def __init__(self, key: str):
         self.key = key
 
     def __format__(self, format_spec: str):
         """ overriding Python object class method to return placeholder unchanged including the curly brackets. """
+        # pylint: disable=consider-using-f-string
         return "{{{}{}}}".format(self.key, ":" + format_spec if format_spec else "")
 
 
@@ -514,7 +539,7 @@ def format_given(text: str, placeholder_map: dict[str, Any], strict: bool = Fals
     formatter = GivenFormatter()
     try:
         return formatter.vformat(text, (), placeholder_map)
-    except (ValueError, Exception) as ex:
+    except (ValueError, Exception) as ex:                           # pylint: disable=broad-except
         if strict:
             raise ex
         return text
@@ -817,6 +842,7 @@ def os_host_name() -> str:
     return defuse(platform.node()) or "indeterminableHostName"
 
 
+# noinspection PyTypeChecker
 def os_local_ip() -> str:
     """ determine ip address of this system/machine in the local network (LAN or WLAN).
 
@@ -827,16 +853,16 @@ def os_local_ip() -> str:
     """
     socket1 = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
     try:
-        socket1.connect(('10.255.255.255', 1))      # doesn't even have to be reachable
+        socket1.connect(('10.255.255.255', 1))                      # doesn't even have to be reachable
         ip_address = socket1.getsockname()[0]
-    except (OSError, IOError):                      # pragma: no cover
+    except (OSError, IOError, Exception):                           # pylint: disable=broad-except # pragma: no cover
         # ConnectionAbortedError, ConnectionError, ConnectionRefusedError, ConnectionResetError inherit from OSError
         socket2 = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
         try:
             socket2.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
             socket2.connect(('<broadcast>', 0))
             ip_address = socket2.getsockname()[0]
-        except (OSError, IOError):
+        except (OSError, IOError, Exception):                       # pylint: disable=broad-except
             ip_address = ""
         finally:
             socket2.close()
@@ -1198,7 +1224,7 @@ def write_file(file_path: str, content: Union[str, bytes],
         file_handle.write(content)
 
 
-class ErrorMsgMixin:
+class ErrorMsgMixin:                                                # pylint: disable=too-few-public-methods
     """ mixin class providing sophisticated error message handling. """
     _err_msg: str = ""
 
@@ -1209,7 +1235,7 @@ class ErrorMsgMixin:
 
     def __init__(self):
         try:
-            from ae.core import main_app_instance       # type: ignore
+            from ae.core import main_app_instance       # type: ignore # pylint: disable=import-outside-toplevel
 
             self.cae = cae = main_app_instance()
             assert cae is not None, f"{self.__class__.__name__}.__init__() called too early; main app instance not"
@@ -1218,7 +1244,7 @@ class ErrorMsgMixin:
             self.dpo = cae.dpo
             self.vpo = cae.vpo
 
-        except (ImportError, AssertionError, Exception) as exc:
+        except (ImportError, AssertionError, Exception) as exc:                 # pylint: disable=broad-except
             print(f"{self.__class__.__name__}.__init__() raised {exc}; using print() instead of main app error loggers")
 
             # self.cae = None
@@ -1278,7 +1304,7 @@ if os_platform == 'android':                                        # pragma: no
         if _dev_id := Settings.getString(context.getContentResolver(), 'device_name'):
             os_device_id = defuse(_dev_id)
 
-    except Exception:
+    except Exception:                                               # pylint: disable=broad-except
         pass
 
     # monkey patch the :func:`shutil.copystat` and :func:`shutil.copymode` helper functions, which are crashing on

{ae_base-0.3.52 → ae_base-0.3.54/ae_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.52
+Version: 0.3.54
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -69,17 +69,17 @@ Dynamic: summary
 
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.95 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_namespace_root V0.3.14 -->
-# base 0.3.52
+# base 0.3.54
 
 [![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.51?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.51)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.53?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.53)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.52.
+>ae_base module 0.3.54.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.52 → ae_base-0.3.54}/tests/test_base.py

@@ -19,18 +19,19 @@ from typing import cast
 from ae.base import (
     ASCII_TO_UNICODE, BUILD_CONFIG_FILE, DOTENV_FILE_NAME, PY_EXT, PY_INIT, PY_MAIN, TESTS_FOLDER, UNICODE_TO_ASCII,
     UNSET,
-    URI_SEP_CHAR, app_name_guess, build_config_variable_values, camel_to_snake, deep_dict_update, dummy_function,
-    duplicates, env_str,
-    dedefuse, force_encoding, format_given, full_stack_trace, import_module, instantiate_config_parser, in_wd,
+    URI_SEP_CHAR, app_name_guess, ascii_str, build_config_variable_values, camel_to_snake,
+    dedefuse, deep_dict_update, defuse, dummy_function, duplicates, env_str,
+    force_encoding, format_given, full_stack_trace, import_module, instantiate_config_parser, in_wd,
     load_env_var_defaults, load_dotenvs, main_file_paths_parts, mask_secrets, module_attr,
     module_file_path, module_name, norm_line_sep, norm_name, norm_path, now_str,
     os_host_name, os_local_ip, _os_platform, os_user_name,
     parse_dotenv, project_main_file, read_file, round_traditional, snake_to_camel, stack_frames, stack_var, stack_vars,
-    sys_env_dict, sys_env_text, to_ascii, defuse, utc_datetime, write_file, ErrorMsgMixin)
+    str_ascii, sys_env_dict, sys_env_text, to_ascii, utc_datetime, write_file,
+    ErrorMsgMixin)
 
 
 tst_uri1 = "schema://user:pwd@domain/path_root/path_sub\\path+file% Üml?ä|ït.path_ext*\"<>|*'()[]{}#^;&=$,~" + chr(127)
-tst_fna1 = "schema⫻user﹕pwd﹫domain⁄path_root⁄path_sub﹨path﹢file﹪␣Üml﹖ä।ït.path_ext﹡＂⟨⟩।﹡‘⟮⟯⟦⟧{}﹟＾﹔﹠﹦﹩﹐~␡"
+tst_fna1 = "schema⫻user﹕pwd﹫domain⁄path_root⁄path_sub﹨path﹢file﹪␣Üml﹖ä।ït.path_ext﹡＂⟨⟩।﹡‘⟮⟯⟦⟧﹛﹜﹟＾﹔﹠﹦﹩﹐~␡"
 tst_uri2 = "test control chars" + "".join(chr(_) for _ in range(1, 32))
 tst_fna2 = "test␣control␣chars␁␂␃␄␅␆␇␈␉␊␋␌␍␎␏␐␑␒␓␔␕␖␗␘␙␚␛␜␝␞␟"
 
@@ -145,6 +146,41 @@ class TestBaseHelpers:
         assert app_name_guess() != 'main'
         assert app_name_guess() == 'unguessable'
 
+    def test_ascii_str(self):
+        assert isinstance(ascii_str(""), str)
+
+        uni_str = "äÄßéÉíÍñÑòÒùÙ"
+        assert all(ord(_) >= 128 for _ in uni_str)
+        assert all(ord(_) < 128 for _ in ascii_str(uni_str))
+
+        uni_str = "".join(UNICODE_TO_ASCII.keys())
+        assert any(ord(_) >= 128 for _ in uni_str)
+        assert all(ord(_) < 128 for _ in ascii_str(uni_str))
+
+        asc_str = "".join(ASCII_TO_UNICODE.keys())
+        assert any(ord(_) < 128 for _ in asc_str)
+        assert all(ord(_) < 128 for _ in ascii_str(asc_str))
+
+    def test_str_ascii(self):
+        assert isinstance(str_ascii(ascii_str("tst")), str)
+
+        assert str_ascii(ascii_str("tst")) == "tst"
+        uni_str = "äÄßéÉíÍñÑòÒùÙ"
+        assert str_ascii(ascii_str(uni_str)) == uni_str
+
+        uni_str = "".join(UNICODE_TO_ASCII.keys())
+        assert str_ascii(ascii_str(uni_str)) == uni_str
+
+        asc_str = "".join(ASCII_TO_UNICODE.keys())
+        assert str_ascii(ascii_str(asc_str)) == asc_str
+
+    def test_str_ascii_errors(self):
+        with pytest.raises(SyntaxError):
+            str_ascii("")
+
+        with pytest.raises(SyntaxError):
+            str_ascii("any tst string not encoded/converted via ascii_str()")
+
     def test_build_config_variable_values_with_spec(self):
         try:
             with open(BUILD_CONFIG_FILE, "w") as file_handle:
@@ -344,9 +380,9 @@ class TestBaseHelpers:
 
     def test_format_given_err(self):
         with pytest.raises(ValueError):
-            format_given("test text with {placeholder", {}, strict=True)     # expected '}' before end of string
+            format_given("test text with {placeholder", {}, strict=True)     # missing closing curly bracket
         with pytest.raises(ValueError):
-            format_given("test text with placeholder}", {}, strict=True)     # Single '}' encountered in format string
+            format_given("test text with placeholder}", {}, strict=True)     # missing opening curly bracket
 
     def test_import_module_ae_base(self):
         mod_ref = import_module('ae.base')