Rename class to RepositoryGoogleSecretManager

Author: Dresdn

decouple.py

@@ -12,9 +12,11 @@
 
 if PYVERSION >= (3, 0, 0):
     from configparser import ConfigParser, NoOptionError
+
     text_type = str
 else:
     from ConfigParser import SafeConfigParser as ConfigParser, NoOptionError
+
     text_type = unicode
 
 if PYVERSION >= (3, 2, 0):
@@ -23,13 +25,14 @@
     read_config = lambda parser, file: parser.readfp(file)
 
 
-DEFAULT_ENCODING = 'UTF-8'
+DEFAULT_ENCODING = "UTF-8"
 
 
 # Python 3.10 don't have strtobool anymore. So we move it here.
 TRUE_VALUES = {"y", "yes", "t", "true", "on", "1"}
 FALSE_VALUES = {"n", "no", "f", "false", "off", "0"}
 
+
 def strtobool(value):
     if isinstance(value, bool):
         return value
@@ -51,6 +54,7 @@ class Undefined(object):
     """
     Class to represent undefined type.
     """
+
     pass
 
 
@@ -71,7 +75,7 @@ def _cast_boolean(self, value):
         Helper to convert config values to boolean as ConfigParser do.
         """
         value = str(value)
-        return bool(value) if value == '' else bool(strtobool(value))
+        return bool(value) if value == "" else bool(strtobool(value))
 
     @staticmethod
     def _cast_do_nothing(value):
@@ -89,7 +93,11 @@ def get(self, option, default=undefined, cast=undefined):
             value = self.repository[option]
         else:
             if isinstance(default, Undefined):
-                raise UndefinedValueError('{} not found. Declare it as envvar or define a default value.'.format(option))
+                raise UndefinedValueError(
+                    "{} not found. Declare it as envvar or define a default value.".format(
+                        option
+                    )
+                )
 
             value = default
 
@@ -108,7 +116,7 @@ def __call__(self, *args, **kwargs):
 
 
 class RepositoryEmpty(object):
-    def __init__(self, source='', encoding=DEFAULT_ENCODING):
+    def __init__(self, source="", encoding=DEFAULT_ENCODING):
         pass
 
     def __contains__(self, key):
@@ -122,16 +130,16 @@ class RepositoryIni(RepositoryEmpty):
     """
     Retrieves option keys from .ini files.
     """
-    SECTION = 'settings'
+
+    SECTION = "settings"
 
     def __init__(self, source, encoding=DEFAULT_ENCODING):
         self.parser = ConfigParser()
         with open(source, encoding=encoding) as file_:
             read_config(self.parser, file_)
 
     def __contains__(self, key):
-        return (key in os.environ or
-                self.parser.has_option(self.SECTION, key))
+        return key in os.environ or self.parser.has_option(self.SECTION, key)
 
     def __getitem__(self, key):
         try:
@@ -144,18 +152,21 @@ class RepositoryEnv(RepositoryEmpty):
     """
     Retrieves option keys from .env files with fall back to os.environ.
     """
+
     def __init__(self, source, encoding=DEFAULT_ENCODING):
         self.data = {}
 
         with open(source, encoding=encoding) as file_:
             for line in file_:
                 line = line.strip()
-                if not line or line.startswith('#') or '=' not in line:
+                if not line or line.startswith("#") or "=" not in line:
                     continue
-                k, v = line.split('=', 1)
+                k, v = line.split("=", 1)
                 k = k.strip()
                 v = v.strip()
-                if len(v) >= 2 and ((v[0] == "'" and v[-1] == "'") or (v[0] == '"' and v[-1] == '"')):
+                if len(v) >= 2 and (
+                    (v[0] == "'" and v[-1] == "'") or (v[0] == '"' and v[-1] == '"')
+                ):
                     v = v[1:-1]
                 self.data[k] = v
 
@@ -173,12 +184,12 @@ class RepositorySecret(RepositoryEmpty):
     e.g. Docker swarm secrets
     """
 
-    def __init__(self, source='/run/secrets/'):
+    def __init__(self, source="/run/secrets/"):
         self.data = {}
 
         ls = os.listdir(source)
         for file in ls:
-            with open(os.path.join(source, file), 'r') as f:
+            with open(os.path.join(source, file), "r") as f:
                 self.data[file] = f.read()
 
     def __contains__(self, key):
@@ -188,40 +199,41 @@ def __getitem__(self, key):
         return self.data[key]
 
 
-class RepositoryString(RepositoryEmpty):
+class RepositoryGoogleSecretManager(RepositoryEnv):
     """
-    Repository class to retrieve options from a string.
+    Repository class for retrieving configuration options from Google Secret Manager.
 
-    Parses a string formatted like a `.env` file into a dictionary of options.
-    This class is an extension of the `RepositoryEmpty` class that provides a
-    way to read configuration keys from an environment string.
+    This class extends `RepositoryEnv` to specifically handle configurations stored in
+    Google Secret Manager. It parses strings formatted in a similar way to `.env` files,
+    converting them into a dictionary of configuration options.
 
     Attributes:
-        data (dict): A dictionary to hold the parsed key-value pairs.
+        data (dict): A dictionary holding the parsed key-value pairs from the Google
+                     Secret Manager source.
     """
 
     def __init__(self, source):
         """
-        Initializes the RepositoryString with a given string source.
+        Initialize RepositoryGoogleSecretManager with a Google Secret Manager source.
 
-        The provided string should have one "KEY=value" pair per line, similar
-        to a `.env` file format. Lines starting with `#` are considered as
-        comments and ignored. Surrounding whitespace is stripped from keys
-        and values.
+        The source string is expected to have one "KEY=value" pair per line, akin to
+        the `.env` file format. Lines beginning with `#` are treated as comments and
+        are disregarded. Keys and values are trimmed of surrounding whitespace for
+        accurate parsing.
 
         Args:
-            source (str): The string source to parse.
+            source (str): The string source from Google Secret Manager to be parsed.
         """
         self.data = {}
-        source_lines = source.split('\n')
+        source_lines = source.split("\n")
 
         for line in source_lines:
             line = line.strip()
 
-            if not line or line.startswith('#') or '=' not in line:
+            if not line or line.startswith("#") or "=" not in line:
                 continue
 
-            key, value = line.split('=', 1)
+            key, value = line.split("=", 1)
             key = key.strip()
             value = value.strip()
 
@@ -233,33 +245,6 @@ def __init__(self, source):
 
             self.data[key] = value
 
-    def __contains__(self, key):
-        """
-        Check if a key is present in the repository or the environment.
-
-        Args:
-            key (str): The key to check for presence.
-
-        Returns:
-            bool: True if key is in the repository or os.environ, False otherwise.
-        """
-        return key in os.environ or key in self.data
-
-    def __getitem__(self, key):
-        """
-        Retrieve the value associated with the given key.
-
-        Args:
-            key (str): The key to retrieve the value for.
-
-        Returns:
-            str: The value associated with the key.
-
-        Raises:
-            KeyError: If the key is not found in the repository.
-        """
-        return self.data[key]
-
 
 class AutoConfig(object):
     """
@@ -272,10 +257,13 @@ class AutoConfig(object):
         caller's path.
 
     """
-    SUPPORTED = OrderedDict([
-        ('settings.ini', RepositoryIni),
-        ('.env', RepositoryEnv),
-    ])
+
+    SUPPORTED = OrderedDict(
+        [
+            ("settings.ini", RepositoryIni),
+            (".env", RepositoryEnv),
+        ]
+    )
 
     encoding = DEFAULT_ENCODING
 
@@ -292,18 +280,20 @@ def _find_file(self, path):
 
         # search the parent
         parent = os.path.dirname(path)
-        if parent and os.path.normcase(parent) != os.path.normcase(os.path.abspath(os.sep)):
+        if parent and os.path.normcase(parent) != os.path.normcase(
+            os.path.abspath(os.sep)
+        ):
             return self._find_file(parent)
 
         # reached root without finding any files.
-        return ''
+        return ""
 
     def _load(self, path):
         # Avoid unintended permission errors
         try:
             filename = self._find_file(os.path.abspath(path))
         except Exception:
-            filename = ''
+            filename = ""
         Repository = self.SUPPORTED.get(os.path.basename(filename), RepositoryEmpty)
 
         self.config = Config(Repository(filename, encoding=self.encoding))
@@ -327,12 +317,15 @@ def __call__(self, *args, **kwargs):
 
 # Helpers
 
+
 class Csv(object):
     """
     Produces a csv parser that return a list of transformed elements.
     """
 
-    def __init__(self, cast=text_type, delimiter=',', strip=string.whitespace, post_process=list):
+    def __init__(
+        self, cast=text_type, delimiter=",", strip=string.whitespace, post_process=list
+    ):
         """
         Parameters:
         cast -- callable that transforms the item just before it's added to the list.
@@ -382,8 +375,10 @@ def __init__(self, flat=None, cast=text_type, choices=None):
     def __call__(self, value):
         transform = self.cast(value)
         if transform not in self._valid_values:
-            raise ValueError((
-                    'Value not in list: {!r}; valid values are {!r}'
-                ).format(value, self._valid_values))
+            raise ValueError(
+                ("Value not in list: {!r}; valid values are {!r}").format(
+                    value, self._valid_values
+                )
+            )
         else:
             return transform