Aligning the Annotation/SelectionForm

Author: mhkuu

annotations/forms.py

@@ -65,26 +65,26 @@ def __init__(self, *args, **kwargs):
             self.fields[key.symbol()] = field
 
         # hide the original field for labels.
-        # we still need this field defined in AnnotationForm.fields, otherwise
-        # the value set in AnnotationForm.clean() will not be used when submitting the form.
+        # we still need this field defined in fields of the Form, otherwise
+        # the value set in clean() will not be used when submitting the form.
         del self.fields['labels']
 
     def clean(self):
         cleaned_data = super(LabelFormMixin, self).clean()
 
-        # construct a value for Annotation.labels based on the individual label fields
+        # construct a value for Annotation/Fragment/PreProcessFragment.labels based on the individual label fields
         fields = [key.symbol() for key in self.corpus.label_keys.all()]
         cleaned_data['labels'] = [cleaned_data[field] for field in fields if cleaned_data[field]]
 
         return cleaned_data
 
     @property
-    def corpus(self):
-        return NotImplementedError
+    def corpus(self) -> Corpus:
+        raise NotImplementedError
 
     @property
-    def language(self):
-        return NotImplementedError
+    def language(self) -> Language:
+        raise NotImplementedError
 
 
 class SegmentSelectMixin(forms.Form):

selections/forms.py

@@ -1,18 +1,21 @@
 from django import forms
 
-from annotations.forms import AddFragmentsForm, LabelField, SegmentSelectMixin
+from annotations.forms import AddFragmentsForm, LabelFormMixin, SegmentSelectMixin
 
 from .management.commands.add_pre_fragments import process_file
 from .models import Selection, Word, Tense
 
 
-class SelectionForm(SegmentSelectMixin, forms.ModelForm):
-    already_complete = forms.BooleanField(label='All targets have already been selected in this fragment', required=False)
+class SelectionForm(LabelFormMixin, SegmentSelectMixin, forms.ModelForm):
+    already_complete = forms.BooleanField(
+        label='All targets have already been selected in this fragment', required=False)
 
     class Meta:
         model = Selection
         fields = [
-            'is_no_target', 'already_complete', 'tense', 'labels', 'comments', 'words',
+            'is_no_target', 'already_complete',
+            'tense', 'labels',
+            'comments', 'words',
             'select_segment'
         ]
         widgets = {
@@ -37,21 +40,6 @@ def __init__(self, *args, **kwargs):
         if not self.fragment.document.corpus.tense_based:
             del self.fields['tense']
 
-        language = self.fragment.language
-        # add a label field for each label key
-        for key in self.corpus.label_keys.all():
-            existing_label = self.instance.labels.filter(key=key).first() if self.instance.id else None
-            field = LabelField(label_key=key,
-                               language=language,
-                               initial=existing_label,
-                               required=False)
-            self.fields[key.symbol()] = field
-
-        # hide the original field for labels.
-        # we still need this field defined in AnnotationForm.fields, otherwise
-        # the value set in AnnotationForm.clean() will not be used when submitting the form.
-        del self.fields['labels']
-
         if not selected_words:
             del self.fields['already_complete']
 
@@ -62,6 +50,10 @@ def __init__(self, *args, **kwargs):
     def corpus(self):
         return self.fragment.document.corpus
 
+    @property
+    def language(self):
+        return self.fragment.language
+
     def clean(self):
         """
         Check for conditional requirements:
@@ -73,15 +65,6 @@ def clean(self):
             if not cleaned_data['words']:
                 self.add_error('is_no_target', 'Please select the words composing the target phrase.')
 
-            # construct a value for Annotation.labels based on the individual label fields
-            cleaned_data['labels'] = []
-            fields = [key.symbol() for key in self.corpus.label_keys.all()]
-            for field in fields:
-                if cleaned_data[field]:
-                    cleaned_data['labels'].append(cleaned_data[field])
-                else:
-                    self.add_error(field, 'Please choose a label.')
-
         return cleaned_data