Switch Config to BaseConfig for type & fix minor typos

Author: ArBridgeman

exasol/toolbox/nox/_artifacts.py

@@ -11,11 +11,9 @@
 import nox
 from nox import Session
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox._shared import check_for_config_attribute
-from noxconfig import (
-    PROJECT_CONFIG,
-    Config,
-)
+from noxconfig import PROJECT_CONFIG
 
 COVERAGE_DB = ".coverage"
 COVERAGE_XML = "ci-coverage.xml"
@@ -227,7 +225,9 @@ def _prepare_coverage_xml(
         session.error(output.returncode, output.stdout, output.stderr)
 
 
-def _upload_to_sonar(session: Session, sonar_token: str | None, config: Config) -> None:
+def _upload_to_sonar(
+    session: Session, sonar_token: str | None, config: BaseConfig
+) -> None:
     command = [
         "pysonar",
         "--sonar-token",

exasol/toolbox/nox/_ci.py

@@ -4,21 +4,21 @@
 import nox
 from nox import Session
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox._shared import check_for_config_attribute
 from noxconfig import (
     PROJECT_CONFIG,
-    Config,
 )
 
 _log = logging.getLogger(__name__)
 
 
-def _python_matrix(config: Config):
+def _python_matrix(config: BaseConfig):
     check_for_config_attribute(config=config, attribute="python_versions")
     return {"python-version": config.python_versions}
 
 
-def _exasol_matrix(config: Config):
+def _exasol_matrix(config: BaseConfig):
     check_for_config_attribute(config=config, attribute="exasol_versions")
     return {"exasol-version": config.exasol_versions}
 

exasol/toolbox/nox/_documentation.py

@@ -12,14 +12,14 @@
 import nox
 from nox import Session
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox._shared import DOCS_OUTPUT_DIR
 from noxconfig import (
     PROJECT_CONFIG,
-    Config,
 )
 
 
-def _build_docs(session: nox.Session, config: Config) -> None:
+def _build_docs(session: nox.Session, config: BaseConfig) -> None:
     session.run(
         "sphinx-build",
         "-W",
@@ -30,7 +30,7 @@ def _build_docs(session: nox.Session, config: Config) -> None:
     )
 
 
-def _build_multiversion_docs(session: nox.Session, config: Config) -> None:
+def _build_multiversion_docs(session: nox.Session, config: BaseConfig) -> None:
     session.run(
         "sphinx-multiversion",
         f"{config.documentation_path}",

exasol/toolbox/nox/_format.py

@@ -5,6 +5,7 @@
 import nox
 from nox import Session
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox._shared import (
     Mode,
     _version,
@@ -13,7 +14,6 @@
 )
 from noxconfig import (
     PROJECT_CONFIG,
-    Config,
 )
 
 
@@ -25,7 +25,7 @@ def command(*args: str) -> Iterable[str]:
     session.run(*command("black"), *files)
 
 
-def _pyupgrade(session: Session, config: Config, files: Iterable[str]) -> None:
+def _pyupgrade(session: Session, config: BaseConfig, files: Iterable[str]) -> None:
     check_for_config_attribute(config, "pyupgrade_argument")
     session.run(
         "pyupgrade",

exasol/toolbox/nox/_package_version.py

@@ -9,10 +9,10 @@
 import nox
 from nox import Session
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.util.version import Version
 from noxconfig import (
     PROJECT_CONFIG,
-    Config,
 )
 
 _SUCCESS = 0
@@ -70,7 +70,7 @@ def _create_parser() -> ArgumentParser:
     return parser
 
 
-def _version_check(args: Namespace, config: Config) -> int:
+def _version_check(args: Namespace, config: BaseConfig) -> int:
     version_file = config.version_filepath
 
     module_version = Version.from_python_module(version_file)

exasol/toolbox/nox/_shared.py

@@ -14,15 +14,15 @@
 
 from nox import Session
 
+from exasol.toolbox.config import BaseConfig
 from noxconfig import (
     PROJECT_CONFIG,
-    Config,
 )
 
 DOCS_OUTPUT_DIR = ".html-documentation"
 
 
-def check_for_config_attribute(config: Config, attribute: str):
+def check_for_config_attribute(config: BaseConfig, attribute: str):
     if not hasattr(config, attribute):
         raise AttributeError(
             "in the noxconfig.py file, the class Config should inherit "

exasol/toolbox/nox/_test.py

@@ -10,16 +10,16 @@
 import nox
 from nox import Session
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox._shared import _context
 from exasol.toolbox.nox.plugin import NoxTasks
 from noxconfig import (
     PROJECT_CONFIG,
-    Config,
 )
 
 
 def _test_command(
-    path: Path, config: Config, context: MutableMapping[str, Any]
+    path: Path, config: BaseConfig, context: MutableMapping[str, Any]
 ) -> Iterable[str]:
     coverage_command = (
         [
@@ -37,14 +37,14 @@ def _test_command(
 
 
 def _unit_tests(
-    session: Session, config: Config, context: MutableMapping[str, Any]
+    session: Session, config: BaseConfig, context: MutableMapping[str, Any]
 ) -> None:
     command = _test_command(config.root_path / "test" / "unit", config, context)
     session.run(*command)
 
 
 def _integration_tests(
-    session: Session, config: Config, context: MutableMapping[str, Any]
+    session: Session, config: BaseConfig, context: MutableMapping[str, Any]
 ) -> None:
     pm = NoxTasks.plugin_manager(config)
 
@@ -63,7 +63,7 @@ def _integration_tests(
 
 
 def _coverage(
-    session: Session, config: Config, context: MutableMapping[str, Any]
+    session: Session, config: BaseConfig, context: MutableMapping[str, Any]
 ) -> None:
     command = ["coverage", "report", "-m"]
     coverage_file = config.root_path / ".coverage"

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

@@ -4,9 +4,6 @@
 
 from exasol.toolbox.config import BaseConfig
 
-
-
-
 PROJECT_CONFIG = BaseConfig(
     project_name="{{cookiecutter.package_name}}",
     root_path=Path(__file__).parent,

test/unit/config_test.py

@@ -33,6 +33,7 @@ def test_works_as_defined(test_project_config_factory):
                 "venv",
             ),
             "minimum_python_version": "3.10",
+            "plugins_for_nox_sessions": (),
             "project_name": "test",
             "python_versions": ("3.10", "3.11", "3.12", "3.13", "3.14"),
             "pyupgrade_argument": ("--py310-plus",),

test/unit/nox/_artifacts_test.py

@@ -17,6 +17,7 @@
     _SessionQuit,
 )
 
+from exasol.toolbox.config import BaseConfig
 from exasol.toolbox.nox import _artifacts
 from exasol.toolbox.nox._artifacts import (
     ALL_LINT_FILES,
@@ -36,13 +37,10 @@
     check_artifacts,
     copy_artifacts,
 )
-from noxconfig import Config
 
 
 @contextlib.contextmanager
-def mock_check_artifacts_session(
-    config: Config,
-):
+def mock_check_artifacts_session(config: BaseConfig):
     with patch("exasol.toolbox.nox._artifacts.PROJECT_CONFIG", new=config):
         yield Mock()