Clean up of unnecessary excepts #176

Author: joelvdavies

object_storage_api/core/custom_object_id.py

@@ -20,17 +20,29 @@ class CustomObjectId(ObjectId):
     purpose of handling MongoDB `_id` fields that are of type `ObjectId`.
     """
 
-    def __init__(self, value: str, entity_type: Optional[str] = None, not_found_if_invalid: bool = False):
+    def __init__(
+        self,
+        value: str,
+        entity_type: Optional[str] = None,
+        not_found_if_invalid: bool = False,
+        response_detail: Optional[str] = None,
+    ):
         """
         Construct a `CustomObjectId` from a string.
 
         :param value: The string value to be validated, representing the `ObjectId`.
         :param entity_type: Name of the entity type e.g. catalogue categories/systems (Used for logging).
         :param not_found_if_invalid: Whether an error due to an invalid ID should be raised as a not found error
-                                     or not. Unprocessable entity is used if left as the default  value False.
+                                     or not. Unprocessable entity is used if left as the default value False.
+        :param response_detail: Response detail to return in the the request if uncaught, overrides any error message
+                                constructed by the other parameters.
         :raises InvalidObjectIdError: If the string value is an invalid `ObjectId`.
         """
-        response_detail = None if entity_type is None else f"{entity_type.capitalize()} not found"
+        response_detail = (
+            response_detail
+            if response_detail is not None
+            else (None if entity_type is None else f"{entity_type.capitalize()} not found")
+        )
         status_code = status.HTTP_404_NOT_FOUND if not_found_if_invalid else None
 
         if not isinstance(value, str):

object_storage_api/repositories/attachment.py

@@ -62,16 +62,10 @@ def get(self, attachment_id: str, session: Optional[ClientSession] = None) -> Op
         """
 
         logger.info("Retrieving attachment with ID: %s from the database", attachment_id)
-
-        try:
-            attachment = self._attachments_collection.find_one(
-                {"_id": CustomObjectId(attachment_id, entity_type="attachment", not_found_if_invalid=True)},
-                session=session,
-            )
-        except InvalidObjectIdError as exc:
-            exc.status_code = 404
-            exc.response_detail = "Attachment not found"
-            raise exc
+        attachment = self._attachments_collection.find_one(
+            {"_id": CustomObjectId(attachment_id, entity_type="attachment", not_found_if_invalid=True)},
+            session=session,
+        )
 
         if attachment:
             return AttachmentOut(**attachment)

object_storage_api/repositories/image.py

@@ -60,14 +60,10 @@ def get(self, image_id: str, session: Optional[ClientSession] = None) -> ImageOu
         :raises InvalidObjectIdError: If the supplied `image_id` is invalid.
         """
         logger.info("Retrieving image with ID: %s from the database", image_id)
-        try:
-            image = self._images_collection.find_one(
-                {"_id": CustomObjectId(image_id, entity_type="image", not_found_if_invalid=True)}, session=session
-            )
-        except InvalidObjectIdError as exc:
-            exc.status_code = 404
-            exc.response_detail = "Image not found"
-            raise exc
+        image = self._images_collection.find_one(
+            {"_id": CustomObjectId(image_id, entity_type="image", not_found_if_invalid=True)}, session=session
+        )
+
         if image:
             return ImageOut(**image)
         raise MissingRecordError(entity_id=image_id, entity_type="image")

object_storage_api/services/attachment.py

@@ -15,7 +15,6 @@
 from object_storage_api.core.custom_object_id import CustomObjectId
 from object_storage_api.core.exceptions import (
     FileTypeMismatchException,
-    InvalidObjectIdError,
     UnsupportedFileExtensionException,
     UploadLimitReachedError,
 )
@@ -63,12 +62,8 @@ def create(self, attachment: AttachmentPostSchema) -> AttachmentPostResponseSche
         :raises UnsupportedFileExtensionException: If the file extension of the attachment is not supported.
         :raises UploadLimitReachedError: If the upload limit has been reached.
         """
-        try:
-            CustomObjectId(attachment.entity_id)
-        except InvalidObjectIdError as exc:
-            # Provide more specific detail
-            exc.response_detail = "Invalid `entity_id` given"
-            raise exc
+        # Check the entity ID is valid
+        CustomObjectId(attachment.entity_id, response_detail="Invalid `entity_id` given")
 
         file_extension = Path(attachment.file_name).suffix
         if not file_extension or file_extension.lower() not in config.attachment.allowed_file_extensions:

object_storage_api/services/image.py

@@ -15,7 +15,6 @@
 from object_storage_api.core.custom_object_id import CustomObjectId
 from object_storage_api.core.exceptions import (
     FileTypeMismatchException,
-    InvalidObjectIdError,
     UnsupportedFileExtensionException,
     UploadLimitReachedError,
 )
@@ -65,12 +64,9 @@ def create(self, image_metadata: ImagePostMetadataSchema, upload_file: UploadFil
         :raises FileTypeMismatchException: If the extension and content type of the image do not match.
         :raises UploadLimitReachedError: If the upload limit has been reached.
         """
-        try:
-            CustomObjectId(image_metadata.entity_id)
-        except InvalidObjectIdError as exc:
-            # Provide more specific detail
-            exc.response_detail = "Invalid `entity_id` given"
-            raise exc
+
+        # Check the entity ID is valid
+        CustomObjectId(image_metadata.entity_id, response_detail="Invalid `entity_id` given")
 
         file_extension = Path(upload_file.filename).suffix
         if not file_extension or file_extension.lower() not in config.image.allowed_file_extensions: