Update dependencies and add YAML, INI and dotenv configuration support

Author: AntoineBuirey

.github/workflows/OnPush.yml

@@ -26,7 +26,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pytest build Coverage
-        pip install tomlkit==0.13.2 jsonschema==4.25.1 requests==2.32.5
+        pip install tomlkit>=0.13.2 jsonschema>=4.25.1 requests>=2.32.5 PyYAML>=6.0.3
 
     - name: Install make
       run: sudo apt-get install make

.github/workflows/OnRelease.yml

@@ -25,7 +25,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pytest coverage
-        pip install tomlkit==0.13.2 jsonschema==4.25.1 requests==2.32.5
+        pip install tomlkit>=0.13.2 jsonschema>=4.25.1 requests>=2.32.5 PyYAML>=6.0.3
 
     - name: Install make
       run: sudo apt-get install make

config/config/__init__.py

@@ -1 +1 @@
-from .config import MemoryConfig, JSONConfig, TOMLConfig
+from .config import MemoryConfig, JSONConfig, TOMLConfig, INIConfig, EnvConfig, YAMLConfig

config/config/config.py

@@ -13,6 +13,10 @@
 import os
 import tomlkit
 from typing import Any, Dict
+import configparser
+from io import StringIO
+import shlex
+import yaml
 
 try: # use gamuLogger if available # pragma: no cover
     from gamuLogger import Logger
@@ -395,6 +399,98 @@ def _from_string(self, config_string: str) -> None:
         """
         self._config = tomlkit.loads(config_string)
 
+
+class YAMLConfig(FileConfig):
+    """
+    YAML configuration management class.
+    """
+    def _to_string(self) -> str:
+        """
+        String representation of the configuration in YAML format.
+        """
+        return yaml.safe_dump(self._config, sort_keys=False)
+
+    def _from_string(self, config_string: str) -> None:
+        """
+        Create a configuration object from a YAML string.
+        """
+        loaded = yaml.safe_load(config_string)
+        # YAML can produce None for empty documents
+        self._config = loaded if isinstance(loaded, dict) and loaded is not None else ({} if loaded is None else loaded)
+
+
+class INIConfig(FileConfig):
+    """
+    INI configuration management class using configparser.
+    Sections become nested dictionaries.
+    """
+    def _to_string(self) -> str:
+        parser = configparser.RawConfigParser()
+        # If there are top-level keys (not nested under a section), put them in DEFAULT
+        defaults = {}
+        for k, v in list(self._config.items()):
+            if isinstance(v, dict):
+                parser[k] = {str(kk): str(vv) for kk, vv in v.items()}
+            else:
+                defaults[k] = str(v)
+        if defaults:
+            parser.defaults().update({str(k): str(v) for k, v in defaults.items()})
+        sio = StringIO()
+        parser.write(sio)
+        return sio.getvalue()
+
+    def _from_string(self, config_string: str) -> None:
+        parser = configparser.RawConfigParser()
+        try:
+            parser.read_string(config_string)
+        except configparser.MissingSectionHeaderError:
+            # Treat top-level key=value pairs by prepending a DEFAULT section
+            parser.read_string("[DEFAULT]\n" + config_string)
+        data: Dict[str, Any] = {}
+        # defaults (top-level keys)
+        defaults = dict(parser.defaults())
+        for k, v in defaults.items():
+            data[k] = v
+        for section in parser.sections():
+            items = dict(parser.items(section))
+            data[section] = items
+        self._config = data
+
+
+class EnvConfig(FileConfig):
+    """
+    .env-style configuration (KEY=VALUE per line).
+    """
+    def _to_string(self) -> str:
+        lines = []
+        for k, v in self._config.items():
+            lines.append(f"{k}={v}")
+        return "\n".join(lines) + ("\n" if lines else "")
+
+    def _from_string(self, config_string: str) -> None:
+        data: Dict[str, Any] = {}
+        for raw_line in config_string.splitlines():
+            line = raw_line.strip()
+            if not line or line.startswith('#') or line.startswith(';'):
+                continue
+            # support export VAR=VAL
+            if line.startswith('export '):
+                line = line[len('export '):]
+            if '=' not in line:
+                continue
+            key, value = line.split('=', 1)
+            key = key.strip()
+            value = value.strip()
+            # remove surrounding quotes if present
+            if (value.startswith('"') and value.endswith('"')) or (value.startswith("'") and value.endswith("'")):
+                try:
+                    # preserve escaped sequences by using shlex
+                    value = shlex.split(value)[0]
+                except Exception:
+                    value = value[1:-1]
+            data[key] = value
+        self._config = data
+
 class MemoryConfig(BaseConfig):
     """
     In-memory configuration management class.
@@ -418,4 +514,10 @@ def get_config(file_path: str) -> FileConfig:
         return JSONConfig(file_path)
     if file_path.lower().endswith('.toml'):
         return TOMLConfig(file_path)
+    if file_path.lower().endswith(('.yaml', '.yml')):
+        return YAMLConfig(file_path)
+    if file_path.lower().endswith(('.ini', '.cfg')):
+        return INIConfig(file_path)
+    if file_path.lower().endswith('.env'):
+        return EnvConfig(file_path)
     raise ValueError(f"Unsupported configuration file format: {file_path}")

config/pyproject.toml

@@ -11,9 +11,10 @@ authors = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "tomlkit==0.13.2",
-    "jsonschema==4.25.1",
-    "requests==2.32.5"
+    "tomlkit>=0.13.2",
+    "jsonschema>=4.25.1",
+    "requests>=2.32.5",
+    "PyYAML>=6.0.3"
 ]
 
 [tool.setuptools.packages.find]

config/tests/env_tests.py

@@ -0,0 +1,25 @@
+import os
+import tempfile
+import pytest
+from config.config import EnvConfig
+
+
+def test_load_env_file(tmp_path):
+    file_path = tmp_path / ".env"
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write("# comment\nKEY=VALUE\nOTHER='quoted'\nexport NOQUOTES=123\n")
+
+    cfg = EnvConfig(str(file_path))
+    assert cfg._config["KEY"] == "VALUE"
+    assert cfg._config["OTHER"] == "quoted"
+    assert cfg._config["NOQUOTES"] == "123"
+
+
+def test_env_save_and_reload(tmp_path):
+    file_path = tmp_path / ".env2"
+    cfg = EnvConfig(str(file_path))
+    cfg._config = {"A": "1", "B": "two"}
+    cfg._save()
+
+    cfg2 = EnvConfig(str(file_path))
+    assert cfg2._config == {"A": "1", "B": "two"}

config/tests/ini_tests.py

@@ -0,0 +1,34 @@
+import os
+import tempfile
+import pytest
+from config.config import INIConfig
+
+
+def test_load_ini_file(tmp_path):
+    file_path = tmp_path / "test.ini"
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write("[section]\nkey = value\n")
+
+    cfg = INIConfig(str(file_path))
+    assert cfg._config["section"]["key"] == "value"
+
+
+def test_top_level_ini_pairs(tmp_path):
+    file_path = tmp_path / "top.ini"
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write("key1=val1\nkey2=val2\n")
+
+    cfg = INIConfig(str(file_path))
+    assert cfg._config["key1"] == "val1"
+    assert cfg._config["key2"] == "val2"
+
+
+def test_save_ini_roundtrip(tmp_path):
+    file_path = tmp_path / "out.ini"
+    cfg = INIConfig(str(file_path))
+    cfg._config = {"section": {"a": "1"}, "global": "v"}
+    cfg._save()
+
+    cfg2 = INIConfig(str(file_path))
+    assert cfg2._config["section"]["a"] == "1"
+    assert cfg2._config["global"] == "v"

config/tests/yaml_tests.py

@@ -0,0 +1,38 @@
+import os
+import json
+import tempfile
+import pytest
+from config.config import YAMLConfig
+
+
+def test_load_yaml_file(tmp_path):
+    file_path = tmp_path / "test.yaml"
+    content = {
+        "foo": "bar",
+        "nested": {"a": 1}
+    }
+    with open(file_path, "w", encoding="utf-8") as f:
+        import yaml
+        yaml.safe_dump(content, f)
+
+    cfg = YAMLConfig(str(file_path))
+    assert cfg._config == content
+
+
+def test_save_and_reload_yaml(tmp_path):
+    file_path = tmp_path / "save.yaml"
+    cfg = YAMLConfig(str(file_path))
+    cfg._config = {"x": 1, "y": {"z": "v"}}
+    cfg._save()
+
+    cfg2 = YAMLConfig(str(file_path))
+    assert cfg2._config == {"x": 1, "y": {"z": "v"}}
+
+
+def test_invalid_yaml_raises(tmp_path):
+    file_path = tmp_path / "bad.yaml"
+    with open(file_path, "w", encoding="utf-8") as f:
+        f.write("- just: [unclosed")
+
+    with pytest.raises(Exception):
+        YAMLConfig(str(file_path))

makefile

@@ -1,7 +1,7 @@
 
 VERSION = $(shell python get_version.py)
 
-DEPENDENCIES_NAMES = jsonschema requests tomlkit coverage pytest
+DEPENDENCIES_NAMES = jsonschema requests tomlkit coverage pytest PyYAML
 
 MODULES = cache colors config http_code version singleton