Refactoring/#392 refactor pre commit hook package version.py into nox task (#412)

* version-check was refactored into nox task and its usage changed

---------

Co-authored-by: Ariel Schulz <[email protected]>

Author: Jannis-Mittenzwei

.github/workflows/checks.yml

@@ -19,7 +19,7 @@ jobs:
         uses: ./.github/actions/python-environment
 
       - name: Check Version(s)
-        run: poetry run version-check `poetry run -- python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`
+        run: poetry run -- nox -s version:check -- `poetry run -- python -c "from noxconfig import PROJECT_CONFIG; print(PROJECT_CONFIG.version_file)"`
 
   Documentation:
     name: Docs

doc/changes/unreleased.md

@@ -1 +1,5 @@
 # Unreleased
+
+## ⚒️ Refactorings
+
+* [#412](https://github.com/exasol/python-toolbox/issues/392):  Refactor pre commit hook package version.py into nox task

doc/developer_guide/modules/modules.rst

@@ -7,5 +7,3 @@ Modules
     sphinx/sphinx
     nox
     nox_tasks
-    pre_commit_hooks
-

doc/developer_guide/modules/pre_commit_hooks.rst

@@ -1,6 +1,6 @@
 from argparse import ArgumentTypeError
 
-from exasol.toolbox.release import Version
+from exasol.toolbox.util.version import Version
 
 
 def version(arg: str) -> Version:

exasol/toolbox/cli.py

@@ -1,33 +1,29 @@
-import subprocess
+import argparse
 import sys
 from argparse import (
     ArgumentParser,
     Namespace,
 )
-from collections import namedtuple
-from collections.abc import Iterable
 from inspect import cleandoc
 from pathlib import Path
-from shutil import which
-from typing import (
-    Any,
-    Dict,
-    Union,
-)
 
-Version = namedtuple("Version", ["major", "minor", "patch"])
+import nox
+from nox import Session
+
+from exasol.toolbox.error import ToolboxError
+from exasol.toolbox.util.version import Version
 
 _SUCCESS = 0
 _FAILURE = 1
 
 # fmt: off
 _VERSION_MODULE_TEMPLATE = cleandoc('''
     # ATTENTION:
-    # This file is generated by exasol/toolbox/pre_commit_hooks/package_version.py when using:
+    # This file is generated by exasol/toolbox/nox/_package_version.py when using:
     #   * either "poetry run -- nox -s project:fix"
-    #   * or "poetry run -- version-check <path/version.py> --fix"
+    #   * or "poetry run -- nox version:check -- <path/version.py> --fix"
     # Do not edit this file manually!
-    # If you need to change the version, do so in the project.toml, e.g. by using `poetry version X.Y.Z`.
+    # If you need to change the version, do so in the pyproject.toml, e.g. by using `poetry version X.Y.Z`.
     MAJOR = {major}
     MINOR = {minor}
     PATCH = {patch}
@@ -37,47 +33,10 @@
 # fmt: on
 
 
-def version_from_string(s: str) -> Version:
-    """Converts a version string of the following format major.minor.patch to a version object"""
-    major, minor, patch = (int(number, base=0) for number in s.split("."))
-    return Version(major, minor, patch)
-
-
-class CommitHookError(Exception):
-    """Indicates that this commit hook encountered an error"""
-
-
-def version_from_python_module(path: Path) -> Version:
-    """Retrieve version information from the `version` module"""
-    with open(path, encoding="utf-8") as file:
-        _locals: dict[str, Any] = {}
-        _globals: dict[str, Any] = {}
-        exec(file.read(), _locals, _globals)
-
-        try:
-            version = _globals["VERSION"]
-        except KeyError as ex:
-            raise CommitHookError("Couldn't find version within module") from ex
-
-        return version_from_string(version)
-
-
-def version_from_poetry() -> Version:
-    poetry = which("poetry")
-    if not poetry:
-        raise CommitHookError("Couldn't find poetry executable")
-
-    result = subprocess.run(
-        [poetry, "version", "--no-ansi"], capture_output=True, check=False
-    )
-    version = result.stdout.decode().split()[1]
-    return version_from_string(version)
-
-
 def write_version_module(version: Version, path: str, exists_ok: bool = True) -> None:
     version_file = Path(path)
     if version_file.exists() and not exists_ok:
-        raise CommitHookError(f"Version file [{version_file}] already exists.")
+        raise ToolboxError(f"Version file [{version_file}] already exists.")
     version_file.unlink(missing_ok=True)
     with open(version_file, "w", encoding="utf-8") as f:
         f.write(
@@ -88,7 +47,10 @@ def write_version_module(version: Version, path: str, exists_ok: bool = True) ->
 
 
 def _create_parser() -> ArgumentParser:
-    parser = ArgumentParser()
+    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(
@@ -109,13 +71,13 @@ def _create_parser() -> ArgumentParser:
 
 
 def _main_debug(args: Namespace) -> int:
-    module_version = version_from_python_module(args.version_module)
-    poetry_version = version_from_poetry()
+    module_version = Version.from_python_module(args.version_module)
+    poetry_version = Version.from_poetry()
 
     if args.fix:
         write_version_module(poetry_version, args.version_module)
 
-    if not module_version == poetry_version:
+    if module_version != poetry_version:
         print(
             f"Version in pyproject.toml {poetry_version} and {args.version_module} {module_version} do not match!"
         )
@@ -138,12 +100,11 @@ def _main(args: Namespace) -> int:
         return _FAILURE
 
 
-def main(argv: Union[Iterable[str], None] = None) -> int:
+@nox.session(name="version:check", python=False)
+def version_check(session: Session) -> None:
+    """"""
     parser = _create_parser()
-    args = parser.parse_args()
+    args = parser.parse_args(session.posargs)
     entry_point = _main if not args.debug else _main_debug
-    return entry_point(args)
-
-
-if __name__ == "__main__":
-    sys.exit(main())
+    if entry_point(args):
+        session.error()

exasol/toolbox/pre_commit_hooks/package_version.py renamed to exasol/toolbox/nox/_package_version.py

@@ -14,13 +14,15 @@
 )
 from exasol.toolbox.nox.plugin import NoxTasks
 from exasol.toolbox.release import (
-    ReleaseTypes,
-    Version,
     extract_release_notes,
     new_changelog,
     new_changes,
     new_unreleased,
 )
+from exasol.toolbox.util.version import (
+    ReleaseTypes,
+    Version,
+)
 from noxconfig import PROJECT_CONFIG
 
 

exasol/toolbox/nox/_release.py

@@ -37,7 +37,7 @@ def python_files(project_root: Path) -> Iterable[Path]:
 
 
 def _version(session: Session, mode: Mode, version_file: Path) -> None:
-    command = ["version-check"]
+    command = ["nox", "-s", "version:check", "--"]
     command = command if mode == Mode.Check else command + ["--fix"]
     session.run(*command, f"{version_file}")
 

exasol/toolbox/nox/_shared.py

@@ -85,5 +85,7 @@ def check(session: Session) -> None:
     audit
 )
 
+from exasol.toolbox.nox._package_version import version_check
+
 # isort: on
 # fmt: on

exasol/toolbox/nox/tasks.py

@@ -1,112 +1,10 @@
 from __future__ import annotations
 
-import subprocess
-from dataclasses import dataclass
 from datetime import datetime
-from enum import Enum
-from functools import (
-    total_ordering,
-    wraps,
-)
 from inspect import cleandoc
 from pathlib import Path
-from shutil import which
-
-from exasol.toolbox.error import ToolboxError
-
-
-def _index_or(container, index, default):
-    try:
-        return container[index]
-    except IndexError:
-        return default
-
-
-class ReleaseTypes(Enum):
-    Major = "major"
-    Minor = "minor"
-    Patch = "patch"
-
-    def __str__(self):
-        return self.name.lower()
-
-
-def poetry_command(func):
-    @wraps(func)
-    def wrapper(*args, **kwargs):
-        cmd = which("poetry")
-        if not cmd:
-            raise ToolboxError("Couldn't find poetry executable")
-        try:
-            return func(*args, **kwargs)
-        except subprocess.CalledProcessError as ex:
-            raise ToolboxError(f"Failed to execute: {ex.cmd}") from ex
-
-    return wrapper
-
-
-@total_ordering
-@dataclass(frozen=True)
-class Version:
-    major: int
-    minor: int
-    patch: int
-
-    def __str__(self):
-        return f"{self.major}.{self.minor}.{self.patch}"
-
-    def __lt__(self, other: object):
-        if not isinstance(other, Version):
-            return NotImplemented
-        return (
-            self.major < other.major
-            or (self.major <= other.major and self.minor < other.minor)
-            or (
-                self.major <= other.major
-                and self.minor <= other.minor
-                and self.patch < other.patch
-            )
-        )
-
-    def __eq__(self, other: object):
-        if not isinstance(other, Version):
-            return NotImplemented
-        return (
-            self.major == other.major
-            and self.minor == other.minor
-            and self.patch == other.patch
-        )
-
-    @staticmethod
-    def from_string(version):
-        parts = [int(number, base=0) for number in version.split(".")]
-        if len(parts) > 3:
-            raise ValueError(
-                "Version has an invalid format, "
-                f"expected: '<major>.<minor>.<patch>', actual: '{version}'"
-            )
-        version = [_index_or(parts, i, 0) for i in range(3)]
-        return Version(*version)
-
-    @staticmethod
-    @poetry_command
-    def from_poetry():
-        output = subprocess.run(
-            ["poetry", "version", "--no-ansi", "--short"],
-            capture_output=True,
-            text=True,
-        )
-        return Version.from_string(output.stdout.strip())
-
-    @staticmethod
-    @poetry_command
-    def upgrade_version_from_poetry(t: ReleaseTypes):
-        output = subprocess.run(
-            ["poetry", "version", str(t), "--dry-run", "--no-ansi", "--short"],
-            capture_output=True,
-            text=True,
-        )
-        return Version.from_string(output.stdout.strip())
+
+from exasol.toolbox.util.version import Version
 
 
 def extract_release_notes(file: str | Path) -> str: