Move path-variables to BaseConfig

Author: ArBridgeman

exasol/toolbox/config.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from typing import (
     Annotated,
 )
@@ -46,6 +47,8 @@ class BaseConfig(BaseModel):
     runs.
     """
 
+    project_name: str = Field(description="Name of the project")
+    root_path: Path = Field(description="Root directory of the project")
     python_versions: tuple[ValidVersionStr, ...] = Field(
         default=("3.10", "3.11", "3.12", "3.13", "3.14"),
         description="Python versions to use in running CI workflows",
@@ -70,6 +73,14 @@ class BaseConfig(BaseModel):
     )
     model_config = ConfigDict(frozen=True, arbitrary_types_allowed=True)
 
+    @computed_field  # type: ignore[misc]
+    @property
+    def documentation_path(self) -> Path:
+        """
+        Path where the documentation for the project is stored.
+        """
+        return self.root_path / "doc"
+
     @computed_field  # type: ignore[misc]
     @property
     def minimum_python_version(self) -> str:
@@ -114,3 +125,21 @@ def pyupgrade_argument(self) -> tuple[str, ...]:
         version_parts = self.minimum_python_version.split(".")[:2]
         version_number = "".join(version_parts)
         return (f"--py{version_number}-plus",)
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def source_code_path(self) -> Path:
+        """
+        Path to the source code of the project.
+        """
+        return self.root_path / "exasol" / self.project_name
+
+    @computed_field  # type: ignore[misc]
+    @property
+    def version_filepath(self) -> Path:
+        """
+        Path to the ``version.py`` file included in the project. This is an
+        autogenerated file which contains the version of the code. It is maintained by
+        the nox sessions ``version:check`` and ``release:prepare``.
+        """
+        return self.source_code_path / "version.py"

noxconfig.py

@@ -60,6 +60,8 @@ class Config(BaseConfig):
 
 
 PROJECT_CONFIG = Config(
+    root_path=Path(__file__).parent,
+    project_name="toolbox",
     add_to_excluded_python_paths=(
         # The cookiecutter placeholders do not work well with checks.
         # Instead, the format & linting are checked in the
@@ -72,5 +74,5 @@ class Config(BaseConfig):
     create_major_version_tags=True,
     # The PTB does not have integration tests run with an Exasol DB,
     # so for running in the CI, we take the first element.
-    exasol_versions=(BaseConfig().exasol_versions[0],),
+    exasol_versions=("7.1.30",),
 )

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

@@ -7,15 +7,9 @@
 
 
 class Config(BaseConfig):
-    root: Path = Path(__file__).parent
-    doc: Path = Path(__file__).parent / "doc"
-    source: Path = Path("exasol/{{cookiecutter.package_name}}")
-    version_file: Path = (
-            Path(__file__).parent
-            / "exasol"
-            / "{{cookiecutter.package_name}}"
-            / "version.py"
-    )
     plugins: Iterable[object] = ()
 
-PROJECT_CONFIG = Config()
+PROJECT_CONFIG = Config(
+    project_name="{{cookiecutter.package_name}}",
+    root_path=Path(__file__).parent,
+)