ae-base 0.3.55__py3-none-any.whl → 0.3.57__py3-none-any.whl

ae/base.py

@@ -32,6 +32,9 @@ sortable and compact string from a timestamp.
 base helper functions
 ---------------------
 
+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.
+
 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`.
 
@@ -165,10 +168,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, Generator, Iterable, Optional, Union, cast
+from typing import Any, Callable, Generator, Iterable, MutableMapping, Optional, Union, cast
 
 
-__version__ = '0.3.55'
+__version__ = '0.3.57'
 
 
 os_path_abspath = os.path.abspath
@@ -630,24 +633,24 @@ def load_dotenvs():
 
     .. hint:: call from the main module of project/app in order to also load ``.env`` files in/above the project folder.
     """
-    load_env_var_defaults(os.getcwd())
+    env_vars = os.environ
+    load_env_var_defaults(os.getcwd(), env_vars)
     if file_name := stack_var('__file__'):
-        load_env_var_defaults(os_path_dirname(os_path_abspath(file_name)))
+        load_env_var_defaults(os_path_dirname(os_path_abspath(file_name)), env_vars)
 
 
-def load_env_var_defaults(start_dir: str):
-    """ detect and load a chain of ``.env`` files starting in the specified folder or one above.
+def load_env_var_defaults(start_dir: str, env_vars: MutableMapping[str, str]):
+    """ load undeclared env var defaults from a chain of ``.env`` files starting in the specified folder or its parent.
 
-    :param start_dir:           folder to start search of an ``.env`` file, if not found, then checks the parent folder.
-                                if the first ``.env `` file got found, then load their shell environment variables
-                                into Python's :data:`os.environ`. after loading the first one, it repeats to check for
+    :param start_dir:           folder to start search of an ``.env`` file, if not found, then also checks the parent
+                                folder. if an ``.env `` file got found, then put their shell environment variable values
+                                into the  specified :paramref:`~load_env_var_defaults.env_vars` mapping if they are not
+                                already there. after processing the first ``.env`` file, it repeats to check for
                                 further ``.env`` files in the parent folder to load them too, until either detecting
                                 a folder without an ``.env`` file or until an ``.env`` got loaded from the root folder.
-
-    .. note::
-        only variables that are not declared in :data:`os.environ` will be added (with the
-        value specified in the ``.env`` file to be loaded). the variable values declared in the subfolders
-        are having preference over the values declared in the parent folders.
+    :param env_vars:            environment variables mapping to be amended with env variable values from any
+                                found ``.env`` file. pass Python's :data:`os.environ` to amend this mapping directly
+                                with all the already not declared environment variables.
     """
     file_path = os_path_abspath(os_path_join(start_dir, DOTENV_FILE_NAME))
     if not os_path_isfile(file_path):
@@ -655,8 +658,8 @@ def load_env_var_defaults(start_dir: str):
 
     while os_path_isfile(file_path):
         for var_nam, var_val in parse_dotenv(file_path).items():
-            if var_nam not in os.environ:
-                os.environ[var_nam] = var_val
+            if var_nam not in env_vars:
+                env_vars[var_nam] = var_val
 
         if os.sep not in file_path:
             break           # pragma: no cover # prevent endless-loop for ``.env`` file in root dir (os.sep == '/')
@@ -1018,6 +1021,15 @@ def round_traditional(num_value: float, num_digits: int = 0) -> float:
     return round(num_value + 10 ** (-len(str(num_value)) - 1), num_digits)
 
 
+def sign(number: float) -> int:
+    """ return ths sign (-1, 0, 1) of a number.
+
+    :param number:              any number of type float or int.
+    :return:                    -1 if the number is negative, 0 if it is zero, or 1 if it is positive.
+    """
+    return (number > 0) - (number < 0)
+
+
 def snake_to_camel(name: str, back_convertible: bool = False) -> str:
     """ convert name from snake_case to CamelCase.
 

{ae_base-0.3.55.dist-info → ae_base-0.3.57.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ae_base
-Version: 0.3.55
+Version: 0.3.57
 Summary: ae namespace module portion base: basic constants, helper functions and context manager
 Home-page: https://gitlab.com/ae-group/ae_base
 Author: AndiEcker
@@ -67,19 +67,19 @@ Dynamic: provides-extra
 Dynamic: requires-python
 Dynamic: summary
 
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae V0.3.95 -->
+<!-- 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.55
+# base 0.3.57
 
 [![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.54?logo=python)](
-    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.54)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_base/release0.3.56?logo=python)](
+    https://gitlab.com/ae-group/ae_base/-/tree/release0.3.56)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_base)](
     https://pypi.org/project/ae-base/#history)
 
->ae_base module 0.3.55.
+>ae namespace module portion base: basic constants, helper functions and context manager.
 
 [![Coverage](https://ae-group.gitlab.io/ae_base/coverage.svg)](
     https://ae-group.gitlab.io/ae_base/coverage/index.html)

ae_base-0.3.57.dist-info/RECORD

@@ -0,0 +1,7 @@
+ae/base.py,sha256=qeqUQx1aByTZ4TphLHMqHFb-DQ3mjjjAQHk07_7J4Ts,67354
+ae_base-0.3.57.dist-info/licenses/LICENSE.md,sha256=k61Ar-RjA09gAZejD19C5g-mItE0OuhIC4zU0gbYpXE,35002
+ae_base-0.3.57.dist-info/METADATA,sha256=CNz-UlnyEAwK4y139Wo1hJWqdzEhH28n1J_jULM4nmc,5724
+ae_base-0.3.57.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ae_base-0.3.57.dist-info/top_level.txt,sha256=vUdgAslSmhZLXWU48fm8AG2BjVnkOWLco8rzuW-5zY0,3
+ae_base-0.3.57.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+ae_base-0.3.57.dist-info/RECORD,,

{ae_base-0.3.55.dist-info → ae_base-0.3.57.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{ae_base-0.3.55.dist-info → ae_base-0.3.57.dist-info}/licenses/LICENSE.md

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

ae_base-0.3.55.dist-info/RECORD

@@ -1,7 +0,0 @@
-ae/base.py,sha256=6ZmvIe_n1v7aLwClLsTUYgEzA38iyZ3azQrqg5x_qPg,66623
-ae_base-0.3.55.dist-info/licenses/LICENSE.md,sha256=uoIIfORuk4V8ZeNh6SN0EUhiU79RC-indIMFqePKVhY,35002
-ae_base-0.3.55.dist-info/METADATA,sha256=6XHzLSdO79byeul7zjCJiP5EP7A5Obbd1rUCsjLyFnc,5658
-ae_base-0.3.55.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
-ae_base-0.3.55.dist-info/top_level.txt,sha256=vUdgAslSmhZLXWU48fm8AG2BjVnkOWLco8rzuW-5zY0,3
-ae_base-0.3.55.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-ae_base-0.3.55.dist-info/RECORD,,