Add mypy and ruff for linting (#6)

* Add mypy and ruff for linting

* Remove some ignores

* Fix linting errors

* Fix formatting

* Fix more errors

* Update requirements

* Update Python version

* Use | for unions and fix other linting issues

* Remove ignore-missing-imports

* Fix the table for adding users

* Update backend/python/app/utilities/csv_utils.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fix review comments and linting

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: ColinToft

.cursor/rules/project-overview.mdc

@@ -31,6 +31,32 @@ This is a full-stack web application with:
 - Maintain consistent naming conventions across the stack
 - All database changes must go through Alembic migrations
 
+## Code Quality Standards
+
+### Python Backend
+- **Type Safety**: Use mypy for static type checking. All functions must have proper type hints.
+- **Code Style**: Use ruff for linting and formatting. Follow the configuration in `backend/python/pyproject.toml`.
+- **Type Hints**: Always include return types and parameter types for functions and methods.
+- **Imports**: Use absolute imports and organize them with ruff's isort integration.
+
+### Development Workflow
+Before committing:
+1. Run `docker-compose exec backend ruff check .` to check for linting issues
+2. Run `docker-compose exec backend ruff format .` to format code
+3. Run `docker-compose exec backend mypy .` to check type safety
+4. Run tests: `docker-compose exec backend python -m pytest`
+
+### Code Quality Commands
+```bash
+# Backend quality checks
+docker-compose exec backend ruff check --fix .  # Fix linting issues
+docker-compose exec backend ruff format .       # Format code
+docker-compose exec backend mypy .              # Type checking
+
+# Combined quality check
+docker-compose exec backend ruff check . && docker-compose exec backend ruff format --check . && docker-compose exec backend mypy .
+```
+
 ## Container Commands
 
 Start all services: `docker-compose up`

.github/workflows/lint.yml

@@ -59,7 +59,39 @@ jobs:
         working-directory: ./backend/typescript
         run: yarn lint
 
-      - name: Lint Python backend
+      - name: Set up Python
+        if: steps.changes.outputs.python-backend == 'true'
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Cache pip dependencies
+        if: steps.changes.outputs.python-backend == 'true'
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install Python dependencies
+        if: steps.changes.outputs.python-backend == 'true'
+        working-directory: ./backend/python
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run Ruff linter
+        if: steps.changes.outputs.python-backend == 'true'
+        working-directory: ./backend/python
+        run: ruff check . --config pyproject.toml
+
+      - name: Run Ruff formatter check
+        if: steps.changes.outputs.python-backend == 'true'
+        working-directory: ./backend/python
+        run: ruff format --check . --config pyproject.toml
+
+      - name: Run MyPy type checker
         if: steps.changes.outputs.python-backend == 'true'
         working-directory: ./backend/python
-        run: pip install black && python -m black --check .
+        run: mypy . --config-file mypy.ini

.gitignore

@@ -6,6 +6,8 @@
 **/*.log
 **/firebaseServiceAccount.json
 **/.DS_Store
-.vscode
+# VS Code - ignore everything except extensions.json
+.vscode/*
+!.vscode/extensions.json
 **/*.cache
 **/*.egg-info

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "charliermarsh.ruff",
+        "ms-python.mypy-type-checker"
+    ]
+}

README.md

@@ -189,7 +189,9 @@ docker system prune -a --volumes
 
 ### Backend (Python)
 
-The project will use **Ruff** for Python linting and formatting:
+The project uses **Ruff** for Python linting and formatting, and **mypy** for static type checking:
+
+#### Ruff (Linting & Formatting)
 
 ```bash
 # Check for linting issues
@@ -200,9 +202,28 @@ docker-compose exec backend ruff check --fix .
 
 # Format code
 docker-compose exec backend ruff format .
+
+# Check formatting without making changes
+docker-compose exec backend ruff format --check .
+```
+
+#### mypy (Static Type Checking)
+
+```bash
+# Run type checking
+docker-compose exec backend mypy .
+```
+
+#### Combined Quality Checks
+
+```bash
+# Run all quality checks (linting, formatting, type checking)
+docker-compose exec backend ruff check . && docker-compose exec backend ruff format --check . && docker-compose exec backend mypy .
 ```
 
-_Note: Ruff configuration will be added in future updates._
+**Configuration Files:**
+- Ruff: `backend/python/pyproject.toml` (under `[tool.ruff]`)
+- mypy: `backend/python/mypy.ini`
 
 ### Frontend (TypeScript/React)
 

backend/python/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9
+FROM python:3.10
 
 WORKDIR /app
 

backend/python/app/__init__.py

@@ -1,22 +1,19 @@
-import os
-import re
-import firebase_admin
-import logging
+from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
-from typing import AsyncGenerator
+from logging.config import dictConfig
 
+import firebase_admin
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
-from logging.config import dictConfig
 
 from .config import settings
 from .models import init_app as init_models
 from .routers import init_app as init_routers
 
 
-def configure_logging():
+def configure_logging() -> None:
     """Configure application logging based on environment"""
-    
+
     # Base configuration that applies to all environments
     base_config = {
         "version": 1,
@@ -25,14 +22,12 @@ def configure_logging():
             "detailed": {
                 "format": "%(asctime)s - %(name)s - %(levelname)s - %(module)s:%(lineno)d - %(message)s"
             },
-            "simple": {
-                "format": "%(levelname)s - %(message)s"
-            },
+            "simple": {"format": "%(levelname)s - %(message)s"},
         },
         "handlers": {},
         "root": {},
     }
-    
+
     if settings.is_development:
         # Development: Log to console with INFO level, and errors to file
         base_config["handlers"] = {
@@ -49,19 +44,18 @@ def configure_logging():
                 "formatter": "detailed",
             },
         }
-        base_config["root"] = {
-            "level": "INFO",
-            "handlers": ["console", "file"]
-        }
-        
+        base_config["root"] = {"level": "INFO", "handlers": ["console", "file"]}
+
         # Set specific loggers to appropriate levels
         base_config["loggers"] = {
             "uvicorn": {"level": "INFO"},
             "uvicorn.access": {"level": "INFO"},
-            "sqlalchemy.engine": {"level": "INFO"},  # Use "WARNING" to avoid SQL query noise
+            "sqlalchemy.engine": {
+                "level": "INFO"
+            },  # Use "WARNING" to avoid SQL query noise
             "app": {"level": "DEBUG"},  # Your app logs at DEBUG level
         }
-        
+
     elif settings.is_testing:
         # Testing: Minimal logging to avoid test output noise
         base_config["handlers"] = {
@@ -72,11 +66,8 @@ def configure_logging():
                 "stream": "ext://sys.stdout",
             },
         }
-        base_config["root"] = {
-            "level": "WARNING",
-            "handlers": ["console"]
-        }
-        
+        base_config["root"] = {"level": "WARNING", "handlers": ["console"]}
+
     else:  # Production
         # Production: Only errors to file, warnings and above to console
         base_config["handlers"] = {
@@ -93,23 +84,22 @@ def configure_logging():
                 "formatter": "detailed",
             },
         }
-        base_config["root"] = {
-            "level": "WARNING",
-            "handlers": ["console", "file"]
-        }
-    
+        base_config["root"] = {"level": "WARNING", "handlers": ["console", "file"]}
+
     dictConfig(base_config)
 
 
-def initialize_firebase():
+def initialize_firebase() -> None:
     """Initialize Firebase Admin SDK"""
     firebase_admin.initialize_app(
         firebase_admin.credentials.Certificate(
             {
                 "type": "service_account",
                 "project_id": settings.firebase_project_id,
                 "private_key_id": settings.firebase_svc_account_private_key_id,
-                "private_key": settings.firebase_svc_account_private_key.replace("\\n", "\n"),
+                "private_key": settings.firebase_svc_account_private_key.replace(
+                    "\\n", "\n"
+                ),
                 "client_email": settings.firebase_svc_account_client_email,
                 "client_id": settings.firebase_svc_account_client_id,
                 "auth_uri": settings.firebase_svc_account_auth_uri,
@@ -122,23 +112,23 @@ def initialize_firebase():
 
 
 @asynccontextmanager
-async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
+async def lifespan(_app: FastAPI) -> AsyncGenerator[None, None]:
     """Application lifespan management"""
     # Startup
     configure_logging()
     initialize_firebase()
     init_models()
-    
+
     yield
-    
+
     # Shutdown
     # Add any cleanup code here if needed
     pass
 
 
 def create_app() -> FastAPI:
     """Create and configure FastAPI application"""
-    
+
     app = FastAPI(
         title="Food4Kids API",
         description="Backend API for the Food4Kids application",
@@ -151,11 +141,13 @@ def create_app() -> FastAPI:
     # Configure CORS
     cors_origins = settings.cors_origins.copy()
     if settings.is_development:
-        cors_origins.extend([
-            "http://localhost:3000",
-            "http://127.0.0.1:3000",
-        ])
-    
+        cors_origins.extend(
+            [
+                "http://localhost:3000",
+                "http://127.0.0.1:3000",
+            ]
+        )
+
     # Add regex pattern for preview deployments
     cors_origins.append("https://uw-blueprint-starter-code--pr.*\\.web\\.app")