KIT-4553 Introduce Ruff

oschulzSam · oschulzSam · commit 8f9d4f4434d6 · 2025-11-26T21:43:38.000+01:00
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -3,5 +3,5 @@ FROM mcr.microsoft.com/devcontainers/python:3.12-bookworm
 
 # Uninstall pre-installed formatting and linting tools
 # They would conflict with our pinned versions
-RUN pipx uninstall flake8
+RUN pipx uninstall ruff
 RUN pipx uninstall mypy
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -9,25 +9,16 @@
 			"settings": {
 				"python.pythonPath": "/usr/local/bin/python",
 				"python.defaultInterpreterPath": "/usr/local/bin/python",
-				"python.languageServer": "Pylance",
-				"flake8.path": [
-					"/usr/local/py-utils/bin/bandit",
-					"/usr/local/py-utils/bin/pydocstyle"
-				],
-				"flake8.importStrategy": "fromEnvironment"
+				"python.languageServer": "Pylance"
 			},
 			"extensions": [
 				"AykutSarac.jsoncrack-vscode",
+				"charliermarsh.ruff",
 				"eamodio.gitlens",
 				"geeebe.duplicate",
 				"Gruntfuggly.todo-tree",
 				"matangover.mypy",
-				"ms-python.black-formatter",
-				"ms-python.flake8",
-				"ms-python.isort",
-				"ms-python.pylint",
 				"ms-python.python",
-				"ms-python.vscode-pylance",
 				"ms-toolsai.jupyter",
 				"njpwerner.autodocstring",
 				"njqdev.vscode-python-typehint",
@@ -37,7 +28,8 @@
 				"streetsidesoftware.code-spell-checker",
 				"tamasfe.even-better-toml",
 				"visualstudioexptteam.vscodeintellicode",
-				"yzhang.markdown-all-in-one"
+				"yzhang.markdown-all-in-one",
+				"kaih2o.python-resource-monitor"
 			]
 		}
 	},
diff --git a/.flake8 b/.flake8
diff --git a/.github/flake8-error-problem-matcher.json b/.github/flake8-error-problem-matcher.json
diff --git a/.github/flake8-warning-problem-matcher.json b/.github/flake8-warning-problem-matcher.json
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -23,15 +23,16 @@ jobs:
           python-version: "3.12"
       - name: Add linting matchers
         run: |
-          echo "::add-matcher::.github/flake8-error-problem-matcher.json"
-          echo "::add-matcher::.github/flake8-warning-problem-matcher.json"
           echo "::add-matcher::.github/mypy-error-problem-matcher.json"
-      - name: Lint
-        uses: py-actions/flake8@v2
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
+      - name: Create ruff failures dir
+        run: mkdir -p ./ruff_failures
+      - name: Lint with ruff
+        run: |
+          ruff check --output-format github . || echo "sag_py_auth" >> ./ruff_failures/ruff_failures.txt
       - name: Lint typing
         # Must run with installed dependencies
         run: |
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@
 .idea/sqlDataSources.xml
 .idea/dynamic.xml
 .idea/dictionaries
+.idea/ruff.xml
 
 ## File-based project format
 *.ipr
diff --git a/.idea/runConfigurations/Lint.xml b/.idea/runConfigurations/Lint.xml
diff --git a/.mypy.ini b/.mypy.ini
@@ -6,6 +6,7 @@ exclude =  (?x)(
     venv/
     | build/
     | dist/
+    | /site-packages/
   )
 follow_imports = silent
 # Suppresses error messages about imports that cannot be resolved.
diff --git a/.pylintrc b/.pylintrc
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -25,28 +25,30 @@
     ],
     "python.testing.pytestEnabled": true,
     "python.testing.unittestEnabled": false,
-    "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter",
-        "editor.formatOnSave": true,
-        "editor.codeActionsOnSave": {
-            "source.organizeImports": "explicit"
-        },
-    },
-    "isort.args": [
-        "--profile",
-        "black",
-        "--line-length",
-        "120"
-    ],
     "python.analysis.diagnosticSeverityOverrides": {
-        "reportPrivateUsage": "information",
+        "reportUnusedVariable": "none",
+        "reportUnusedImport": "none",
+        "reportUnusedFunction": "none",
+        "reportUnusedCallResult": "none",
+        "reportUnusedClass": "none",
+        "reportUnusedCoroutine": "none",
+        "reportUnusedExcept": "none",
+        "reportUnusedExpression": "none",
+        "reportUnboundVariable": "none",
+        "reportPossiblyUnboundVariable": "none",
+        "reportPrivateUsage": "none",
+        "reportAttributeAccessIssue": "none"
     },
-    "black-formatter.args": [
-        "--line-length=120"
-    ],
     "[json]": {
         "editor.formatOnSave": true
     },
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        }
+    },
     "mypy.targets": [
         // Required by dmypy - otherwise mypy has an error in vscode
         "--follow-imports=normal",
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -11,16 +11,6 @@
                 "panel": "new"
             }
         },
-        {
-            "label": "Lint",
-            "type": "shell",
-            "command": "flake8 . --count --statistics; mypy .",
-            "group": "test",
-            "presentation": {
-                "reveal": "always",
-                "panel": "new"
-            }
-        },
         {
             "label": "Build local package",
             "type": "shell",
@@ -31,15 +21,25 @@
                 "panel": "new"
             }
         },
-		{
-			"label": "Format all",
-			"type": "shell",
-			"command": "black . -l 120",
-			"group": "test",
-			"presentation": {
-				"reveal": "always",
-				"panel": "new"
-			}
-		}
+        {
+              "label": "Lint",
+              "type": "shell",
+              "command": "ruff check; mypy .",
+              "group": "test",
+              "presentation": {
+                  "reveal": "always",
+                  "panel": "new"
+              }
+        },
+        {
+              "label": "Format all",
+              "type": "shell",
+              "command": "ruff format",
+              "group": "test",
+              "presentation": {
+                  "reveal": "always",
+                  "panel": "new"
+              }
+        }
     ]
 }
diff --git a/pyproject.toml b/pyproject.toml
@@ -16,13 +16,13 @@ starlette = "*"
 anyio = ">=4.9.0"
 build = ">=1.2.2.post1"
 coverage-lcov = "*"
-flake8 = ">=7.2.0"
 httpx = "*"
 mock = "*"
 mypy = "*"
 pytest = "*"
 pytest-asyncio = "*"
 pytest-cov = "*"
+ruff = "*"
 toml = "*"
 types-mock = "*"
 zipp = ">=3.21.0"
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -11,6 +11,7 @@ pytest
 pytest-asyncio
 pytest-cov
 starlette >= 0.46.2
+ruff
 # Toml and coverage temporarely fixes compatibility issues between coverage-lcov and coverage
 # see for details: https://github.com/theupdateframework/python-tuf/issues/2254
 toml
diff --git a/sag_py_web_common/__init__.py b/sag_py_web_common/__init__.py
@@ -1,4 +1,3 @@
-# pyright: reportUnusedImport=none
-from .default_route import build_default_route
-from .filtered_access_logger import FilteredAccessLoggerMiddleware
-from .json_exception_handler import handle_unknown_exception, log_exception
+from .default_route import build_default_route # noqa: F401
+from .filtered_access_logger import FilteredAccessLoggerMiddleware # noqa: F401
+from .json_exception_handler import handle_unknown_exception, log_exception # noqa: F401
diff --git a/tests/test_filtered_access_logger.py b/tests/test_filtered_access_logger.py
@@ -10,7 +10,7 @@
 
 app = FastAPI()
 app.add_middleware(
-    FilteredAccessLoggerMiddleware,  # type: ignore[arg-type]
+    FilteredAccessLoggerMiddleware,
     format="%(client_addr)s - %(request_line)s %(status_code)s",
     logger=logging.getLogger("access"),
 )
@@ -35,7 +35,7 @@ def test_middleware_logs_successfully(
     log_level: int, http_response_code: int, caplog: pytest.LogCaptureFixture
 ) -> None:
     caplog.set_level(logging.INFO)
-    mock_app: ASGI3Application = lambda scope, receive, send: None  # type: ignore
+    mock_app: ASGI3Application = lambda scope, receive, send: None  # type: ignore # noqa: E731
     info = {
         "start_time": 1,
         "end_time": 1,
@@ -82,7 +82,7 @@ def test_logs_can_be_ignored_via_path_and_header(
 ) -> None:
     exclude_header = "exclude-logging"
     excluded_paths = ["maintain/serviceStatus", "health/serviceStatus"]
-    mock_app: ASGI3Application = lambda scope, receive, send: None  # type: ignore
+    mock_app: ASGI3Application = lambda scope, receive, send: None  # type: ignore # noqa: E731
     middleware = FilteredAccessLoggerMiddleware(
         app=mock_app, format=None, logger=None, excluded_paths=excluded_paths, exclude_header=exclude_header
     )

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ exclude = (?x)(`
`6`	`6`	`venv/`
`7`	`7`	`\| build/`
`8`	`8`	`\| dist/`
	`9`	`+ \| /site-packages/`
`9`	`10`	`)`
`10`	`11`	`follow_imports = silent`
`11`	`12`	`# Suppresses error messages about imports that cannot be resolved.`