Convert to CIVData on ComponentInterfaceValuePostSerializer

Author: koopmant

app/grandchallenge/algorithms/serializers.py

@@ -25,7 +25,6 @@
 from grandchallenge.components.backends.exceptions import (
     CIVNotEditableException,
 )
-from grandchallenge.components.models import CIVData
 from grandchallenge.components.serializers import (
     ComponentInterfaceSerializer,
     ComponentInterfaceValuePostSerializer,
@@ -236,11 +235,10 @@ def validate(self, data):
                 "please try again after they have completed"
             )
 
-        inputs = data.pop("inputs")
+        self.inputs = data.pop("inputs")
         data["algorithm_interface"] = (
-            self.validate_inputs_and_return_matching_interface(inputs=inputs)
+            self.validate_inputs_and_return_matching_interface()
         )
-        self.inputs = self.reformat_inputs(serialized_civs=inputs)
 
         if Job.objects.get_jobs_with_same_inputs(
             inputs=self.inputs,
@@ -284,12 +282,12 @@ def create(self, validated_data):
 
         return job
 
-    def validate_inputs_and_return_matching_interface(self, *, inputs):
+    def validate_inputs_and_return_matching_interface(self):
         """
         Validates that the provided inputs match one of the configured interfaces of
         the algorithm and returns that AlgorithmInterface
         """
-        provided_inputs = {i["interface"] for i in inputs}
+        provided_inputs = {civ_data.socket for civ_data in self.inputs}
         annotated_qs = annotate_input_output_counts(
             self._algorithm.interfaces, inputs=provided_inputs
         )
@@ -306,42 +304,3 @@ def validate_inputs_and_return_matching_interface(self, *, inputs):
                 f"following input combinations: "
                 f"{oxford_comma([f'Interface {n}: {oxford_comma(interface.inputs.all())}' for n, interface in enumerate(self._algorithm.interfaces.all(), start=1)])}"
             )
-
-    @staticmethod
-    def reformat_inputs(*, serialized_civs):
-        """Takes serialized CIV data and returns list of CIVData objects."""
-        possible_keys = [
-            "image",
-            "value",
-            "file",
-            "user_upload",
-            "upload_session",
-        ]
-
-        data = []
-        for civ in serialized_civs:
-            found_keys = [
-                key for key in possible_keys if civ.get(key) is not None
-            ]
-
-            if not found_keys:
-                raise serializers.ValidationError(
-                    f"You must provide at least one of {possible_keys}"
-                )
-
-            if len(found_keys) > 1:
-                raise serializers.ValidationError(
-                    f"You can only provide one of {possible_keys} for each interface."
-                )
-
-            try:
-                data.append(
-                    CIVData(
-                        interface_slug=civ["interface"].slug,
-                        value=civ[found_keys[0]],
-                    )
-                )
-            except ValidationError as e:
-                raise serializers.ValidationError(e)
-
-        return data

app/grandchallenge/components/forms.py

@@ -149,12 +149,9 @@ def clean(self):
         for key, value in cleaned_data.items():
             if key.startswith(INTERFACE_FORM_FIELD_PREFIX):
                 keys_to_remove.append(key)
-                inputs.append(
-                    CIVData(
-                        interface_slug=key[len(INTERFACE_FORM_FIELD_PREFIX) :],
-                        value=value,
-                    )
-                )
+                interface_slug = key[len(INTERFACE_FORM_FIELD_PREFIX) :]
+                socket = ComponentInterface.objects.get(slug=interface_slug)
+                inputs.append(CIVData(socket=socket, value=value))
 
         for key in keys_to_remove:
             cleaned_data.pop(key)
@@ -265,12 +262,9 @@ def process_object_data(self):
         civ_data_objects = []
         for key, value in self.cleaned_data.items():
             if key.startswith(INTERFACE_FORM_FIELD_PREFIX):
-                civ_data_objects.append(
-                    CIVData(
-                        interface_slug=key[len(INTERFACE_FORM_FIELD_PREFIX) :],
-                        value=value,
-                    )
-                )
+                interface_slug = key[len(INTERFACE_FORM_FIELD_PREFIX) :]
+                socket = ComponentInterface.objects.get(slug=interface_slug)
+                civ_data_objects.append(CIVData(socket=socket, value=value))
 
         try:
             self.instance.validate_civ_data_objects_and_execute_linked_task(

app/grandchallenge/components/models.py

@@ -1559,7 +1559,7 @@ def retrieve_existing_civs(*, civ_data_objects):
             elif civ_data.image:
                 try:
                     civs = ComponentInterfaceValue.objects.filter(
-                        interface__slug=civ_data.interface_slug,
+                        interface=civ_data.socket,
                         image=civ_data.image,
                     ).all()
                     existing_civs.extend(civs)
@@ -1571,7 +1571,7 @@ def retrieve_existing_civs(*, civ_data_objects):
                 # values can be of different types, including None and False
                 try:
                     civs = ComponentInterfaceValue.objects.filter(
-                        interface__slug=civ_data.interface_slug,
+                        interface=civ_data.socket,
                         value=civ_data.value,
                     ).all()
                     existing_civs.extend(civs)
@@ -2263,8 +2263,8 @@ def update_size_in_storage(self):
 class CIVData:
 
     @property
-    def interface_slug(self):
-        return self._interface_slug
+    def socket(self):
+        return self._socket
 
     @property
     def value(self):
@@ -2295,13 +2295,15 @@ def dicom_upload_with_name(self):
         return self._dicom_upload_with_name
 
     def __repr__(self):
-        return f"CIVData(interface_slug={self._interface_slug!r}, value={self._initial_value!r})"
+        return (
+            f"CIVData(socket={self._socket!r}, value={self._initial_value!r})"
+        )
 
     def __str__(self):
         return f"CIVData: {self.__dict__}"
 
-    def __init__(self, *, interface_slug, value):
-        self._interface_slug = interface_slug
+    def __init__(self, *, socket, value):
+        self._socket = socket
         self._initial_value = value
         self._json_value = None
         self._image = None
@@ -2311,17 +2313,15 @@ def __init__(self, *, interface_slug, value):
         self._file_civ = None
         self._dicom_upload_with_name = None
 
-        ci = ComponentInterface.objects.get(slug=interface_slug)
-
-        if ci.super_kind == ci.SuperKind.VALUE:
+        if socket.super_kind == socket.SuperKind.VALUE:
             self._init_json_civ_data()
-        elif ci.super_kind == ci.SuperKind.IMAGE:
+        elif socket.super_kind == socket.SuperKind.IMAGE:
             self._init_image_civ_data()
-        elif ci.super_kind == ci.SuperKind.FILE:
+        elif socket.super_kind == socket.SuperKind.FILE:
             self._init_file_civ_data()
         else:
             raise NotImplementedError(
-                f"Unknown interface super kind: {ci.super_kind}"
+                f"Unknown interface super kind: {socket.super_kind}"
             )
 
         self.validate()
@@ -2334,7 +2334,7 @@ def _init_json_civ_data(self):
             self._json_value = self._initial_value
         else:
             raise ValidationError(
-                f"Unknown data type {type(self._initial_value)} for interface {self._interface_slug}"
+                f"Unknown data type {type(self._initial_value)} for interface {self._socket}"
             )
 
     def _init_image_civ_data(self):
@@ -2352,7 +2352,7 @@ def _init_image_civ_data(self):
             self._image = None
         else:
             raise ValidationError(
-                f"Unknown data type {type(self._initial_value)} for interface {self._interface_slug}"
+                f"Unknown data type {type(self._initial_value)} for interface {self._socket}"
             )
 
     def _init_file_civ_data(self):
@@ -2364,7 +2364,7 @@ def _init_file_civ_data(self):
             self._file_civ = None
         else:
             raise ValidationError(
-                f"Unknown data type {type(self._initial_value)} for interface {self._interface_slug}"
+                f"Unknown data type {type(self._initial_value)} for interface {self._socket}"
             )
 
     def validate(self):
@@ -2464,17 +2464,17 @@ def _update_civ(self, *, civ_data, user=None, linked_task=None):
 
         try:
             if (
-                civ_data.interface_slug
+                civ_data.socket.slug
                 not in self.base_object.allowed_socket_slugs
             ):
                 raise CINotAllowedException(
-                    f"Socket {civ_data.interface_slug!r} is not allowed "
+                    f"Socket {civ_data.socket!r} is not allowed "
                     f"for this {self.base_object._meta.model_name}."
                 )
         except AttributeError:
             pass
 
-        ci = ComponentInterface.objects.get(slug=civ_data.interface_slug)
+        ci = civ_data.socket
         current_civ = self.get_current_value_for_interface(
             interface=ci, user=user
         )