Merge pull request #1613 from maykinmedia/add-ruff-to-ci

Add ruff to ci

Author: swrichards

.git-blame-ignore-revs

@@ -1,3 +1,6 @@
 # format YAML files (remove whitespace)
 
 7ba06e990ff66aadb422e3dba3edbbbcb9bdf970
+
+# Apply ruff fixes for E + F
+39b04db835afdc2086ff433b0a2694ccd254dd74

.github/workflows/code-quality.yml

@@ -94,8 +94,7 @@ jobs:
         ports:
           - 5432:5432
         # Needed because the postgres container does not provide a healthcheck
-        options:
-          --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
     steps:
       - uses: actions/checkout@v3
@@ -135,6 +134,22 @@ jobs:
       - name: Run Prettier
         run: |
           npm run check-linting
+
+  ruff:
+    name: Lint code with ruff
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: grep ^ruff requirements/ci.txt | pip install -r /dev/stdin
+      - name: Run ruff on all files
+        run: ruff check -e --output-format=github src
+
   bandit:
     name: Python security check using Bandit
     runs-on: ubuntu-latest

requirements/ci.txt

@@ -1004,6 +1004,8 @@ ruamel-yaml-clib==0.2.12
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   ruamel-yaml
+ruff==0.9.6
+    # via -r requirements/test-tools.in
 sentry-sdk[django]==2.19.2
     # via
     #   -c requirements/base.txt

requirements/dev.txt

@@ -1158,6 +1158,10 @@ ruamel-yaml-clib==0.2.12
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   ruamel-yaml
+ruff==0.9.6
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
 sentry-sdk[django]==2.19.2
     # via
     #   -c requirements/ci.txt

requirements/test-tools.in

@@ -18,6 +18,7 @@ black
 isort
 flake8
 autoflake
+ruff
 
 # DigidLocal
 pyopenssl

ruff.toml

@@ -0,0 +1,69 @@
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+    "env",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.11
+target-version = "py311"
+
+[lint]
+select = [
+    # https://docs.astral.sh/ruff/rules/#error-e
+    "E",
+    # https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "F",
+]
+ignore = [
+    # Whitespace before ':' (conflicts with Black)
+    "E203",
+    # Two spaces before inline comment
+    "E261",
+    # Line too long
+    "E501",
+    # Do not assign a lambda expression
+    "E731",
+    # Name may be undefined from '*' import
+    "F405",
+    # Local variable is assigned but never used
+    "F841",
+    # Ambiguous variable name
+    "E741",
+]
+
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

src/open_inwoner/accounts/apps.py

@@ -65,10 +65,8 @@ class AccountsConfig(AppConfig):
     _has_run = False
 
     def ready(self):
-        from .signals import (  # noqa:register the signals
-            log_user_login,
-            log_user_logout,
-        )
+        # Register the signals upon app init
+        from .signals import log_user_login, log_user_logout  # noqa:F401
 
         if self._has_run:
             return

src/open_inwoner/conf/local_example.py

@@ -17,7 +17,7 @@
 PLAYWRIGHT_MULTI_ONLY_DEFAULT = True
 
 # Enable django-debug-toolbar
-from .dev import INSTALLED_APPS, MIDDLEWARE
+from .dev import INSTALLED_APPS, MIDDLEWARE  # noqa: E402
 
 INSTALLED_APPS += ["debug_toolbar"]
 MIDDLEWARE += ["debug_toolbar.middleware.DebugToolbarMiddleware"]

src/openklant2/tests/test_partij.py

@@ -93,7 +93,6 @@ def test_create_persoon(client) -> None:
             "digitaleAdressen": None,
             "rekeningnummers": None,
             "voorkeursRekeningnummer": None,
-            "soortPartij": "persoon",
             "voorkeurstaal": "nld",
             "indicatieActief": True,
             "indicatieGeheimhouding": False,