ae-base 0.3.64__py3-none-any.whl → 0.3.66__py3-none-any.whl

ae/base.py

@@ -32,6 +32,10 @@ sortable and compact string from a timestamp.
 base helper functions
 ---------------------
 
+the function :func:`evaluate_literal` can be used as a replacement of :func:`ast.literal_eval` to retrieve
+basic data structure values from config, ini and .env files, while also accepting unquoted strings as a `str` type
+instance.
+
 most programming languages providing a function to determine the sign of a number. the :func:`sign` functino,
 provided by this module/portion is filling this gap in Python.
 
@@ -148,6 +152,7 @@ os.path shortcuts
 the following data items are pointers to shortcut at runtime the lookup to their related functions in the
 Python module :mod:`os.path`:
 """
+# pylint: disable=too-many-lines
 import datetime
 import getpass
 import importlib.abc
@@ -171,7 +176,7 @@ from types import ModuleType
 from typing import Any, Callable, Generator, Iterable, MutableMapping, Optional, Union, cast
 
 
-__version__ = '0.3.64'
+__version__ = '0.3.66'
 
 
 os_path_abspath = os.path.abspath
@@ -355,6 +360,7 @@ def deep_dict_update(data: dict, update: dict, overwrite: bool = True):
 
 
 URI_SEP_CHAR = '⫻'  # U+2AFB: TRIPLE SOLIDUS BINARY RELATION
+# noinspection GrazieInspection
 ASCII_UNICODE = (
     ('/', '⁄'),     # U+2044: Fraction Slash; '∕' U+2215: Division Slash; '⧸' U+29F8: Big Solidus;
                     # '╱' U+FF0F: Fullwidth Solidus; '╱' U+2571: Box Drawings Light Diagonal Upper Right to Lower Left
@@ -428,7 +434,7 @@ def defuse(value: str) -> str:
     in most unix variants only the slash and the ASCII 0 characters are not allowed in file names.
 
     in MS Windows are not allowed: ASCII 0..31 / | \\ : * ? ” % < > ( ). some blogs recommend also not allowing
-    (convert) the characters # and '.
+    (convert) the characters `#` and `'`.
 
     only old POSIX seems to be even more restricted (only allowing alphanumeric characters plus . - and _).
 
@@ -494,6 +500,20 @@ def env_str(name: str, convert_name: bool = False) -> Optional[str]:
     return os.environ.get(name)
 
 
+def evaluate_literal(literal_string: str) -> Any:
+    """ evaluates a Python expression while accepting unquoted strings as str type.
+
+    :param literal_string:      any literal of the base types (like dict, list, set, tuple) which are recognized
+                                by :func:`ast.literal_eval`.
+    :return:                    an instance of the data type or the specified string, even if it is not quoted with
+                                high comma characters.
+    """
+    try:
+        return literal_eval(literal_string)
+    except (IndentationError, SyntaxError, TypeError, ValueError):
+        return literal_string
+
+
 def force_encoding(text: Union[str, bytes], encoding: str = DEF_ENCODING, errors: str = DEF_ENCODE_ERRORS) -> str:
     """ force/ensure the encoding of text (str or bytes) without any UnicodeDecodeError/UnicodeEncodeError.
 
@@ -630,14 +650,26 @@ def in_wd(new_cwd: str) -> Generator[None, None, None]:
         os.chdir(cur_dir)
 
 
-def load_dotenvs():
-    """ detect and load multiple ``.env`` files in/above the current working directory and the calling module folder.
+def load_dotenvs(from_module_path: bool = False):
+    """ detect and load not defined OS environment variables from ``.env`` files.
 
-    .. hint:: call from the main module of project/app in order to also load ``.env`` files in/above the project folder.
+    :param from_module_path:    pass True to load OS environment variables (that are not already loaded from ``.env``
+                                files situated in or above the current working directory) also from/above the folder of
+                                the first module in the call stack that gets not excluded/skipped by :func:`stack_var`.
+
+                                in order to also load ``.env`` files in/above the project folder.
+                                call this function from the main module of project/app.
+
+    .. note::
+        only variables that are not already defined in the OS environment variables mapping :data:`os.environ` will be
+        loaded/added. variables will be loaded first from the first ``.env`` file found in or above the current working
+        directory, while the variable values in the deeper situated files are overwriting the values defined in the
+        ``.env`` files situated in the above folders.
     """
     env_vars = os.environ
     load_env_var_defaults(os.getcwd(), env_vars)
-    if file_name := stack_var('__file__'):
+
+    if from_module_path and (file_name := stack_var('__file__')):
         load_env_var_defaults(os_path_dirname(os_path_abspath(file_name)), env_vars)
 
 
@@ -769,11 +801,12 @@ def module_name(*skip_modules: str, depth: int = 0) -> Optional[str]:
 
 
 def norm_line_sep(text: str) -> str:
+    # noinspection GrazieInspection
     """ convert any combination of line separators in the :paramref:`~norm_line_sep.text` arg to new-line characters.
 
-    :param text:                string containing any combination of line separators ('\\\\r\\\\n' or '\\\\r').
-    :return:                    normalized/converted string with only new-line ('\\\\n') line separator characters.
-    """
+        :param text:                string containing any combination of line separators ('\\\\r\\\\n' or '\\\\r').
+        :return:                    normalized/converted string with only new-line ('\\\\n') line separator characters.
+        """
     return text.replace('\r\n', '\n').replace('\r', '\n')
 
 

{ae_base-0.3.64.dist-info → ae_base-0.3.66.dist-info}/METADATA

@@ -1,29 +1,29 @@
 Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.64
+Version: 0.3.66
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
 Author-email: aecker2@gmail.com
-License: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+License: GPL-3.0-or-later
 Project-URL: Bug Tracker, https://gitlab.com/ae-group/ae_base/-/issues
 Project-URL: Documentation, https://ae.readthedocs.io/en/latest/_autosummary/ae.base.html
 Project-URL: Repository, https://gitlab.com/ae-group/ae_base
 Project-URL: Source, https://ae.readthedocs.io/en/latest/_modules/ae/base.html
 Keywords: configuration,development,environment,productivity
 Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Provides-Extra: dev
-Requires-Dist: aedev_tpl_project; extra == "dev"
+Requires-Dist: aedev_project_tpls; extra == "dev"
 Requires-Dist: ae_ae; extra == "dev"
 Requires-Dist: anybadge; extra == "dev"
 Requires-Dist: coverage-badge; extra == "dev"
@@ -67,15 +67,15 @@ Dynamic: provides-extra
 Dynamic: requires-python
 Dynamic: summary
 
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.96 -->
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.96 -->
 <!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_namespace_root V0.3.14 -->
-# base 0.3.64
+# base 0.3.66
 
 [![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.63?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.63)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.65?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.65)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 

ae_base-0.3.66.dist-info/RECORD

@@ -0,0 +1,7 @@
+ae/base.py,sha256=JHqqxdP33QB7BI5NfLKBTF1QU2o_DIpIId9VQv8UKYs,69668
+ae_base-0.3.66.dist-info/licenses/LICENSE.md,sha256=tgCt6xhP3pM6OcWOWsCTUNed3CEhLTOaRgBMUMynA0I,35003
+ae_base-0.3.66.dist-info/METADATA,sha256=iDIXXfhbEK4B89iEK3tOqf8INLUpauy6WJvYeqzEMJs,5619
+ae_base-0.3.66.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ae_base-0.3.66.dist-info/top_level.txt,sha256=vUdgAslSmhZLXWU48fm8AG2BjVnkOWLco8rzuW-5zY0,3
+ae_base-0.3.66.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+ae_base-0.3.66.dist-info/RECORD,,

{ae_base-0.3.64.dist-info → ae_base-0.3.66.dist-info}/licenses/LICENSE.md

@@ -1,4 +1,4 @@
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.tpl_project V0.3.36 -->
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.project_tpls v0.3.46 -->
 ### GNU GENERAL PUBLIC LICENSE
 
 Version 3, 29 June 2007

ae_base-0.3.64.dist-info/RECORD

@@ -1,7 +0,0 @@
-ae/base.py,sha256=STUdNRroIq5IXtXCqWRg8vIu-Vx-qvOT8f7gnv8uhH8,67812
-ae_base-0.3.64.dist-info/licenses/LICENSE.md,sha256=vn9XT8MDUxNAWsP60HLwHJp8ZLOI0OJBRe-1N2xXh08,35002
-ae_base-0.3.64.dist-info/METADATA,sha256=Yo8TxzMWNjmhRMgJwKFsXW3Ui6M9IA358AIO1abx4mE,5724
-ae_base-0.3.64.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ae_base-0.3.64.dist-info/top_level.txt,sha256=vUdgAslSmhZLXWU48fm8AG2BjVnkOWLco8rzuW-5zY0,3
-ae_base-0.3.64.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-ae_base-0.3.64.dist-info/RECORD,,