Bump FastAPI to 0.89.0

This adds support for function return type annotations to declare the response_model

Author: ChrisLovering

api/routers/codejams.py

@@ -12,8 +12,8 @@
 router = APIRouter(prefix="/codejams", tags=["codejams"])
 
 
-@router.get("/", response_model=list[CodeJamResponse])
-async def get_codejams(session: AsyncSession = Depends(get_db_session)) -> list[Jam]:
+@router.get("/")
+async def get_codejams(session: AsyncSession = Depends(get_db_session)) -> list[CodeJamResponse]:
     """Get all the codejams stored in the database."""
     codejams = await session.execute(select(Jam).order_by(desc(Jam.id)))
     codejams.unique()
@@ -23,10 +23,9 @@ async def get_codejams(session: AsyncSession = Depends(get_db_session)) -> list[
 
 @router.get(
     "/{codejam_id}",
-    response_model=CodeJamResponse,
     responses={404: {"description": "CodeJam could not be found or there is no ongoing code jam."}},
 )
-async def get_codejam(codejam_id: int, session: AsyncSession = Depends(get_db_session)) -> Jam:
+async def get_codejam(codejam_id: int, session: AsyncSession = Depends(get_db_session)) -> CodeJamResponse:
     """
     Get a specific codejam stored in the database by ID.
 
@@ -56,7 +55,7 @@ async def modify_codejam(
     name: Optional[str] = None,
     ongoing: Optional[bool] = None,
     session: AsyncSession = Depends(get_db_session),
-) -> None:
+) -> CodeJamResponse:
     """Modify the specified codejam to change its name and/or whether it's the ongoing code jam."""
     codejam = await session.execute(select(Jam).where(Jam.id == codejam_id))
     codejam.unique()
@@ -80,8 +79,8 @@ async def modify_codejam(
     return jam
 
 
-@router.post("/", response_model=CodeJamResponse)
-async def create_codejam(codejam: CodeJam, session: AsyncSession = Depends(get_db_session)) -> Jam:
+@router.post("/")
+async def create_codejam(codejam: CodeJam, session: AsyncSession = Depends(get_db_session)) -> CodeJamResponse:
     """
     Create a new codejam and get back the one just created.
 

api/routers/infractions.py

@@ -10,8 +10,8 @@
 router = APIRouter(prefix="/infractions", tags=["infractions"])
 
 
-@router.get("/", response_model=list[InfractionResponse])
-async def get_infractions(session: AsyncSession = Depends(get_db_session)) -> list[DbInfraction]:
+@router.get("/")
+async def get_infractions(session: AsyncSession = Depends(get_db_session)) -> list[InfractionResponse]:
     """Get every infraction stored in the database."""
     infractions = await session.execute(select(DbInfraction))
     infractions.unique()
@@ -21,10 +21,9 @@ async def get_infractions(session: AsyncSession = Depends(get_db_session)) -> li
 
 @router.get(
     "/{infraction_id}",
-    response_model=InfractionResponse,
     responses={404: {"description": "Infraction could not be found."}},
 )
-async def get_infraction(infraction_id: int, session: AsyncSession = Depends(get_db_session)) -> DbInfraction:
+async def get_infraction(infraction_id: int, session: AsyncSession = Depends(get_db_session)) -> InfractionResponse:
     """Get a specific infraction stored in the database by ID."""
     infraction_result = await session.execute(select(DbInfraction).where(DbInfraction.id == infraction_id))
     infraction_result.unique()
@@ -36,9 +35,13 @@ async def get_infraction(infraction_id: int, session: AsyncSession = Depends(get
 
 
 @router.post(
-    "/", response_model=InfractionResponse, responses={404: {"Description": "Jam ID or User ID could not be found."}}
+    "/",
+    responses={404: {"Description": "Jam ID or User ID could not be found."}},
 )
-async def create_infraction(infraction: Infraction, session: AsyncSession = Depends(get_db_session)) -> DbInfraction:
+async def create_infraction(
+    infraction: Infraction,
+    session: AsyncSession = Depends(get_db_session),
+) -> InfractionResponse:
     """Add an infraction for a user to the database."""
     jam_id = (await session.execute(select(Jam.id).where(Jam.id == infraction.jam_id))).scalars().one_or_none()
 

api/routers/teams.py

@@ -35,8 +35,8 @@ async def ensure_user_exists(user_id: int, session: AsyncSession) -> DbUser:
     return user
 
 
-@router.get("/", response_model=list[TeamResponse])
-async def get_teams(current_jam: bool = False, session: AsyncSession = Depends(get_db_session)) -> list[Team]:
+@router.get("/")
+async def get_teams(current_jam: bool = False, session: AsyncSession = Depends(get_db_session)) -> list[TeamResponse]:
     """Get every code jam team in the database."""
     if not current_jam:
         teams = await session.execute(select(Team))
@@ -47,10 +47,10 @@ async def get_teams(current_jam: bool = False, session: AsyncSession = Depends(g
     return teams.scalars().all()
 
 
-@router.get("/find", response_model=TeamResponse, responses={404: {"description": "Team could not be found."}})
+@router.get("/find", responses={404: {"description": "Team could not be found."}})
 async def find_team_by_name(
     name: str, jam_id: Optional[int] = None, session: AsyncSession = Depends(get_db_session)
-) -> Team:
+) -> TeamResponse:
     """Get a specific code jam team by name."""
     if jam_id is None:
         teams = await session.execute(
@@ -69,14 +69,14 @@ async def find_team_by_name(
     return team
 
 
-@router.get("/{team_id}", response_model=TeamResponse, responses={404: {"description": "Team could not be found."}})
-async def get_team(team_id: int, session: AsyncSession = Depends(get_db_session)) -> Team:
+@router.get("/{team_id}", responses={404: {"description": "Team could not be found."}})
+async def get_team(team_id: int, session: AsyncSession = Depends(get_db_session)) -> TeamResponse:
     """Get a specific code jam team in the database by ID."""
     return await ensure_team_exists(team_id, session)
 
 
-@router.get("/{team_id}/users", response_model=list[User], responses={404: {"description": "Team could not be found."}})
-async def get_team_users(team_id: int, session: AsyncSession = Depends(get_db_session)) -> list[TeamUser]:
+@router.get("/{team_id}/users", responses={404: {"description": "Team could not be found."}})
+async def get_team_users(team_id: int, session: AsyncSession = Depends(get_db_session)) -> list[User]:
     """Get the users of a specific code jam team in the database."""
     await ensure_team_exists(team_id, session)
 
@@ -88,7 +88,6 @@ async def get_team_users(team_id: int, session: AsyncSession = Depends(get_db_se
 
 @router.post(
     "/{team_id}/users/{user_id}",
-    response_model=User,
     responses={
         404: {
             "description": "Team or user could not be found.",
@@ -98,7 +97,7 @@ async def get_team_users(team_id: int, session: AsyncSession = Depends(get_db_se
 )
 async def add_user_to_team(
     team_id: int, user_id: int, is_leader: bool = False, session: AsyncSession = Depends(get_db_session)
-) -> TeamUser:
+) -> User:
     """Add a user to a specific code jam team in the database."""
     await ensure_team_exists(team_id, session)
     await ensure_user_exists(user_id, session)

api/routers/users.py

@@ -47,17 +47,17 @@ async def get_user_data(session: AsyncSession, user_id: int) -> dict[str, Any]:
     return user
 
 
-@router.get("/", response_model=list[UserResponse])
-async def get_users(session: AsyncSession = Depends(get_db_session)) -> list[dict[str, Any]]:
+@router.get("/")
+async def get_users(session: AsyncSession = Depends(get_db_session)) -> list[UserResponse]:
     """Get information about all the users stored in the database."""
     users = await session.execute(select(User.id))
     users.unique()
 
     return [await get_user_data(session, user) for user in users.scalars().all()]
 
 
-@router.get("/{user_id}", response_model=UserResponse, responses={404: {"description": "User could not be found."}})
-async def get_user(user_id: int, session: AsyncSession = Depends(get_db_session)) -> dict[str, Any]:
+@router.get("/{user_id}", responses={404: {"description": "User could not be found."}})
+async def get_user(user_id: int, session: AsyncSession = Depends(get_db_session)) -> UserResponse:
     """Get a specific user stored in the database by ID."""
     user = await session.execute(select(User).where(User.id == user_id))
     user.unique()
@@ -68,8 +68,8 @@ async def get_user(user_id: int, session: AsyncSession = Depends(get_db_session)
     return await get_user_data(session, user_id)
 
 
-@router.post("/{user_id}", response_model=UserResponse, responses={400: {"description": "User already exists."}})
-async def create_user(user_id: int, session: AsyncSession = Depends(get_db_session)) -> dict[str, Any]:
+@router.post("/{user_id}", responses={400: {"description": "User already exists."}})
+async def create_user(user_id: int, session: AsyncSession = Depends(get_db_session)) -> UserResponse:
     """Create a new user with the specified ID to the database."""
     user = await session.execute(select(User).where(User.id == user_id))
     user.unique()
@@ -86,7 +86,6 @@ async def create_user(user_id: int, session: AsyncSession = Depends(get_db_sessi
 
 @router.get(
     "/{user_id}/current_team",
-    response_model=UserTeamResponse,
     responses={
         404: {
             "description": (
@@ -95,7 +94,7 @@ async def create_user(user_id: int, session: AsyncSession = Depends(get_db_sessi
         }
     },
 )
-async def get_current_team(user_id: int, session: AsyncSession = Depends(get_db_session)) -> dict[str, Any]:
+async def get_current_team(user_id: int, session: AsyncSession = Depends(get_db_session)) -> UserTeamResponse:
     """Get a user's current team information."""
     user = await session.execute(select(User).where(User.id == user_id))
     user.unique()

api/routers/winners.py

@@ -13,10 +13,9 @@
 
 @router.get(
     "/{jam_id}",
-    response_model=list[WinnerResponse],
     responses={404: {"description": "The specified codejam could not be found."}},
 )
-async def get_winners(jam_id: int, session: AsyncSession = Depends(get_db_session)) -> list[DbWinner]:
+async def get_winners(jam_id: int, session: AsyncSession = Depends(get_db_session)) -> list[WinnerResponse]:
     """Get the top ten winners from the specified codejam."""
     jam = await session.execute(select(Jam).where(Jam.id == jam_id))
     jam.unique()
@@ -31,7 +30,6 @@ async def get_winners(jam_id: int, session: AsyncSession = Depends(get_db_sessio
 
 @router.post(
     "/{jam_id}",
-    response_model=list[WinnerResponse],
     responses={
         400: {"description": "The provided winners list is empty or contains duplicate users."},
         404: {

main-requirements.txt

@@ -47,9 +47,9 @@ click==8.1.3 ; python_full_version >= "3.11.0" and python_full_version < "3.12.0
 colorama==0.4.6 ; python_full_version >= "3.11.0" and python_full_version < "3.12.0" and sys_platform == "win32" or python_full_version >= "3.11.0" and python_full_version < "3.12.0" and platform_system == "Windows" \
     --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
     --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
-fastapi==0.88.0 ; python_full_version >= "3.11.0" and python_full_version < "3.12.0" \
-    --hash=sha256:263b718bb384422fe3d042ffc9a0c8dece5e034ab6586ff034f6b4b1667c3eee \
-    --hash=sha256:915bf304180a0e7c5605ec81097b7d4cd8826ff87a02bb198e336fb9f3b5ff02
+fastapi==0.89.0 ; python_full_version >= "3.11.0" and python_full_version < "3.12.0" \
+    --hash=sha256:34990132751324c988db7bd15bf43a86f5c8580e58a4438e14b12d72fb0ae1d1 \
+    --hash=sha256:d8cafbd223b5a3c010119ba61fb246d5fd3b8f4766cfa93f922a416650797976
 greenlet==2.0.2 ; python_full_version >= "3.11.0" and platform_machine == "aarch64" and python_full_version < "3.12.0" or python_full_version >= "3.11.0" and platform_machine == "ppc64le" and python_full_version < "3.12.0" or python_full_version >= "3.11.0" and platform_machine == "x86_64" and python_full_version < "3.12.0" or python_full_version >= "3.11.0" and platform_machine == "amd64" and python_full_version < "3.12.0" or python_full_version >= "3.11.0" and platform_machine == "AMD64" and python_full_version < "3.12.0" or python_full_version >= "3.11.0" and platform_machine == "win32" and python_full_version < "3.12.0" or python_full_version >= "3.11.0" and platform_machine == "WIN32" and python_full_version < "3.12.0" \
     --hash=sha256:03a8f4f3430c3b3ff8d10a2a86028c660355ab637cee9333d63d66b56f09d52a \
     --hash=sha256:0bf60faf0bc2468089bdc5edd10555bab6e85152191df713e2ab1fcc86382b5a \

poetry.lock

@@ -9,7 +9,7 @@ license = "MIT"
 python = "3.11.*"
 
 alembic = {version = "1.10.2", extras = ["tz"]}
-fastapi = "0.88.0"
+fastapi = "0.89.0"
 python-decouple = "3.8"
 SQLAlchemy = {version = "1.4.45", extras = ["asyncio", "postgresql_asyncpg"]}
 uvicorn = {version = "0.21.1", extras = ["standard"]}