refactor: fastapi response syntax moves to python typing REFS #57

as of fastapi 0.89 it supports using python typing to define response models, this
unifies the syntax with sqlalchemy 2.0 using python typing to define models and
makes our code look uniform across pydantic, sqlalchemy and fastapi

Author: devraj

src/labs/routers/auth/__init__.py

@@ -32,12 +32,11 @@
 @router.post(
   "/token",
   summary="Provides an endpoint for login via email and password",
-  response_model=Token,
 )
 async def login_for_auth_token(
   form_data: OAuth2PasswordRequestForm = Depends(),
   session: AsyncSession = Depends(get_async_session)
-):
+) -> Token:
   """ Attempt to authenticate a user and issue JWT token
   
   """
@@ -63,10 +62,10 @@ async def login_for_auth_token(
 @router.post(
   "/refresh",
   summary=""" Provides an endpoint for refreshing the JWT token""",
-  response_model=Token,
 )
 async def refresh_jwt_token(request: Request,
-  session: AsyncSession = Depends(get_async_session)):
+  session: AsyncSession = Depends(get_async_session)
+) -> Token:
   """ Provides a refresh token for the JWT session.
   """
   return {}
@@ -76,19 +75,20 @@ async def refresh_jwt_token(request: Request,
   "/logout",
   summary=""" Provides an endpoint for logging out the user""",
 )
-async def logout_user(session: AsyncSession = Depends(get_async_session)):
+async def logout_user(
+  session: AsyncSession = Depends(get_async_session)
+):
   """ Ends a users session
   
   """
   return {}
 
 @router.get(
   "/me",
-  response_model=UserResponse,
 )
 async def get_me(
   current_user: User = Depends(get_current_user)
-):
+) -> UserResponse:
   """Get the currently logged in user or myself
 
   This endpoint will return the currently logged in user or raise

src/labs/routers/auth/otp.py

@@ -14,12 +14,13 @@
 
 router = APIRouter(tags=["otp"])
 
-@router.post("/initiate/email",
-  response_model=OTPTriggerResponse,
+@router.post(
+    "/initiate/email",
 )
-async def initiate_otp_email(request: OTPTriggerEmailRequest, 
+async def initiate_otp_email(
+  request: OTPTriggerEmailRequest, 
   session: AsyncSession = Depends(get_async_session)
-):
+) -> OTPTriggerResponse:
   """ Attempt to authenticate a user and issue JWT token
 
     The user has provided us their email address and we will
@@ -40,12 +41,12 @@ async def initiate_otp_email(request: OTPTriggerEmailRequest,
   return OTPTriggerResponse(success=True)
 
 
-@router.post("/initiate/sms",
-  response_model=OTPTriggerResponse,
+@router.post(
+  "/initiate/sms",
 )
 async def initiate_otp_sms(request: OTPTriggerSMSRequest, 
   session: AsyncSession = Depends(get_async_session)
-):
+) -> OTPTriggerResponse:
   """ Attempt to authenticate a user and issue JWT token
 
     The user has provided a mobile number and we will text them
@@ -65,7 +66,8 @@ async def initiate_otp_sms(request: OTPTriggerSMSRequest,
   return OTPTriggerResponse(success=True)
 
 @router.post("/verify")
-async def verify_otp(request: OTPVerifyRequest, 
+async def verify_otp(
+  request: OTPVerifyRequest, 
   session: AsyncSession = Depends(get_async_session)
 ):
   """ Attempt to authenticate a user and issue JWT token

src/labs/routers/ext/__init__.py

@@ -6,7 +6,6 @@
 
 from ...db import get_async_session
 from ...schema import HealthCheckResponse
-from ...config import config
 
 router = APIRouter(tags=["ext"])
 
@@ -21,11 +20,10 @@ async def echo():
 
 @router.get(
     "/healthcheck",
-    response_model=HealthCheckResponse
 )
 async def get_health(
     session: AsyncSession = Depends(get_async_session)
-):
+) -> HealthCheckResponse:
     """Check the health of the server.
 
     Purpose of this endpoint is to check the health of the server.

src/labs/routers/users/__init__.py

@@ -4,9 +4,7 @@
 used to manage user accounts. For the template application this
 was built to test out the initial CRUD features.
 """
-from datetime import datetime
 from uuid import UUID
-from typing import List
 
 from fastapi import APIRouter, Depends,\
     HTTPException, Query, status
@@ -22,15 +20,14 @@
 @router.get(
     "", 
     summary="Query users between limits",
-    response_model=List[UserResponse],
     status_code=status.HTTP_200_OK
 )
 async def get_users_with_limits(
     offset: int = Query(0, ge=0),
     limit: int = Query(100, ge=1, le=100),
     session: AsyncSession = Depends(get_async_session),
     current_user: User = Depends(get_admin_user),
-):
+) -> list[UserResponse]:
     users = await User.get_all_in_range(
         session,
         offset=offset,
@@ -41,29 +38,27 @@ async def get_users_with_limits(
 @router.get(
     "/infinite", 
     summary="Get all users",
-    response_model=List[UserResponse],
     status_code=status.HTTP_200_OK
 )
 async def get_users(
     next_id: UUID = None,
     limit: int = 10,
     session: AsyncSession = Depends(get_async_session),
     current_user: User = Depends(get_admin_user),
-):
+) -> list[UserResponse]:
     pass
 
 
 @router.get(
     "/{id}", 
     summary="Get a particular user",
-    response_model=UserResponse,
     status_code=status.HTTP_200_OK
 )
 async def get_user_by_id(
     id: UUID,
     session: AsyncSession = Depends(get_async_session),
     current_user: User = Depends(get_admin_user),
-):
+) -> UserResponse:
     """ Get a user by their id 
     
     
@@ -134,14 +129,13 @@ async def update_user(
 @router.post(
     "", 
     summary="Create a new user",
-    response_model=UserResponse,
     status_code=status.HTTP_201_CREATED,
 )
 async def create_user(
     user_request: UserRequest,
     session: AsyncSession = Depends(get_async_session),
     current_user: User = Depends(get_admin_user),
-):
+) -> UserResponse:
     """ Creates a new user based on
     
     """