Ticket #9493: formset-unique.6.diff

django/forms/models.py

@@ -395 +395 @@
                     form.save_m2m()
             self.save_m2m = save_m2m
         return self.save_existing_objects(commit) + self.save_new_objects(commit)
+    
+    def clean(self):
+        self.validate_unique()
+    
+    def validate_unique(self):
+        from django.db.models.fields import FieldDoesNotExist, Field as ModelField
+        unique_checks = []
+        for name, field in self.forms[0].fields.iteritems():
+            try:
+                f = self.forms[0].instance._meta.get_field_by_name(name)[0]
+            except FieldDoesNotExist:
+                continue
+            if not isinstance(f, ModelField):
+                continue
+            if f.unique:
+                unique_checks.append((name,))
+        unique_together = self.forms[0].instance._meta.unique_together
+        unique_together = [check for check in unique_together if [True for field in check if field in self.forms[0].fields]]
+        unique_checks.extend(unique_together)
+        
+        errors = []
+        for unique_check in unique_checks:
+            data = set()
+            for form in self.forms:
+                if not hasattr(form, 'cleaned_data'):
+                    continue
+                if [True for field in unique_check if field in form.cleaned_data and form.cleaned_data[field] is not None]:
+                    instance = tuple([form.cleaned_data[field] for field in unique_check])
+                    if instance in data:
+                        errors.append(self.get_unique_error_message(unique_check))
+                        break
+                    else:
+                        data.add(instance)
+        
+        if errors:
+            raise ValidationError(errors)
+    
+    def get_unique_error_message(self, unique_check):
+        if len(unique_check) == 1:
+            return _("You have entered duplicate data for %(field)s, all %(field)ss should be unique.") % {
+                    'field': unique_check[0],
+                }
+        else:
+            return _("You have entered duplicate data for %(field)s, %(field)s should be unique together.") % {
+                    'field': get_text_list(unique_check, _("and")),
+                }
 
     def save_existing_objects(self, commit=True):
         self.changed_objects = []
@@ -505 +551 @@
             form.fields[self._pk_field.name] = InlineForeignKeyField(self.instance, pk_field=True)
         else:
             form.fields[self.fk.name] = InlineForeignKeyField(self.instance, label=form.fields[self.fk.name].label)
+    
+    def get_unique_error_message(self, unique_check):
+        unique_check = [field for field in unique_check if field != self.fk.name]
+        return super(BaseInlineFormSet, self).get_unique_error_message(unique_check)
 
 def _get_foreign_key(parent_model, model, fk_name=None):
     """

docs/topics/forms/modelforms.txt

@@ -539 +539 @@
 ``formset.save()`` to save the data into the database. (This was described
 above, in :ref:`saving-objects-in-the-formset`.)
 
+
+Overiding ``clean()`` on a ``model_formset``
+--------------------------------------------
+
+Just like with ``ModelForms``, by default the ``clean()`` method of a 
+``model_formset`` will validate that none of the items in the formset validate 
+the unique constraints on your model(either unique or unique_together).  If you 
+want to overide the ``clean()`` method on a ``model_formset`` and maintain this 
+validation, you must call the parent classes ``clean`` method.
+
+
 Using a custom queryset
 ~~~~~~~~~~~~~~~~~~~~~~~
 

tests/modeltests/model_formsets/models.py

@@ -828 +828 @@
 >>> formset.get_queryset()
 [<Player: Bobby>]
 
+# Prevent duplicates from within the same formset
+>>> FormSet = modelformset_factory(Product, extra=2)
+>>> data = {
+...     'form-TOTAL_FORMS': 2,
+...     'form-INITIAL_FORMS': 0,
+...     'form-0-slug': 'red_car',
+...     'form-1-slug': 'red_car',
+... }
+>>> formset = FormSet(data)
+>>> formset.is_valid()
+False
+>>> formset._non_form_errors
+[u'You have entered duplicate data for slug, all slugs should be unique.']
+
+>>> FormSet = modelformset_factory(Price, extra=2)
+>>> data = {
+...     'form-TOTAL_FORMS': 2,
+...     'form-INITIAL_FORMS': 0,
+...     'form-0-price': '25',
+...     'form-0-quantity': '7',
+...     'form-1-price': '25',
+...     'form-1-quantity': '7',
+... }
+>>> formset = FormSet(data)
+>>> formset.is_valid()
+False
+>>> formset._non_form_errors
+[u'You have entered duplicate data for price and quantity, price and quantity should be unique together.']
 """}