atk-common 3.19.0__tar.gz → 3.20.0__tar.gz

{atk_common-3.19.0 → atk_common-3.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atk_common
-Version: 3.19.0
+Version: 3.20.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

{atk_common-3.19.0 → atk_common-3.20.0}/setup.py

@@ -36,7 +36,7 @@ setup(
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version="3.19.0",  # Required
+    version="3.20.0",  # Required
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#summary

atk_common-3.20.0/src/atk_common/classes/env_handler.py

@@ -0,0 +1,76 @@
+import os
+from pathlib import Path
+from typing import Optional
+from atk_common.interfaces import IEnvHandler
+from atk_common.interfaces import ILogger
+
+class MyEnvHandler(IEnvHandler):
+    def __init__(self, logger: Optional[ILogger]):
+        self.logger = logger
+
+    def set_logger(self, logger: ILogger):
+        self.logger = logger
+
+    def val_str(self, value: Optional[object]) -> str:
+        if value is None:
+            return '<Empty>'
+        if isinstance(value, str):
+            if value.strip() == '' or value.lower() == 'null':
+                return '<Null>'
+            return value
+        return str(value)
+
+    def is_value_null_or_empty(self, value: Optional[str]) -> bool:
+        if value is None:
+            return True
+        s = value.strip()
+        return s == '' or s.lower() == 'null'
+    
+    def get_env_value(self, key: str) -> Optional[str]:
+        val = os.environ.get(key)
+        if val is None:
+            err_msg = f"Environment key '{key}' is missing."
+            if self.logger:
+                self.logger.error(err_msg)
+            raise ValueError(err_msg)
+        if self.logger:
+            self.logger.info(key + ':' + self.val_str(val))
+        if self.is_value_null_or_empty(val):
+            return None
+        return val
+
+    @staticmethod    
+    def read_secret(path):
+        return Path(path).read_text().rstrip('\n')
+
+    def get_env_value_secret(self, key: str, file_key: str) -> str:
+        val = os.environ.get(key)
+        if val is None:
+            err_msg = f"Environment key '{key}' is missing."
+            if self.logger:
+                self.logger.error(err_msg)
+            raise ValueError(err_msg)
+        if self.is_value_null_or_empty(val):
+            secret_path = os.getenv(file_key)
+            if secret_path is None:
+                err_msg = f"Secret file key '{file_key}' is missing."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
+            if self.is_value_null_or_empty(secret_path):
+                err_msg = f"Secret file variable '{file_key}' is not set."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
+            if not Path(secret_path).is_file():
+                err_msg = f"Secret file '{secret_path}' not found."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
+            val = self.read_secret(secret_path)
+            if self.is_value_null_or_empty(val):
+                err_msg = f"Secret from key file '{secret_path}' is empty."
+                if self.logger:
+                    self.logger.error(err_msg)
+                raise ValueError(err_msg)
+        return val

{atk_common-3.19.0 → atk_common-3.20.0}/src/atk_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atk_common
-Version: 3.19.0
+Version: 3.20.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

atk_common-3.19.0/src/atk_common/classes/env_handler.py

@@ -1,38 +0,0 @@
-import os
-from typing import Optional
-from atk_common.interfaces import IEnvHandler
-from atk_common.interfaces import ILogger
-
-class EnvHandler(IEnvHandler):
-    def __init__(self, logger: Optional[ILogger]): # type: ignore
-        self.logger = logger
-
-    def val_str(self, value):
-        if value is None:
-            return '<Empty>'
-        if isinstance(value, str):
-            if value.strip() == '' or value.lower() == 'null':
-                return '<Null>'
-            return value
-        return str(value)
-
-    def is_value_null_or_empty(self, value):
-        if isinstance(value, str):
-            return value.strip() == '' or value.lower() == 'null'
-        return False
-
-    def get_env_value(self, key, abort_on_error=True):
-        val = os.environ.get(key)
-        if self.logger:
-            self.logger.info(key + ':' + self.val_str(val))
-        if val is None and abort_on_error:
-            err_msg = f"Environment variable '{key}' is not set."
-            if self.logger:
-                self.logger.error(err_msg)
-            raise ValueError(err_msg)
-        if self.is_value_null_or_empty(val):
-            return None
-        return val
-    
-    def set_logger(self, logger: ILogger):
-        self.logger = logger