NO-JIRA: chore(ci): add pre-commit checks for Python code

Author: jiridanek

.github/workflows/code-quality.yaml

@@ -50,6 +50,11 @@ jobs:
       - name: Install deps
         run: uv sync --locked
 
+      # https://github.com/pre-commit/action
+      - name: Run pre-commit on all files
+        run: |
+          uv run pre-commit run --all-files
+
       - run: uv run pytest
 
   code-static-analysis:

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+---
+# https://github.com/pre-commit/pre-commit-hooks?tab=readme-ov-file#hooks-available
+repos:
+  # https://docs.astral.sh/uv/guides/integration/pre-commit/
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.6.13
+    hooks:
+      - id: uv-lock
+#  # https://github.com/astral-sh/ruff-pre-commit
+#  - repo: https://github.com/astral-sh/ruff-pre-commit
+#    rev: v0.11.4
+#    hooks:
+#      - id: ruff
+#        types_or: [ python, pyi ]
+#        args: [ --fix ]
+#        files: 'ci/.*|tests/.*'
+#      - id: ruff-format
+#        types_or: [ python, pyi ]
+#        files: 'ci/.*|tests/.*'
+#  # https://pre-commit.com/#new-hooks
+#  - repo: local
+#    hooks:
+#      # https://github.com/microsoft/pyright/issues/3612
+#      # https://github.com/RobertCraigie/pyright-python#pre-commit
+#      - id: pyright
+#        name: Run Pyright on all files
+#        # entry: /bin/bash -c 'find. -name "*.py" | xargs pyright --pythonversion 3.12'
+#        entry: uv run pyright --pythonversion 3.12
+#        pass_filenames: true
+#        types_or: [ python, pyi ]
+#        language: system
+#        files: 'ci/.*|tests/.*'

pyproject.toml

@@ -12,6 +12,10 @@ dependencies = []
 
 [dependency-groups]
 dev = [
+    "pre-commit",
+    "pyright",
+    "ruff",
+
     "pytest",
     "allure-pytest",
     "pytest-subtests",
@@ -39,3 +43,113 @@ environments = [
 [build-system]
 requires = ["uv-build"]
 build-backend = "uv_build"
+
+# inspired from https://github.com/red-hat-data-services/ods-ci/blob/master/pyproject.toml
+
+# https://microsoft.github.io/pyright/#/configuration
+[tool.pyright]
+typeCheckingMode = "off"
+reportMissingImports = "error"
+reportUnboundVariable = "error"
+reportGeneralTypeIssues = "error"
+reportUnnecessaryTypeIgnoreComment = "error"
+reportPossiblyUnboundVariable = "warning"
+reportOptionalMemberAccess = "none"
+reportOptionalSubscript = "none"
+include = ["ci/", "tests/"]
+ignore = [ ]
+pythonVersion = "3.12"
+pythonPlatform = "Linux"
+
+# https://docs.astral.sh/ruff/configuration
+[tool.ruff]
+include = ["pyproject.toml", "ci/**/*.py", "tests/**/*.py"]
+exclude = [ ]
+target-version = "py312"
+line-length = 120
+
+# https://docs.astral.sh/ruff/rules
+[tool.ruff.lint]
+preview = true
+select = [
+    "B", # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "COM", # flake8-commas
+    "E", "W", # pycodestyle errors/warnings
+    "F", # Pyflakes
+    "FA", # flake8-future-annotations
+    "FLY", # flynt
+    "G", # flake8-logging-format
+    "I", # isort
+    "INP", # flake8-no-pep420
+    "INT", # flake8-gettext
+    "ISC", # flake8-implicit-str-concat
+    "N", # pep8-naming
+    "NPY002", # numpy-legacy-random
+    "PERF", # Perflint
+    "PGH", # pygrep-hooks
+    "PIE", # misc lints
+    "PL", # pylint
+    "PYI", # flake8-pyi
+    "Q", # flake8-quotes
+    "RET", # flake8-return
+    "RUF", # Ruff-specific
+    "S102", # flake8-bandit: exec-builtin
+    "T10", # flake8-debugger
+    "TCH", # type-checking imports
+    "TID", # flake8-tidy-imports
+    "UP", # pyupgrade
+    "YTT", # flake8-2020
+]
+ignore = [
+    # intentionally disabled
+    "E203", # space before : (needed for how black formats slicing)
+    "ISC001", # single-line-implicit-string-concatenation (ruff format wants this disabled)
+    # various limits and unimportant warnings
+    "E501", # Line too long
+    "E741", # Ambiguous variable name: `l`
+    "PLR0904", # Too many public methods (56 > 20)
+    "PLR0912", # Too many branches
+    "PLR0913", # Too many arguments in function definition (6 > 5)
+    "PLR0915", # Too many statements
+    "PLR0917", # Too many positional arguments (10/5)
+    "PLR0917", # Too many positional arguments (7/5)
+    "PLR2004", # Magic value used in comparison
+    # "W503", # not yet implemented; line break before binary operator
+    # "W504", # not yet implemented; line break after binary operator
+    # TODO
+    "B006", # Do not use mutable data structures for argument defaults
+    "COM812", # Trailing comma missing
+    "INP001", # File `ods_ci/tests/Resources/Page/ODH/JupyterHub/jupyter-helper.py` is part of an implicit namespace package. Add an `__init__.py`.
+    "N806", # Variable `outputText` in function should be lowercase
+    "N813", # Camelcase `ElementTree` imported as lowercase `et`
+    "N816", # Variable `rotatingHandler` in global scope should not be mixedCase
+    "N999", # Invalid module name: 'createPolarionTestRun'
+    "PERF401", # Use a list comprehension to create a transformed list
+    "PLC1901", # `filter_value != ""` can be simplified to `filter_value` as an empty string is falsey
+    "PLR6201", # Use a `set` literal when testing for membership
+    "PLR6301", # Method `_render_template` could be a function, class method, or static method
+    "PLW1514", # `codecs.open` in text mode without explicit `encoding` argument
+    "PLW2901", # `for` loop variable `tag_it` overwritten by assignment target
+    "RET501", # Do not explicitly `return None` in function if it is the only possible return value
+    "RET504", # Unnecessary assignment to `names` before `return` statement
+    "RET505", # Unnecessary `else` after `return` statement
+    "UP015", # Unnecessary open mode parameters
+    "UP031", # format specifiers instead of percent format
+    "UP032", # Use f-string instead of `format` call
+    "RET507", # Unnecessary `else` after `continue` statement
+    "RET508", # Unnecessary `elif` after `break` statement
+]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+# https://docs.astral.sh/ruff/formatter
+[tool.ruff.format]
+line-ending = "lf"
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+
+docstring-code-format = true
+docstring-code-line-length = "dynamic"