Typing enhancements

Author: fede-pena

.devcontainer/devcontainer.json

@@ -23,9 +23,21 @@
 		"ghcr.io/devcontainers/features/python:1": {
 			"version": "3.13",
 			"installTools": true
+		},
+		"ghcr.io/devcontainers/features/git:1": {
+			"version": "latest"
 		}
 	},
 
+	// Forward SSH agent (more secure than mounting keys)
+	// This forwards your host's SSH agent to the container
+	"mounts": [
+		"source=${env:SSH_AUTH_SOCK},target=/ssh-agent,type=bind,consistency=cached"
+	],
+	"remoteEnv": {
+		"SSH_AUTH_SOCK": "/ssh-agent"
+	},
+
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	"forwardPorts": [8000],
 

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:poetry",
+    "python-envs.defaultPackageManager": "ms-python.python:poetry",
+    "python-envs.pythonProjects": []
+}

app/main.py

@@ -1,15 +1,13 @@
 """FastAPI application entry point."""
 
-from typing import Dict
-
 from fastapi import FastAPI
 
 from app.routers import todo_lists
 
 # Create FastAPI application instance
 app = FastAPI(
     title="TodoList API",
-    description="A simple Todo List API for Python/FastAPI candidates",
+    description="A simple Todo List API",
     version="1.0.0",
 )
 
@@ -18,7 +16,7 @@
 
 
 @app.get("/", tags=["health"])
-async def root() -> Dict[str, str]:
+async def root() -> dict[str, str]:
     """
     Health check endpoint.
 

app/routers/todo_lists.py

@@ -1,6 +1,6 @@
 """TodoList API router with CRUD endpoints."""
 
-from typing import Annotated, List
+from typing import Annotated
 
 from fastapi import APIRouter, Depends, HTTPException, status
 
@@ -10,10 +10,10 @@
 router = APIRouter(prefix="/api/todolists", tags=["todolists"])
 
 
-@router.get("", response_model=List[TodoList], status_code=status.HTTP_200_OK)
+@router.get("", response_model=list[TodoList], status_code=status.HTTP_200_OK)
 async def index(
     service: Annotated[TodoListService, Depends(get_todo_list_service)],
-) -> List[TodoList]:
+) -> list[TodoList]:
     """
     Get all todo lists.
 

app/services/todo_lists.py

@@ -1,6 +1,6 @@
 """TodoList service with in-memory storage."""
 
-from typing import List, Optional
+from typing import Optional
 
 from app.models import TodoList, TodoListCreate, TodoListUpdate
 
@@ -10,10 +10,10 @@ class TodoListService:
 
     def __init__(self) -> None:
         """Initialize the service with empty storage."""
-        self._storage: List[TodoList] = []
+        self._storage: list[TodoList] = []
         self._next_id: int = 1
 
-    def all(self) -> List[TodoList]:
+    def all(self) -> list[TodoList]:
         """
         Get all todo lists.
 

poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

tests/test_todo_lists.py

@@ -1,6 +1,6 @@
 """Unit tests for TodoList API endpoints."""
 
-from typing import Generator
+from collections.abc import Generator
 from unittest.mock import MagicMock
 
 import pytest
@@ -44,9 +44,7 @@ def client() -> TestClient:
 class TestIndex:
     """Tests for GET /api/todolists endpoint."""
 
-    def test_returns_all_todo_lists(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_returns_all_todo_lists(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that index returns all todo lists."""
         # Arrange
         expected_todos = [
@@ -86,9 +84,7 @@ def test_returns_empty_list_when_no_todos(
 class TestShow:
     """Tests for GET /api/todolists/{id} endpoint."""
 
-    def test_returns_todo_list_by_id(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_returns_todo_list_by_id(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that show returns a specific todo list."""
         # Arrange
         expected_todo = TodoList(id=1, name="Test list")
@@ -103,9 +99,7 @@ def test_returns_todo_list_by_id(
         assert response.json()["name"] == "Test list"
         mock_service.get.assert_called_once_with(1)
 
-    def test_returns_404_when_not_found(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_returns_404_when_not_found(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that show returns 404 when todo list doesn't exist."""
         # Arrange
         mock_service.get.return_value = None
@@ -122,9 +116,7 @@ def test_returns_404_when_not_found(
 class TestCreate:
     """Tests for POST /api/todolists endpoint."""
 
-    def test_creates_new_todo_list(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_creates_new_todo_list(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that create successfully creates a new todo list."""
         # Arrange
         created_todo = TodoList(id=1, name="New list")
@@ -139,9 +131,7 @@ def test_creates_new_todo_list(
         assert response.json()["name"] == "New list"
         mock_service.create.assert_called_once()
 
-    def test_validates_required_fields(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_validates_required_fields(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that create validates required fields."""
         # Act
         response = client.post("/api/todolists", json={})
@@ -150,9 +140,7 @@ def test_validates_required_fields(
         assert response.status_code == 422
         mock_service.create.assert_not_called()
 
-    def test_validates_name_not_empty(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_validates_name_not_empty(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that create validates name is not empty."""
         # Act
         response = client.post("/api/todolists", json={"name": ""})
@@ -165,9 +153,7 @@ def test_validates_name_not_empty(
 class TestUpdate:
     """Tests for PUT /api/todolists/{id} endpoint."""
 
-    def test_updates_existing_todo_list(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_updates_existing_todo_list(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that update successfully updates an existing todo list."""
         # Arrange
         updated_todo = TodoList(id=1, name="Updated list")
@@ -182,9 +168,7 @@ def test_updates_existing_todo_list(
         assert response.json()["name"] == "Updated list"
         mock_service.update.assert_called_once()
 
-    def test_returns_404_when_not_found(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_returns_404_when_not_found(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that update returns 404 when todo list doesn't exist."""
         # Arrange
         mock_service.update.return_value = None
@@ -197,9 +181,7 @@ def test_returns_404_when_not_found(
         assert "not found" in response.json()["detail"].lower()
         mock_service.update.assert_called_once()
 
-    def test_validates_required_fields(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_validates_required_fields(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that update validates required fields."""
         # Act
         response = client.put("/api/todolists/1", json={})
@@ -212,9 +194,7 @@ def test_validates_required_fields(
 class TestDelete:
     """Tests for DELETE /api/todolists/{id} endpoint."""
 
-    def test_deletes_existing_todo_list(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_deletes_existing_todo_list(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that delete successfully deletes an existing todo list."""
         # Arrange
         mock_service.delete.return_value = True
@@ -227,9 +207,7 @@ def test_deletes_existing_todo_list(
         assert response.content == b""
         mock_service.delete.assert_called_once_with(1)
 
-    def test_returns_404_when_not_found(
-        self, client: TestClient, mock_service: MagicMock
-    ) -> None:
+    def test_returns_404_when_not_found(self, client: TestClient, mock_service: MagicMock) -> None:
         """Test that delete returns 404 when todo list doesn't exist."""
         # Arrange
         mock_service.delete.return_value = False