add format check

Author: Jannis-Mittenzwei

.github/workflows/checks.yml

@@ -117,6 +117,27 @@ jobs:
           path: .security.json
           include-hidden-files: true
 
+  Format:
+    name: Format Check (Python-${{ matrix.python-version }})
+    needs: [ Version-Check ]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9" ]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python & Poetry Environment
+        uses: ./.github/actions/python-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - 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]

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

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Iterable
+from collections.abc import Iterable
 
 import nox
 from nox import Session
@@ -27,7 +27,7 @@ def _pyupgrade(session: Session, files: Iterable[str]) -> None:
         "poetry",
         "run",
         "pyupgrade",
-        "--py38-plus",
+        "--py39-plus",
         "--exit-zero-even-if-changed",
         *files,
     )
@@ -40,3 +40,9 @@ 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:
+    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/_lint.py

@@ -7,6 +7,7 @@
     Dict,
     Iterable,
     List,
+    Dict
 )
 
 import nox
@@ -17,6 +18,11 @@
 from exasol.toolbox.nox._shared import python_files
 from noxconfig import PROJECT_CONFIG
 
+from pathlib import Path
+import rich.console
+import tomlkit
+import sys
+
 
 def _pylint(session: Session, files: Iterable[str]) -> None:
     session.run(
@@ -79,23 +85,26 @@ def _import_lint(session: Session, path: Path) -> None:
 
 
 class Dependencies:
-    def __init__(self, illegal: dict[str, list[str]] | None):
+    def __init__(self, illegal: Dict[str, List[str]] | None):
         self._illegal = illegal or {}
 
     @staticmethod
-    def parse(pyproject_toml: str) -> Dependencies:
+    def parse(pyproject_toml: str) -> "Dependencies":
         def _source_filter(version) -> bool:
-            ILLEGAL_SPECIFIERS = ["url", "git", "path"]
-            return any(specifier in version for specifier in ILLEGAL_SPECIFIERS)
+            ILLEGAL_SPECIFIERS = ['url', 'git', 'path']
+            return any(
+                specifier in version
+                for specifier in ILLEGAL_SPECIFIERS
+            )
 
-        def find_illegal(part) -> list[str]:
+        def find_illegal(part) -> List[str]:
             return [
                 f"{name} = {version}"
                 for name, version in part.items()
                 if _source_filter(version)
             ]
 
-        illegal: dict[str, list[str]] = {}
+        illegal: Dict[str, List[str]] = {}
         toml = tomlkit.loads(pyproject_toml)
         poetry = toml.get("tool", {}).get("poetry", {})
 
@@ -115,11 +124,11 @@ def find_illegal(part) -> list[str]:
         return Dependencies(illegal)
 
     @property
-    def illegal(self) -> dict[str, list[str]]:
+    def illegal(self) -> Dict[str, List[str]]:
         return self._illegal
 
 
-def report_illegal(illegal: dict[str, list[str]], console: rich.console.Console):
+def report_illegal(illegal: Dict[str, List[str]], console: rich.console.Console):
     count = sum(len(deps) for deps in illegal.values())
     suffix = "y" if count == 1 else "ies"
     console.print(f"{count} illegal dependenc{suffix}\n", style="red")
@@ -148,7 +157,7 @@ def type_check(session: Session) -> None:
 def security_lint(session: Session) -> None:
     """Runs the security linter on the project"""
     py_files = [f"{file}" for file in python_files(PROJECT_CONFIG.root)]
-    _security_lint(session, py_files)
+    _security_lint(session, list(filter(lambda file: "test" not in file, py_files)))
 
 
 @nox.session(name="lint:dependencies", python=False)

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/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
 

exasol/toolbox/tools/replace_version.py

@@ -25,7 +25,7 @@ def update_version(line, version):
     return f"{keep}{updated}"
 
 
-def update_versions(lines, matcher, version) -> List[str]:
+def update_versions(lines, matcher, version) -> list[str]:
     result = []
     for line in lines:
         if is_update_required(line, matcher):