Add nox task to check format (#280)

Author: Jannis-Mittenzwei

.github/workflows/checks.yml

@@ -117,9 +117,25 @@ jobs:
           path: .security.json
           include-hidden-files: true
 
+  Format:
+    name: Format Check (Python-${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: ./.github/actions/python-environment
+        with:
+          python-version: "3.9"
+
+      - name: Run format check
+        run: poetry run nox -s project:format
+
   Tests:
     name: Unit-Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
-    needs: [ Documentation, Lint, Type-Check, Security]
+    needs: [ Documentation, Lint, Type-Check, Security, Format]
     runs-on: ubuntu-latest
     env:
       GITHUB_TOKEN: ${{ secrets.ALTERNATIVE_GITHUB_TOKEN ||  secrets.GITHUB_TOKEN }}

doc/changes/unreleased.md

@@ -5,6 +5,8 @@
 * Excluded pyupgrade from project check due to its destructive nature
 * Updated cookiecutter template
     - removed obsolete template file `version.html`
+* Added nox task for format checking
+* Updated GitHub workflow and workflow template of `checks.yml` to include format check
 
 ## 🐞 Fixed
 

exasol/toolbox/git.py

@@ -1,5 +1,5 @@
 import subprocess
-from typing import Iterable
+from collections.abc import Iterable
 
 
 def tags() -> Iterable[str]:

exasol/toolbox/metrics.py

@@ -151,7 +151,7 @@ def security(file: Union[str, Path]) -> Rating:
     return Rating.bandit_rating(_bandit_scoring(security_lint["results"]))
 
 
-def _bandit_scoring(ratings: List[Dict[str, Any]]) -> float:
+def _bandit_scoring(ratings: list[dict[str, Any]]) -> float:
     def char(value: str, default: str = "H") -> str:
         if value in ["HIGH", "MEDIUM", "LOW"]:
             return value[0]
@@ -258,7 +258,7 @@ def _json(report: Report) -> str:
     def identity(obj: Any) -> Any:
         return obj
 
-    transformation: Dict[type, Callable[[Any], Any]] = defaultdict(
+    transformation: dict[type, Callable[[Any], Any]] = defaultdict(
         lambda: identity,
         {
             Rating: lambda value: f"{value:n}",

exasol/toolbox/nox/_format.py

@@ -40,3 +40,10 @@ def fix(session: Session) -> None:
     _version(session, Mode.Fix, PROJECT_CONFIG.version_file)
     _pyupgrade(session, py_files)
     _code_format(session, Mode.Fix, py_files)
+
+
+@nox.session(name="project:format", python=False)
+def fmt_check(session: Session) -> None:
+    """Checks the project for correct formatting"""
+    py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
+    _code_format(session=session, mode=Mode.Check, files=py_files)

exasol/toolbox/nox/_shared.py

@@ -1,17 +1,17 @@
 from __future__ import annotations
 
 import argparse
+from collections import ChainMap
+from collections.abc import (
+    Iterable,
+    MutableMapping,
+)
 from enum import (
     Enum,
     auto,
 )
 from pathlib import Path
-from typing import (
-    Any,
-    ChainMap,
-    Iterable,
-    MutableMapping,
-)
+from typing import Any
 
 from nox import Session
 

exasol/toolbox/nox/_test.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
-from pathlib import Path
-from typing import (
-    Any,
+from collections.abc import (
     Iterable,
     MutableMapping,
 )
+from pathlib import Path
+from typing import Any
 
 import nox
 from nox import Session

exasol/toolbox/pre_commit_hooks/package_version.py

@@ -5,13 +5,13 @@
     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,
-    Iterable,
     Union,
 )
 
@@ -49,8 +49,8 @@ class CommitHookError(Exception):
 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] = {}
+        _locals: dict[str, Any] = {}
+        _globals: dict[str, Any] = {}
         exec(file.read(), _locals, _globals)
 
         try:

exasol/toolbox/templates/github/workflows/checks.yml

@@ -123,9 +123,24 @@ jobs:
           path: .security.json
           include-hidden-files: true
 
+  Format:
+    name: Format Check (Python-${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0
+        with:
+          python-version: "3.9"
+      - name: Run format check
+        run: poetry run nox -s project:format
+
   Tests:
     name: Unit-Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
-    needs: [ Documentation, Lint, Type-Check, Security]
+    needs: [ Documentation, Lint, Type-Check, Security, Format ]
     runs-on: ubuntu-latest
     env:
       GITHUB_TOKEN: ${{ secrets.ALTERNATIVE_GITHUB_TOKEN ||  secrets.GITHUB_TOKEN }}

exasol/toolbox/templates/noxconfig.py

@@ -1,11 +1,9 @@
 from __future__ import annotations
 
+from collections.abc import MutableMapping
 from dataclasses import dataclass
 from pathlib import Path
-from typing import (
-    Any,
-    MutableMapping,
-)
+from typing import Any
 
 from nox import Session