Use config.version_file for version:check

Author: ArBridgeman

doc/changes/unreleased.md

@@ -1,4 +1,8 @@
 # Unreleased
 
 ## 📚 Documentation
-* Updated getting_started.rst for allowing tag-based releases
+* Updated getting_started.rst for allowing tag-based releases
+
+## ✨ Features
+
+* [#441](https://github.com/exasol/python-toolbox/issues/441): Switched nox task for `version:check` to use the config value of `version_file` to specify the location of the `version.py`

exasol/toolbox/nox/_format.py

@@ -36,7 +36,7 @@ def _pyupgrade(session: Session, files: Iterable[str]) -> None:
 def fix(session: Session) -> None:
     """Runs all automated fixes on the code base"""
     py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
-    _version(session, Mode.Fix, PROJECT_CONFIG.version_file)
+    _version(session, Mode.Fix)
     _pyupgrade(session, py_files)
     _code_format(session, Mode.Fix, py_files)
 

exasol/toolbox/nox/_package_version.py

@@ -11,6 +11,10 @@
 
 from exasol.toolbox.error import ToolboxError
 from exasol.toolbox.util.version import Version
+from noxconfig import (
+    PROJECT_CONFIG,
+    Config,
+)
 
 _SUCCESS = 0
 _FAILURE = 1
@@ -20,7 +24,7 @@
     # ATTENTION:
     # This file is generated by exasol/toolbox/nox/_package_version.py when using:
     #   * either "poetry run -- nox -s project:fix"
-    #   * or "poetry run -- nox version:check -- <path/version.py> --fix"
+    #   * or "poetry run -- nox version:check -- --fix"
     # Do not edit this file manually!
     # If you need to change the version, do so in the pyproject.toml, e.g. by using `poetry version X.Y.Z`.
     MAJOR = {major}
@@ -32,8 +36,7 @@
 # fmt: on
 
 
-def write_version_module(version: Version, path: str, exists_ok: bool = True) -> None:
-    version_file = Path(path)
+def write_version_module(version: Version, version_file: Path, exists_ok: bool = True) -> None:
     if version_file.exists() and not exists_ok:
         raise ToolboxError(f"Version file [{version_file}] already exists.")
     version_file.unlink(missing_ok=True)
@@ -50,8 +53,6 @@ def _create_parser() -> ArgumentParser:
         prog="nox -s version:check --",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
-    parser.add_argument("version_module", help="Path to version module")
-    parser.add_argument("files", nargs="*")
     parser.add_argument(
         "-d",
         "--debug",
@@ -69,23 +70,22 @@ def _create_parser() -> ArgumentParser:
     return parser
 
 
-def _version_check(args: Namespace) -> int:
-    module_version = Version.from_python_module(args.version_module)
-    poetry_version = Version.from_poetry()
+def _version_check(args: Namespace, config: Config) -> int:
+    version_file = config.version_file
 
+    module_version = Version.from_python_module(version_file)
+    poetry_version = Version.from_poetry()
     if args.fix:
-        write_version_module(poetry_version, args.version_module)
+        print(
+            f"Updating version in {version_file} from {module_version} to {poetry_version}"
+        )
+        write_version_module(version=poetry_version, version_file=version_file)
+        module_version = Version.from_python_module(version_file)
 
     if module_version != poetry_version:
         print(
-            f"Version in pyproject.toml {poetry_version} and {args.version_module} {module_version} do not match!"
+            f"Version in pyproject.toml ({poetry_version}) and {version_file} ({module_version}) do not match!"
         )
-        if args.fix:
-            print(
-                f"Updating version in file ({args.version_module}) from {module_version} to {poetry_version}"
-            )
-            return _SUCCESS
-
         return _FAILURE
 
     return _SUCCESS
@@ -99,5 +99,5 @@ def version_check(session: Session) -> None:
     """
     parser = _create_parser()
     args = parser.parse_args(session.posargs)
-    if _version_check(args):
+    if _version_check(args=args, config=PROJECT_CONFIG):
         session.error()

exasol/toolbox/nox/_release.py

@@ -67,7 +67,7 @@ def _is_valid_version(old: Version, new: Version) -> bool:
 
 def _update_project_version(session: Session, version: Version) -> Version:
     session.run("poetry", "version", f"{version}")
-    _version(session, Mode.Fix, PROJECT_CONFIG.version_file)
+    _version(session, Mode.Fix)
     return version
 
 

exasol/toolbox/nox/_shared.py

@@ -36,10 +36,10 @@ def python_files(project_root: Path) -> Iterable[Path]:
     return [path for path in files if not set(path.parts).intersection(deny_list)]
 
 
-def _version(session: Session, mode: Mode, version_file: Path) -> None:
+def _version(session: Session, mode: Mode) -> None:
     command = ["nox", "-s", "version:check", "--"]
     command = command if mode == Mode.Check else command + ["--fix"]
-    session.run(*command, f"{version_file}")
+    session.run(*command)
 
 
 def _context_parser() -> argparse.ArgumentParser:

exasol/toolbox/nox/tasks.py

@@ -35,7 +35,7 @@ def check(session: Session) -> None:
     """Runs all available checks on the project"""
     context = _context(session, coverage=True)
     py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
-    _version(session, Mode.Check, PROJECT_CONFIG.version_file)
+    _version(session, Mode.Check)
     _code_format(session, Mode.Check, py_files)
     _pylint(session, py_files)
     _type_check(session, py_files)

exasol/toolbox/version.py

@@ -1,7 +1,7 @@
 # ATTENTION:
 # This file is generated by exasol/toolbox/nox/_package_version.py when using:
 #   * either "poetry run -- nox -s project:fix"
-#   * or "poetry run -- nox version:check -- <path/version.py> --fix"
+#   * or "poetry run -- nox version:check -- --fix"
 # Do not edit this file manually!
 # If you need to change the version, do so in the pyproject.toml, e.g. by using `poetry version X.Y.Z`.
 MAJOR = 1