Cleaned up lazy/messy config implementation

src/node_deployer/config.py

@@ -1,10 +1,5 @@
-# flake8: noqa: F821
-# type: ignore
-#* This file sets a number of config constants by modifying its own globals
-#* As a result, F821 and typing is disabled as the interpreter cannot be
-#* trusted to know when F821 or UndefinedVeriable errors should be raised.
-
 from pathlib import Path
+from types import SimpleNamespace
 
 import docker
 import tomllib
@@ -17,90 +12,92 @@ PROJECT_ROOT: Path = Path(__file__).parent.parent.parent.absolute()
 type ConfigLabel = str | list[str]
 
 
-def get_config(config_label: ConfigLabel = "default") -> dict:
-    """Gets the specified configuration from config.toml
+class Config(SimpleNamespace):
+    def __init__(self, config_label: ConfigLabel, **kwargs) -> None:
+        """Initialises the configuration object
 
-    Args:
-        config_label (ConfigLabel, optional):
-            The label of the configuration to get.
-            Defaults to "default".
+        Args:
+            config_label (ConfigLabel): The configuration to initialise with
+            **kwargs: Additional keyword arguments to become attributes
+        """
+        self.__dict__.update(self.get_config(config_label))
+        self.update_config()
+        _kwargs = {
+            "CLIENT": CLIENT,
+            "MAX_PORT": MAX_PORT,
+            "PROJECT_ROOT": PROJECT_ROOT,
+        }
+        _kwargs.update(kwargs)
+        super().__init__(**_kwargs)
 
-    Returns:
-        dict: The specified configuration
-    """
-    if isinstance(config_label, str):
-        config_label = [config_label]
-    with open(PROJECT_ROOT / "config.toml", "rb") as f:
-        configs: dict = tomllib.load(f)
-    out_config: dict = {}
-    for c in config_label:
-        out_config.update(configs[c])
-    return out_config
+    @staticmethod
+    def get_config(config_label: ConfigLabel = "default") -> dict:
+        """Gets the specified configuration from config.toml
+
+        Args:
+            config_label (ConfigLabel, optional):
+                The label of the configuration to get.
+                Defaults to "default".
+
+        Returns:
+            dict: The specified configuration
+        """
+        if isinstance(config_label, str):
+            config_label = [config_label]
+        with open(PROJECT_ROOT / "config.toml", "rb") as f:
+            configs: dict = tomllib.load(f)
+        out_config: dict = {}
+        for c in config_label:
+            out_config.update(configs[c])
+        return out_config
+
+    def finalise_config(self, config: dict) -> None:
+        """Finalises the configuration by converting paths to Path objects and
+        appropriately setting secondary parameters such as relative paths
+
+        Args:
+            config (dict): The configuration to finalise
+        """
+        # First, convert base paths to Path objects
+        for k, v in config.items():
+            match k:
+                case "SRC_DIR" | "BUILD_DIR":
+                    config[k] = Path(v).absolute()
+                case "CWD_MOUNTDIR":
+                    config[k] = Path(v)
+        # Then, get required paths from config or globals if not present
+        build_dir = config.get("BUILD_DIR", self.BUILD_DIR)
+        cwd_mountdir = config.get("CWD_MOUNTDIR", self.CWD_MOUNTDIR)
+        src_dir = config.get("SRC_DIR", self.SRC_DIR)
+        # Finally, construct the secondary parameters
+        config["FUELIGNITION_BUILD_DIR"] = build_dir / config.get(
+            "FUELIGNITION_BUILD_DIR", self.FUELIGNITION_BUILD_DIR
+        )
+        config["DOCKERFILE_DIR"] = src_dir / config.get("DOCKERFILE_DIR", self.DOCKERFILE_DIR)
+        config["CWD_MOUNT"] = docker.types.Mount(
+            target=str(cwd_mountdir),
+            source=str(PROJECT_ROOT),
+            type="bind",
+        )
+
+    def apply_config(self, config: dict) -> None:
+        """Applies the specified configuration to this object's attributes
+
+        Args:
+            config (dict): The configuration to apply
+        """
+        self.finalise_config(config)
+        self.__dict__.update(config)
+
+    def update_config(self, config_label: ConfigLabel = "default") -> None:
+        """Updates the configuration to the specified configuration
+
+        Args:
+            config_label (ConfigLabel, optional):
+                The label of the configuration to update to.
+                Defaults to "default".
+        """
+        self.apply_config(self.get_config(config_label))
 
 
-def finalise_config(config: dict) -> None:
-    """Finalises the configuration by converting paths to Path objects and
-    appropriately setting secondary parameters such as relative paths
-
-    Args:
-        config (dict): The configuration to finalise
-    """
-    # First, convert base paths to Path objects
-    for k, v in config.items():
-        match k:
-            case "SRC_DIR" | "BUILD_DIR":
-                config[k] = Path(v).absolute()
-            case "CWD_MOUNTDIR":
-                config[k] = Path(v)
-    # Then, get required paths from config or globals if not present
-    build_dir = config.get("BUILD_DIR", BUILD_DIR)
-    cwd_mountdir = config.get("CWD_MOUNTDIR", CWD_MOUNTDIR)
-    src_dir = config.get("SRC_DIR", SRC_DIR)
-    # Finally, construct the secondary parameters
-    config["FUELIGNITION_BUILD_DIR"] = build_dir / config.get(
-        "FUELIGNITION_BUILD_DIR",
-        FUELIGNITION_BUILD_DIR
-    )
-    config["DOCKERFILE_DIR"] = src_dir / config.get(
-        "DOCKERFILE_DIR",
-        DOCKERFILE_DIR
-    )
-    config["CWD_MOUNT"] = docker.types.Mount(
-        target=str(cwd_mountdir),
-        source=str(PROJECT_ROOT),
-        type="bind",
-    )
-
-
-def apply_config(config: dict) -> None:
-    """Applies the specified configuration to this module's globals
-
-    Args:
-        config (dict): The configuration to apply
-    """
-    finalise_config(config)
-    globals().update(config)
-    
-
-def update_config(config_label: ConfigLabel = "default") -> None:
-    """Updates the configuration to the specified configuration
-
-    Args:
-        config_label (ConfigLabel, optional):
-            The label of the configuration to update to.
-            Defaults to "default".
-    """
-    apply_config(get_config(config_label))
-
-
-def init(config_label: ConfigLabel) -> None:
-    """Initialises the configuration module
-
-    Args:
-        config_label (ConfigLabel): The configuration to initialise with
-    """
-    globals().update(get_config(config_label))
-    update_config()
-
-
-init(config_label="default")
+config = Config(config_label="default")