Remove custom field type #74

Author: joelvdavies

inventory_management_system_api/models/custom_object_id_data_types.py

@@ -2,8 +2,7 @@
 Module for defining custom `ObjectId` data type classes used by Pydantic models.
 """
 
-from dataclasses import dataclass
-from typing import Any, Optional
+from typing import Any
 
 from bson import ObjectId
 from pydantic import GetCoreSchemaHandler
@@ -33,29 +32,6 @@ def validate(cls, value: str, _: core_schema.ValidationInfo) -> CustomObjectId:
         return CustomObjectId(value)
 
 
-@dataclass(frozen=True)
-class CustomObjectIdFieldType:
-    """
-    Custom data type for handling MongoDB ObjectId validation.
-    """
-
-    entity_type: Optional[str] = None
-    not_found_if_invalid: bool = False
-
-    def __get_pydantic_core_schema__(self, _source_type: Any, _handler: GetCoreSchemaHandler) -> CoreSchema:
-        return core_schema.with_info_plain_validator_function(self.validate)
-
-    def validate(self, value: str, _: core_schema.ValidationInfo) -> CustomObjectId:
-        """
-        Validate if the string value is a valid `ObjectId`.
-
-        :param value: The string value to be validated.
-        :param _: Unused
-        :return: The validated `ObjectId`.
-        """
-        return CustomObjectId(value, entity_type=self.entity_type, not_found_if_invalid=self.not_found_if_invalid)
-
-
 class StringObjectIdField(str):
     """
     Custom data type for handling MongoDB ObjectId as string.

inventory_management_system_api/models/system.py

@@ -2,28 +2,20 @@
 Module for defining the database models for representing systems.
 """
 
-from typing import Annotated, Optional
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from inventory_management_system_api.core.custom_object_id import CustomObjectId
-from inventory_management_system_api.models.custom_object_id_data_types import (
-    CustomObjectIdFieldType,
-    StringObjectIdField,
-)
+from inventory_management_system_api.models.custom_object_id_data_types import CustomObjectIdField, StringObjectIdField
 from inventory_management_system_api.models.mixins import CreatedModifiedTimeInMixin, CreatedModifiedTimeOutMixin
 
-ParentSystemIdType = Annotated[
-    CustomObjectId, CustomObjectIdFieldType(entity_type="parent system", not_found_if_invalid=False)
-]
-
 
 class SystemBase(BaseModel):
     """
     Base database model for a system
     """
 
-    parent_id: Optional[ParentSystemIdType] = None
+    parent_id: Optional[CustomObjectIdField] = None
     name: str
     description: Optional[str] = None
     location: Optional[str] = None

inventory_management_system_api/services/system.py

@@ -8,6 +8,7 @@
 from fastapi import Depends
 
 from inventory_management_system_api.core.config import config
+from inventory_management_system_api.core.custom_object_id import CustomObjectId
 from inventory_management_system_api.core.exceptions import ChildElementsExistError
 from inventory_management_system_api.core.object_storage_api_client import ObjectStorageAPIClient
 from inventory_management_system_api.models.system import SystemIn, SystemOut
@@ -39,12 +40,16 @@ def create(self, system: SystemPostSchema) -> SystemOut:
         :param system: System to be created
         :return: Created system
         """
-        parent_id = system.parent_id
+
+        # Check here so can raise appropriate error (alternative methods would be to have a custom type in
+        # SystemIn or move the parent_id check to the service)
+        if system.parent_id is not None:
+            CustomObjectId(system.parent_id, entity_type="parent system")
 
         code = utils.generate_code(system.name, "system")
         return self._system_repository.create(
             SystemIn(
-                parent_id=parent_id,
+                parent_id=system.parent_id,
                 description=system.description,
                 name=system.name,
                 location=system.location,
@@ -94,6 +99,11 @@ def update(self, system_id: str, system: SystemPatchSchema) -> SystemOut:
 
         update_data = system.model_dump(exclude_unset=True)
 
+        # Check here so can raise appropriate error (alternative methods would be to have a custom type in
+        # SystemIn or move the parent_id check to the service)
+        if "parent_id" in update_data and system.parent_id != stored_system.parent_id and system.parent_id is not None:
+            CustomObjectId(system.parent_id, entity_type="parent system")
+
         if "name" in update_data and system.name != stored_system.name:
             update_data["code"] = utils.generate_code(system.name, "system")