Add ruff linter/formatter

Author: TylerZeroMaster

.github/workflows/test.yml

@@ -56,13 +56,15 @@ jobs:
       - name: Frontend Unit Tests
         run: |
           set -e
-          docker compose exec frontend npm run test:unit
-          docker compose exec frontend npm run lint
+          docker compose -f docker-compose.stack.dev.yml exec frontend npm run test:unit
+          docker compose -f docker-compose.stack.dev.yml exec frontend npm run lint
 
       - name: Backend Unit Tests
         run: |
           set -e
-          docker compose exec backend pytest -vvv ./tests/unit
+          docker compose -f docker-compose.stack.dev.yml exec backend pytest -vvv ./tests/unit
+          docker compose -f docker-compose.stack.dev.yml exec backend ruff check
+          docker compose -f docker-compose.stack.dev.yml exec backend ruff format --check
 
       - name: Test database
         run: |
@@ -76,6 +78,6 @@ jobs:
           fi
           # Ensure the latest migration works backwards and forwards with 
           # existing job data
-          docker compose exec backend alembic downgrade -1
-          docker compose exec backend alembic upgrade head
+          docker compose -f docker-compose.stack.dev.yml exec backend alembic downgrade -1
+          docker compose -f docker-compose.stack.dev.yml exec backend alembic upgrade head
           ./corgi stop

backend/app/.ruff.toml

@@ -0,0 +1,24 @@
+line-length = 80
+
+[lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+]
+ignore = ["F401", "B008", "B006", "UP022"]
+fixable = ["ALL"]
+
+[format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true

backend/app/app/api/__init__.py

@@ -1,12 +1,6 @@
 from fastapi import APIRouter
 
-from app.api.endpoints import (jobs,
-                               abl,
-                               ping,
-                               status,
-                               version,
-                               auth,
-                               github)
+from app.api.endpoints import abl, auth, github, jobs, ping, status, version
 
 api_router = APIRouter()
 api_router.include_router(ping.router, prefix="/ping", tags=["ping"])

backend/app/app/api/endpoints/abl.py

@@ -1,16 +1,17 @@
 from typing import List, Optional
 
+from fastapi import APIRouter, Depends
+from httpx import AsyncClient
+from sqlalchemy.orm import Session
+
 from app.core.auth import RequiresRole
 from app.data_models.models import (
-    Role,
-    RequestApproveBook,
     ApprovedBook,
+    RequestApproveBook,
+    Role,
 )
 from app.db.utils import get_db
-from app.service.abl import get_abl_info_database, add_new_entries
-from fastapi import APIRouter, Depends
-from httpx import AsyncClient
-from sqlalchemy.orm import Session
+from app.service.abl import add_new_entries, get_abl_info_database
 
 router = APIRouter()
 
@@ -21,7 +22,7 @@ async def get_abl_info(
     consumer: Optional[str] = None,
     repo_name: Optional[str] = None,
     version: Optional[str] = None,
-    code_version: Optional[str] = None
+    code_version: Optional[str] = None,
 ):
     return get_abl_info_database(db, consumer, repo_name, version, code_version)
 

backend/app/app/api/endpoints/auth.py

@@ -1,20 +1,25 @@
 import logging
 from typing import Awaitable
 
-from app.core.auth import set_user_session_cookie
-from app.core.config import IS_DEV_ENV
-from app.core.errors import CustomBaseError
-from app.data_models.models import UserSession
-from app.db.utils import get_db
-from app.github import (AccessDeniedError, authenticate_client, get_user,
-                        github_oauth, sync_user_repositories)
-from app.service.user import user_service
 from fastapi import APIRouter, Depends, HTTPException, Request, status
 from fastapi.responses import RedirectResponse
 from httpx import AsyncClient
 from sqlalchemy.orm import Session
 from starlette.datastructures import URL
 
+from app.core.auth import set_user_session_cookie
+from app.core.config import IS_DEV_ENV
+from app.core.errors import CustomBaseError
+from app.db.utils import get_db
+from app.github import (
+    AccessDeniedError,
+    authenticate_client,
+    get_user,
+    github_oauth,
+    sync_user_repositories,
+)
+from app.service.user import user_service
+
 router = APIRouter()
 
 
@@ -26,16 +31,15 @@ def __init__(self):
 async def handle_auth_errors(thunk: Awaitable):
     try:
         return await thunk
-    except AccessDeniedError:
+    except AccessDeniedError as ade:
         raise HTTPException(
-            status_code=status.HTTP_403_FORBIDDEN,
-            detail="Forbidden"
-        )
+            status_code=status.HTTP_403_FORBIDDEN, detail="Forbidden"
+        ) from ade
     except CustomBaseError:
         raise
     except Exception as e:
         logging.error(e)
-        raise AuthenticationError()
+        raise AuthenticationError() from e
 
 
 async def authenticate_token_user(request: Request, token: str, db: Session):
@@ -63,7 +67,8 @@ async def token_login(request: Request, db: Session = Depends(get_db)):
     if access_token is not None:
         token = access_token.split("Bearer ")[1]
         return await handle_auth_errors(
-            authenticate_token_user(request, token, db))
+            authenticate_token_user(request, token, db)
+        )
     else:
         raise CustomBaseError("Missing required token")
 
@@ -85,5 +90,5 @@ async def callback(request: Request, db: Session = Depends(get_db)):
 
     set_user_session_cookie(request, user)
 
-    response = RedirectResponse(url=f"/")
+    response = RedirectResponse(url="/")
     return response

backend/app/app/api/endpoints/github.py

@@ -1,17 +1,18 @@
 from typing import List
 
+from fastapi import APIRouter, Depends
+from sqlalchemy.orm import Session
+
 from app.core.auth import active_user
 from app.data_models.models import RepositorySummary, UserSession
 from app.db.utils import get_db
 from app.service.user import user_service
-from fastapi import APIRouter, Depends
-from sqlalchemy.orm import Session
 
 router = APIRouter()
 
 
 @router.get("/repository-summary", response_model=List[RepositorySummary])
 async def repositories(
-        user: UserSession = Depends(active_user),
-        db: Session = Depends(get_db)):
+    user: UserSession = Depends(active_user), db: Session = Depends(get_db)
+):
     return user_service.get_user_repositories(db, user)