Merge pull request #403 from ialarmedalien/add_automation_for_formatting_linting

Add in automation for ruff code formatting and linting.

Author: sierra-moxon

.github/workflows/main.yaml

@@ -13,7 +13,32 @@ on:
   workflow_dispatch:
 
 jobs:
+
+  quality-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - name: Install Poetry
+        run: |
+          pipx install poetry
+          pipx inject poetry poetry-dynamic-versioning
+      - uses: actions/setup-python@v5.6.0
+        with:
+          python-version: 3.13
+      - name: Check pyproject.toml and poetry.lock
+        run: poetry check
+      - name: Install tox
+        run: python -m pip install tox
+      - name: Run codespell
+        run: tox -e codespell
+      - name: Run code format checks
+        run: tox -e format_check
+
+
   test:
+    # TODO: uncomment when ruff format has been run over the codebase
+    # needs:
+    #   - quality-checks
     strategy:
       fail-fast: false
       matrix:
@@ -54,14 +79,14 @@ jobs:
           cache: 'poetry'
 
       #----------------------------------------------
-      #    install your root project, if required 
-      #----------------------------------------------      
+      #    install your root project, if required
+      #----------------------------------------------
       - name: Install library
         run: |
           poetry install --no-interaction
 
       #----------------------------------------------
-      #              coverage report   
+      #              coverage report
       #----------------------------------------------
       - name: Generate coverage results
         # Set bash shell to fail correctly on Windows https://github.com/actions/runner-images/issues/6668

.github/workflows/test-upstream.yaml

@@ -2,8 +2,6 @@
 name: Test with upstream linkml
 on:
   pull_request:
-    branches:
-      - main
   workflow_dispatch:
     inputs:
       upstream_repo:

pyproject.toml

@@ -75,19 +75,139 @@ style = "pep440"
 coverage = "^6.2"
 requests-cache = "^1.2.0"
 
+# https://docs.astral.sh/ruff/settings/
 [tool.ruff]
+extend-exclude = []
+force-exclude = true
 line-length = 120
+# Assume Python 3.9
 target-version = "py39"
 
 [tool.ruff.lint]
+
 select = [
-    "F401",
-    "UP"
+    # core
+    "F", # Pyflakes
+    "E", # pycodestyle errors
+    "W", # pycodestyle warnings
+    "C90", # mccabe +
+    "I", # isort
+    "N", # pep8-naming
+    # "D", # pydocstyle
+    "UP", # pyupgrade
+    # extensions
+    # "YTT", # flake8-2020
+    # "ANN", # flake8-annotations
+    # "ASYNC", # flake8-async
+    # "S", # flake8-bandit
+    # "BLE", # flake8-blind-except
+    # "FBT", # flake8-boolean-trap
+    # "B", # flake8-bugbear
+    # "A", # flake8-builtins
+    # "COM", # flake8-commas
+    # "CPY", # flake8-copyright
+    # "C4", # flake8-comprehensions
+    # "DTZ", # flake8-datetimez
+    # "T10", # flake8-debugger
+    # "DJ", # flake8-django
+    # "EM", # flake8-errmsg
+    # "EXE", # flake8-executable
+    # "FA", # flake8-future-annotations
+    # "ISC", # flake8-implicit-str-concat
+    # "ICN", # flake8-import-conventions
+    # "G", # flake8-logging-format
+    # "INP", # flake8-no-pep420
+    # "PIE", # flake8-pie
+    # "T20", # flake8-print
+    # "PYI", # flake8-pyi
+    # "PT", # flake8-pytest-style
+    # "Q", # flake8-quotes
+    # "RSE", # flake8-raise
+    # "RET", # flake8-return
+    # "SLF", # flake8-self
+    # "SLOT", # flake8-slots
+    # "SIM", # flake8-simplify
+    # "TID", # flake8-tidy-imports
+    # "TCH", # flake8-type-checking
+    # "INT", # flake8-gettext
+    # "ARG", # flake8-unused-arguments
+    # "PTH", # flake8-use-pathlib
+    # "TD", # flake8-todos
+    # "FIX", # flake8-fixme
+    # "ERA", # eradicate
+    # "PD", # pandas-vet
+    # "PGH", # pygrep-hooks
+    # "PL", # Pylint
+    # "TRY", # tryceratops
+    # "FLY", # flynt
+    # "NPY", # NumPy-specific rules
+    # "AIR", # Airflow
+    # "PERF", # Perflint
+    # "FURB", # refurb
+    # "LOG", # flake8-logging
+    # "RUF", # Ruff-specific rules
 ]
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# D203: one-blank-line-before-class (conflicts with D211)
+# D212: multi-line-summary-first-line (conflicts with D213)
+# E203: whitespace before ',', ';', or ':'
+# E501: line length
+# ISC001: conflicts with Ruff's formatter
 ignore = [
-    # Until 3.9 is dropped
-    "UP007",
+    "D203",
+    "D213",
+    "E203",
+    "E501",
+    "ISC001",
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/**/*.py" = ["F401"] # unused imports
+"tests/**/*.py" = ["S101"] # use of assert
+
+[tool.ruff.lint.mccabe]
+# Flag errors (`C901`) whenever the complexity level exceeds 15.
+max-complexity = 15
+
+
+[tool.tox]
+requires = ["tox>=4"]
+env_list = ["lint", "py{39,310,311,312,313}"]
+
+[tool.tox.env.codespell]
+description = "Run spell checkers."
+skip_install = true
+deps = [
+  "codespell",
+  "tomli", # required for getting config from pyproject.toml
+]
+commands = [
+  ["codespell", "{posargs}"]
+]
+
+[tool.tox.env.format]
+description = "Run ruff code formatter."
+skip_install = true
+deps = ["ruff==0.11.13"]
+commands = [
+  ["ruff", "format", "{posargs:.}"],
+]
+
+[tool.tox.env.format_check]
+description = "Check that code is correctly formatted by ruff."
+skip_install = true
+deps = ["ruff==0.11.13"]
+commands = [
+  ["ruff", "format", "--check", "{posargs:.}"],
+]
+
+[tool.tox.env.lint]
+description = "Run code linter (no fixes)."
+skip_install = true
+deps = ["ruff==0.11.13"]
+commands = [
+  ["ruff", "check", "{posargs:.}"],
+]