Base Config

Author: Jannis-Mittenzwei

exasol/toolbox/BaseConfig/__init__.py

@@ -1,19 +1,21 @@
 from collections.abc import Iterable
+from dataclasses import dataclass
 from pathlib import Path
 from typing import (
     Annotated,
     Optional,
 )
 
 from pydantic import (
-    BaseModel,
     AfterValidator,
-    computed_field
+    BaseModel,
+    computed_field,
+    ConfigDict
 )
 from pydantic.dataclasses import dataclass
 
 from exasol.toolbox.util.version import Version
-from dataclasses import dataclass
+
 
 def str_like_version_validation(versions: list[str]):
     for version in versions:
@@ -31,15 +33,14 @@ class BaseConfig(BaseModel):
         * max_py_version: Maximum of python_versions
         * exasol_versions: (Iterable[str]): Iterabble over all available exasol versions [default: ("7.1.9)
     """
+
     python_versions: Annotated[
         list[str], AfterValidator(str_like_version_validation)
     ] = ["3.9", "3.10", "3.11", "3.12", "3.13"]
     exasol_versions: Annotated[
         list[str], AfterValidator(str_like_version_validation)
     ] = ["7.1.9"]
-    model_config = {
-        "frozen": True
-    }
+    model_config = ConfigDict(frozen=True)
 
     @computed_field
     @property
@@ -49,4 +50,4 @@ def min_py_version(self) -> str:
     @computed_field
     @property
     def max_py_version(self) -> str:
-        return str(max([Version.from_string(v) for v in self.python_versions]))
+        return str(max([Version.from_string(v) for v in self.python_versions]))

noxconfig.py

@@ -6,9 +6,10 @@
 from dataclasses import dataclass
 from pathlib import Path
 
+from exasol.toolbox.BaseConfig import BaseConfig
 from exasol.toolbox.nox.plugin import hookimpl
 from exasol.toolbox.tools.replace_version import update_github_yml
-from exasol.toolbox.BaseConfig import BaseConfig
+
 
 class UpdateTemplates:
     TEMPLATE_PATH: Path = Path(__file__).parent / "exasol" / "toolbox" / "templates"
@@ -39,6 +40,7 @@ def prepare_release_add_files(self, session, config):
 
 class Config(BaseConfig):
     """Project specific configuration used by nox infrastructure"""
+
     root: Path = Path(__file__).parent
     doc: Path = Path(__file__).parent / "doc"
     source: Path = Path("exasol/toolbox")

project-template/{{cookiecutter.repo_name}}/noxconfig.py

@@ -3,10 +3,10 @@
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Iterable
+from exasol.toolbox.BaseConfig import BaseConfig
 
 
-@dataclass(frozen=True)
-class Config:
+class Config(BaseConfig):
     root: Path = Path(__file__).parent
     doc: Path = Path(__file__).parent / "doc"
     source: Path = Path("exasol/{{cookiecutter.package_name}}")

test/integration/project-template/conftest.py

@@ -11,20 +11,26 @@ def cwd(tmp_path_factory):
     return tmp_path_factory.mktemp("project_template_test")
 
 
+@pytest.fixture(scope="session")
+def config():
+    return Config()
+
+
 @pytest.fixture(scope="session", autouse=True)
-def new_project(cwd):
+def new_project(cwd, config):
     project_name = "project"
     repo_name = "repo"
     package_name = "package"
 
     subprocess.run(
-        ["cookiecutter", Config.root / "project-template", "-o", cwd, "--no-input",
+        ["cookiecutter", config.root / "project-template", "-o", cwd, "--no-input",
          f"project_name={project_name}", f"repo_name={repo_name}",
          f"package_name={package_name}",
          ], capture_output=True, check=True)
 
     return cwd / repo_name
 
+
 @pytest.fixture(scope="session", autouse=True)
 def poetry_install(run_command, poetry_path):
     run_command([poetry_path, "install"])

test/unit/BaseConfig/base_config_test.py

@@ -1,14 +1,14 @@
-from exasol.toolbox.BaseConfig import BaseConfig, str_like_version_validation
-import pytest
 import pydantic
+import pytest
+
+from exasol.toolbox.BaseConfig import (
+    BaseConfig,
+    str_like_version_validation,
+)
+
 
 @pytest.mark.parametrize(
-    "versions",
-    (
-        ["$.2.3"],
-        ["1.f.1"],
-        ["1.1.1", "1.2.3", "2.3.4", "2.3.7", "1.1.1.1"]
-    )
+    "versions", (["$.2.3"], ["1.f.1"], ["1.1.1", "1.2.3", "2.3.4", "2.3.7", "1.1.1.1"])
 )
 def test_str_like_version_validation(versions):
     with pytest.raises(ValueError):