Extract 404 error from service layer

Author: koldakov

futuramaapi/apps/fastapi.py

@@ -99,13 +99,21 @@ def _setup_static(self) -> None:
         )
 
     def _exception_handler(self, _: Request, exc) -> Response:
-        from futuramaapi.routers.services import ServiceError, UnauthorizedError  # noqa: PLC0415
+        from futuramaapi.routers.services import (  # noqa: PLC0415
+            NotFoundError,
+            ServiceError,
+            UnauthorizedError,
+        )
 
         exception_to_value: dict[type[ServiceError], _ExceptionValue] = {
             UnauthorizedError: _ExceptionValue(
                 status_code=status.HTTP_401_UNAUTHORIZED,
                 default_message="Unauthorized",
             ),
+            NotFoundError: _ExceptionValue(
+                status_code=status.HTTP_404_NOT_FOUND,
+                default_message="Not Found",
+            ),
         }
 
         exc_value = exception_to_value[type(exc)]

futuramaapi/routers/services/__init__.py

@@ -2,6 +2,7 @@
     BaseService,
     BaseSessionService,
     BaseUserAuthenticatedService,
+    NotFoundError,
     ServiceError,
     UnauthorizedError,
 )
@@ -12,6 +13,7 @@
     "BaseSessionService",
     "BaseTemplateService",
     "BaseUserAuthenticatedService",
+    "NotFoundError",
     "ServiceError",
     "UnauthorizedError",
 ]

futuramaapi/routers/services/_base.py

@@ -28,6 +28,10 @@ class UnauthorizedError(ServiceError):
     """Unauthorized Error."""
 
 
+class NotFoundError(ServiceError):
+    """Not Found Error."""
+
+
 class BaseService[TResponse](BaseModel, ABC):
     context: dict[str, Any] | None = None
 

futuramaapi/routers/services/characters/get_character.py

@@ -1,6 +1,5 @@
 from datetime import datetime
 
-from fastapi import HTTPException, status
 from fastapi_storages import StorageImage
 from pydantic import HttpUrl, field_validator
 from sqlalchemy import Select, select
@@ -9,7 +8,7 @@
 from futuramaapi.core import settings
 from futuramaapi.helpers.pydantic import BaseModel
 from futuramaapi.repositories.models import CharacterModel
-from futuramaapi.routers.services import BaseSessionService
+from futuramaapi.routers.services import BaseSessionService, NotFoundError
 
 
 class GetCharacterResponse(BaseModel):
@@ -42,6 +41,6 @@ async def process(self, *args, **kwargs) -> GetCharacterResponse:
         try:
             result: CharacterModel = (await self.session.execute(self.statement)).scalars().one()
         except NoResultFound:
-            raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Character not found") from None
+            raise NotFoundError("Character not found") from None
 
         return GetCharacterResponse.model_validate(result)

futuramaapi/routers/services/crypto/get_secret_message.py

@@ -2,14 +2,14 @@
 from dataclasses import dataclass
 from typing import ClassVar
 
-from fastapi import HTTPException, Request, status
+from fastapi import Request
 from pydantic import field_serializer
 from sqlalchemy import Row, RowMapping, Select, case, select, update
 from sqlalchemy.exc import NoResultFound
 
 from futuramaapi.helpers.pydantic import BaseModel
 from futuramaapi.repositories.models import SecretMessageModel
-from futuramaapi.routers.services import BaseSessionService
+from futuramaapi.routers.services import BaseSessionService, NotFoundError
 
 
 class GetSecretMessageResponse(BaseModel):
@@ -316,10 +316,7 @@ async def process(
         try:
             row: Row[tuple[SecretMessageRow]] = (await self.session.execute(self._get_statement(request))).one()
         except NoResultFound:
-            raise HTTPException(
-                status_code=status.HTTP_404_NOT_FOUND,
-                detail="Not Found",
-            ) from None
+            raise NotFoundError() from None
 
         await self.session.commit()
 

futuramaapi/routers/services/episodes/get_episode.py

@@ -1,14 +1,13 @@
 from datetime import date, datetime
 
-from fastapi import HTTPException, status
 from pydantic import Field, computed_field
 from sqlalchemy import Select, select
 from sqlalchemy.exc import NoResultFound
 from sqlalchemy.orm import selectinload
 
 from futuramaapi.helpers.pydantic import BaseModel
 from futuramaapi.repositories.models import EpisodeModel
-from futuramaapi.routers.services import BaseSessionService
+from futuramaapi.routers.services import BaseSessionService, NotFoundError
 
 
 class GetEpisodeResponse(BaseModel):
@@ -53,9 +52,6 @@ async def process(self, *args, **kwargs) -> GetEpisodeResponse:
         try:
             season_model: EpisodeModel = (await self.session.execute(self.statement)).scalars().one()
         except NoResultFound:
-            raise HTTPException(
-                detail="Episode not found",
-                status_code=status.HTTP_404_NOT_FOUND,
-            ) from None
+            raise NotFoundError("Episode not found") from None
 
         return GetEpisodeResponse.model_validate(season_model)

futuramaapi/routers/services/favorites/create_favorite_character.py

@@ -4,7 +4,7 @@
 from sqlalchemy.exc import IntegrityError
 
 from futuramaapi.repositories.models import CharacterModel, FavoriteCharacterModel
-from futuramaapi.routers.services import BaseUserAuthenticatedService
+from futuramaapi.routers.services import BaseUserAuthenticatedService, NotFoundError
 
 
 class CreateFavoriteCharacterService(BaseUserAuthenticatedService[None]):
@@ -33,9 +33,6 @@ async def process(self) -> None:
             raise
 
         if result.rowcount == 0:
-            raise HTTPException(
-                status_code=status.HTTP_404_NOT_FOUND,
-                detail="Character not found",
-            )
+            raise NotFoundError("Character not found")
 
         await self.session.commit()

futuramaapi/routers/services/favorites/delete_favorite_character.py

@@ -1,8 +1,7 @@
-from fastapi import HTTPException, status
 from sqlalchemy import Delete, Result, delete, select
 
 from futuramaapi.repositories.models import CharacterModel, FavoriteCharacterModel
-from futuramaapi.routers.services import BaseUserAuthenticatedService
+from futuramaapi.routers.services import BaseUserAuthenticatedService, NotFoundError
 
 
 class DeleteFavoriteCharacterService(BaseUserAuthenticatedService[None]):
@@ -19,9 +18,6 @@ def _statement(self) -> Delete[tuple[FavoriteCharacterModel, CharacterModel]]:
     async def process(self, *args, **kwargs) -> None:
         result: Result[tuple[FavoriteCharacterModel]] = await self.session.execute(self._statement)
         if result.rowcount == 0:
-            raise HTTPException(
-                status_code=status.HTTP_404_NOT_FOUND,
-                detail="Character not found or not in favorites",
-            )
+            raise NotFoundError("Character not found or not in favorites")
 
         await self.session.commit()

futuramaapi/routers/services/links/get_link.py

@@ -1,15 +1,14 @@
 from datetime import datetime
 from typing import ClassVar
 
-from fastapi import HTTPException, status
 from pydantic import Field, HttpUrl, computed_field
 from sqlalchemy import Result, Select, select
 from sqlalchemy.exc import NoResultFound
 
 from futuramaapi.core import settings
 from futuramaapi.helpers.pydantic import BaseModel
 from futuramaapi.repositories.models import LinkModel
-from futuramaapi.routers.services import BaseUserAuthenticatedService
+from futuramaapi.routers.services import BaseUserAuthenticatedService, NotFoundError
 
 
 class GetLinkResponse(BaseModel):
@@ -52,9 +51,6 @@ async def process(self, *args, **kwargs) -> GetLinkResponse:
         try:
             link: LinkModel = result.scalars().one()
         except NoResultFound:
-            raise HTTPException(
-                status_code=status.HTTP_404_NOT_FOUND,
-                detail="Link not found.",
-            ) from None
+            raise NotFoundError("Link not found") from None
 
         return GetLinkResponse.model_validate(link)

futuramaapi/routers/services/links/redirect_link.py

@@ -1,10 +1,9 @@
-from fastapi import HTTPException, status
 from fastapi.responses import RedirectResponse
 from sqlalchemy import Result, Select, select
 from sqlalchemy.exc import NoResultFound
 
 from futuramaapi.repositories.models import LinkModel
-from futuramaapi.routers.services import BaseSessionService
+from futuramaapi.routers.services import BaseSessionService, NotFoundError
 
 
 class RedirectLinkService(BaseSessionService[RedirectResponse]):
@@ -19,10 +18,7 @@ async def process(self, *args, **kwargs) -> RedirectResponse:
         try:
             link: LinkModel = result.scalars().one()
         except NoResultFound:
-            raise HTTPException(
-                status_code=status.HTTP_404_NOT_FOUND,
-                detail="Link not found.",
-            ) from None
+            raise NotFoundError("Link not found") from None
 
         link.counter += 1
         await self.session.commit()