ae-base 0.3.49__tar.gz → 0.3.51__tar.gz

{ae_base-0.3.49/ae_base.egg-info → ae_base-0.3.51}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.49
+Version: 0.3.51
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -61,6 +61,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: provides-extra
 Dynamic: requires-python
@@ -68,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.49
+# base 0.3.51
 
 [![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.48?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.48)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.50?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.50)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.49.
+>ae_base module 0.3.51.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.49 → ae_base-0.3.51}/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.49
+# base 0.3.51
 
 [![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.48?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.48)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.50?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.50)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.49.
+>ae_base module 0.3.51.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.49 → ae_base-0.3.51}/ae/base.py

@@ -40,6 +40,9 @@ and :func:`write_file` are wrapping Python's built-in :func:`open` function and
 
 the function :func:`duplicates` returns the duplicates of an iterable type.
 
+in order to hide/mask secrets like credit card numbers, passwords or tokens in deeply nested data structures,
+before they get dumped e.g. to an app log file, the function :func:`mask_secrets` can be used.
+
 :func:`norm_line_sep` is converting any combination of line separators of a string to a single new-line character.
 
 :func:`norm_name` converts any string into a name that can be used e.g. as file name or as method/attribute name.
@@ -157,10 +160,10 @@ from contextlib import contextmanager
 from importlib.machinery import ModuleSpec
 from inspect import getinnerframes, getouterframes, getsourcefile
 from types import ModuleType
-from typing import Any, Callable, Dict, Generator, Iterable, List, Optional, Tuple, Union, cast
+from typing import Any, Callable, Generator, Iterable, Optional, Union, cast
 
 
-__version__ = '0.3.49'
+__version__ = '0.3.51'
 
 
 os_path_abspath = os.path.abspath
@@ -272,7 +275,7 @@ def app_name_guess() -> str:
     return defuse(app_name)
 
 
-def build_config_variable_values(*names_defaults: Tuple[str, Any], section: str = 'app') -> Tuple[Any, ...]:
+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.
 
     :param names_defaults:      tuple of tuples of build config variable names and default values.
@@ -634,7 +637,7 @@ def load_env_var_defaults(start_dir: str):
         file_path = os_path_join(os_path_dirname(os_path_dirname(file_path)), DOTENV_FILE_NAME)
 
 
-def main_file_paths_parts(portion_name: str) -> Tuple[Tuple[str, ...], ...]:
+def main_file_paths_parts(portion_name: str) -> tuple[tuple[str, ...], ...]:
     """ determine tuple of supported main/version file name path part tuples.
 
     :param portion_name:        portion or package name.
@@ -650,6 +653,29 @@ def main_file_paths_parts(portion_name: str) -> Tuple[Tuple[str, ...], ...]:
     )
 
 
+def mask_secrets(data: Union[dict, Iterable], fragments: Iterable[str] = ('password', 'pwd')) -> Union[dict, Iterable]:
+    """ partially-hide secret string values like passwords/credit-card-numbers in deeply nestable data structures.
+
+    :param data:                iterable deep data structure wherein its item values get masked if their related dict
+                                item key contains one of the fragments specified in :paramref:`~mask_secrets.fragments`.
+    :param fragments:           dict key string fragments of which the related value will be masked. each fragment has
+                                to be specified in lower case! defaults to ('password', 'pwd') if not passed.
+    :return:                    specified data structure with the secrets masked (¡in-place!).
+    """
+    is_dict = isinstance(data, dict)
+
+    for idx, val in tuple(data.items()) if is_dict else enumerate(data):    # type: ignore # silly mypy not sees is_dict
+        val_is_str = isinstance(val, str)
+        if not val_is_str and isinstance(val, Iterable):
+            mask_secrets(val, fragments=fragments)
+        elif is_dict and val_is_str and isinstance(idx, str):
+            idx = idx.lower()
+            if any(_frag in idx for _frag in fragments):
+                data[idx] = val[:3] + "*" * 9                               # type: ignore # silly mypy not sees is_dict
+
+    return data
+
+
 def module_attr(import_name: str, attr_name: str = "") -> Optional[Any]:
     """ determine dynamically a reference to a module or to any attribute (variable/func/class) declared in the module.
 
@@ -722,7 +748,7 @@ def norm_name(name: str, allow_num_prefix: bool = False) -> str:
     :param allow_num_prefix:    pass True to allow leading digits in the returned normalized name.
     :return:                    cleaned/normalized/converted name string (e.g. for a variable-/method-/file-name).
     """
-    str_parts: List[str] = []
+    str_parts: list[str] = []
     for char in name:
         if char.isalpha() or char.isalnum() and (allow_num_prefix or str_parts):
             str_parts.append(char)
@@ -855,13 +881,13 @@ def os_user_name() -> str:
     return getpass.getuser()
 
 
-def parse_dotenv(file_path: str) -> Dict[str, str]:
+def parse_dotenv(file_path: str) -> dict[str, str]:
     """ parse ``.env`` file content and return environment variable names as dict keys and values as dict values.
 
     :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] = {}
+    env_vars: dict[str, str] = {}
     for line in cast(str, read_file(file_path)).splitlines():
         match = _env_line.search(line)
         if not match:
@@ -1017,7 +1043,7 @@ def stack_var(name: str, *skip_modules: str, scope: str = '', depth: int = 1) ->
 
 def stack_vars(*skip_modules: str,
                find_name: str = '', min_depth: int = 1, max_depth: int = 0, scope: str = ''
-               ) -> Tuple[Dict[str, Any], Dict[str, Any], int]:
+               ) -> tuple[dict[str, Any], dict[str, Any], int]:
     """ determine all global and local variables in a calling stack/frames.
 
     :param skip_modules:        module names to skip (def=see :data:`SKIPPED_MODULES` module constant).
@@ -1057,7 +1083,7 @@ def stack_vars(*skip_modules: str,
     return glo.copy(), loc, depth - 1
 
 
-def sys_env_dict() -> Dict[str, Any]:
+def sys_env_dict() -> dict[str, Any]:
     """ returns dict with python system run-time environment values.
 
     :return:                    python system run-time environment values like python_ver, argv, cwd, executable,
@@ -1065,16 +1091,18 @@ def sys_env_dict() -> Dict[str, Any]:
 
     .. hint:: see also https://pyinstaller.readthedocs.io/en/stable/runtime-information.html
     """
-    sed: Dict[str, Any] = {
-        'python_ver': sys.version.replace('\n', ' '),
+    sed: dict[str, Any] = {
+        'python ver': sys.version.replace('\n', ' '),
         'platform': os_platform,
         'argv': sys.argv,
         'executable': sys.executable,
         'cwd': os.getcwd(),
         'frozen': getattr(sys, 'frozen', False),
-        'user_name': os_user_name(),
-        'host_name': os_host_name(),
+        'user name': os_user_name(),
+        'host name': os_host_name(),
+        'device id': os_device_id,
         'app_name_guess': app_name_guess(),
+        'os env': mask_secrets(os.environ.copy()),
     }
 
     if sed['frozen']:
@@ -1084,7 +1112,7 @@ def sys_env_dict() -> Dict[str, Any]:
 
 
 def sys_env_text(ind_ch: str = " ", ind_len: int = 12, key_ch: str = "=", key_len: int = 15,
-                 extra_sys_env_dict: Optional[Dict[str, str]] = None) -> str:
+                 extra_sys_env_dict: Optional[dict[str, str]] = None) -> str:
     """ compile formatted text block with system environment info.
 
     :param ind_ch:              indent character (defaults to " ").
@@ -1220,7 +1248,39 @@ class ErrorMsgMixin:
             self._err_msg = ""
 
 
-if os_platform == 'android':                                    # pragma: no cover
+# platform-specific patches
+os_device_id = os_host_name()
+""" user-definable id/name of the device, defaults to os_host_name() on most platforms, alternatives are:
+
+on all platforms:
+    - socket.gethostname()
+on Android (check with adb shell 'settings get global device_name' and adb shell 'settings list global'):
+    - Settings.Global.DEVICE_NAME (Settings.Global.getString(context.getContentResolver(), "device_name"))
+    - android.os.Build.DEVICE/.MANUFACTURER/.BRAND/.HOST
+    - DeviceName.getDeviceName()
+on MS Windows:
+    - os.environ['COMPUTERNAME']
+"""
+if os_platform == 'android':                                        # pragma: no cover
+    # determine Android device id because os_host_name() returns mostly 'localhost' and not the user-definable device id
+    from jnius import autoclass                                     # type: ignore
+
+    # noinspection PyBroadException
+    try:
+        Settings = autoclass('android.provider.Settings$Global')
+        PythonActivity = autoclass('org.kivy.android.PythonActivity')
+
+        # mActivity inherits from Context so no need to cast('android.content.Context',..) neither get app context
+        # _Context = autoclass('android.content.Context')
+        # context = cast('android.content.Context', PythonActivity.mActivity)
+        # context = PythonActivity.mActivity.getApplicationContext()
+        context = PythonActivity.mActivity
+        if _dev_id := Settings.getString(context.getContentResolver(), 'device_name'):
+            os_device_id = defuse(_dev_id)
+
+    except Exception:
+        pass
+
     # monkey patch the :func:`shutil.copystat` and :func:`shutil.copymode` helper functions, which are crashing on
     # 'android' (see # `<https://bugs.python.org/issue28141>`__ and `<https://bugs.python.org/issue32073>`__). these
     # functions are used by shutil.copy2/copy/copytree/move to copy OS-specific file attributes.
@@ -1229,3 +1289,8 @@ if os_platform == 'android':                                    # pragma: no cov
     # on the destination root directory.
     shutil.copymode = dummy_function
     shutil.copystat = dummy_function
+
+
+elif os_platform in ('win32', 'cygwin'):                            # pragma: no cover
+    if _dev_id := os.environ.get('COMPUTERNAME'):
+        os_device_id = defuse(_dev_id)

{ae_base-0.3.49 → ae_base-0.3.51/ae_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.49
+Version: 0.3.51
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -61,6 +61,7 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: provides-extra
 Dynamic: requires-python
@@ -68,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.49
+# base 0.3.51
 
 [![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.48?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.48)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.50?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.50)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.49.
+>ae_base module 0.3.51.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

{ae_base-0.3.49 → ae_base-0.3.51}/tests/test_base.py

@@ -22,8 +22,9 @@ from ae.base import (
     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,
-    load_env_var_defaults, load_dotenvs, main_file_paths_parts, 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,
+    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)
 
@@ -506,6 +507,39 @@ class TestBaseHelpers:
         assert ('main', PY_INIT) in main_file_paths_parts("")
         assert (por_name, PY_INIT) in main_file_paths_parts(por_name)
 
+    def test_mask_secrets(self):
+        assert mask_secrets({}) == {}
+        assert mask_secrets([]) == []
+        assert mask_secrets(tuple()) == ()
+        assert mask_secrets("") == ""
+
+        assert mask_secrets({'password': "secret"}) == {'password': "sec*********"}
+        assert mask_secrets([{'pwd': "secret"}, "any"]) == [{'pwd': "sec*********"}, "any"]
+
+        assert mask_secrets({'secret': "secret"}, fragments=('token', 'secret')) == {'secret': "sec*********"}
+        assert mask_secrets({'_token': "secret"}, fragments=('token', 'secret')) == {'_token': "sec*********"}
+        assert mask_secrets({'_token': "secret"}, fragments=('TOKEN', 'secret')) == {'_token': "secret"}
+
+        untouched = 'untouched_pw_p_a_s_s_word'
+        dat = {'key1':
+                   {'subkey1':
+                        (
+                            {'host_Pwd': "secret"},
+                            untouched,
+                        ),
+                    'passWord___': "secRet",
+                   },
+               'any_PASSWORD_to_hide': "Se",
+               untouched: untouched,
+        }
+        assert mask_secrets(dat) is dat
+        assert dat['key1']['subkey1'][0]['host_pwd'] == "sec*********"
+        assert dat['key1']['password___'] == "sec*********"
+        assert dat['any_password_to_hide'] == "Se*********"
+
+        assert dat['key1']['subkey1'][1] == untouched
+        assert dat[untouched] == untouched
+
     def test_norm_line_sep(self):
         assert norm_line_sep('a\r\nb') == 'a\nb'
         assert norm_line_sep('a\rb') == 'a\nb'
@@ -792,7 +826,7 @@ class TestBaseHelpers:
         assert snake_to_camel("@special/chars!") == "@special/chars!"
 
     def test_sys_env_dict(self):
-        assert sys_env_dict().get('python_ver')
+        assert sys_env_dict().get('python ver')
         assert sys_env_dict().get('cwd')
         assert sys_env_dict().get('frozen') is False
 
@@ -805,7 +839,7 @@ class TestBaseHelpers:
 
     def test_sys_env_text(self):
         assert isinstance(sys_env_text(), str)
-        assert 'python_ver' in sys_env_text()
+        assert 'python ver' in sys_env_text()
         ret = sys_env_text(extra_sys_env_dict=dict(test_add='TstAdd'))
         assert 'test_add' in ret
         assert 'TstAdd' in ret