Changeset 8756

Timestamp:

08/31/08 04:49:55 (3 months ago)

Author:

brosner

Message:

Fixed handling of primary keys in model formsets. Model formsets should now work nicely with custom primary keys that are OneToOneField?, ForeignKey? and AutoField?. Added tests to handle each of them.

Fixes #8241, #8694, #8695 and #8719.

Thanks Karen Tracey, jonloyens, sciyoshi, semenov and magneto for tracking down various parts of this patch.

Files:

• django/trunk/django/contrib/admin/helpers.py (modified) (1 diff)
• django/trunk/django/db/models/fields/related.py (modified) (1 diff)
• django/trunk/django/forms/models.py (modified) (7 diffs)
• django/trunk/tests/modeltests/model_formsets/models.py (modified) (4 diffs)
• django/trunk/tests/modeltests/model_forms/models.py (modified) (2 diffs)

django/trunk/django/contrib/admin/helpers.py

@@ -127 +127 @@
-
-    def pk_field(self):
-_
+.
-
-    def deletion_field(self):

django/trunk/django/db/models/fields/related.py

@@ -685 +685 @@
-    def contribute_to_related_class(self, cls, related):
-        setattr(cls, related.get_accessor_name(), ForeignRelatedObjectsDescriptor(related))
-
+
-    def formfield(self, **kwargs):
-        defaults = {'form_class': forms.ModelChoiceField, 'queryset': self.rel.to._default_manager.complex_filter(self.rel.limit_choices_to)}

django/trunk/django/forms/models.py

@@ -22 +22 @@
-
-def save_instance(form, instance, fields=None, fail_message='saved',
-
+, exclude=None
-    """
-    Saves bound Form ``form``'s cleaned_data into model instance ``instance``.
@@ -40 +40 @@
-            continue
-        if fields and f.name not in fields:
+            continue
+        if exclude and f.name in exclude:
-            continue
-        f.save_form_data(instance, cleaned_data[f.name])
@@ -116 +118 @@
-                # MultipleChoiceWidget needs a list of pks, not object instances.
-                data[f.name] = [obj.pk for obj in f.value_from_object(instance)]
-        elif isinstance(f, OneToOneField):
-            data[f.attname] = f.value_from_object(instance)
-        else:
-            data[f.name] = f.value_from_object(instance)
@@ -262 +262 @@
-    def save_new(self, form, commit=True):
-        """Saves and returns a new model instance for the given form."""
-
+exclude=[self._pk_field.name], 
-
-    def save_existing(self, form, instance, commit=True):
-        """Saves and returns an existing model instance for the given form."""
-
+exclude=[self._pk_field.name], 
-
-    def save(self, commit=True):
@@ -292 +292 @@
-        saved_instances = []
-        for form in self.initial_forms:
-model._meta.pk.att
+_pk_field.
-            if self.can_delete and form.cleaned_data[DELETION_FIELD_NAME]:
-                self.deleted_objects.append(obj)
@@ -320 +320 @@
-    def add_fields(self, form, index):
-        """Add a hidden field for the object's primary key."""
-
-
-
+
+
+
+
-        super(BaseModelFormSet, self).add_fields(form, index)
-
@@ -370 +371 @@
-        kwargs = {self.fk.get_attname(): self.instance.pk}
-        new_obj = self.model(**kwargs)
-
+
+
+
+
+
+
-
-def _get_foreign_key(parent_model, model, fk_name=None):

django/trunk/tests/modeltests/model_formsets/models.py

@@ -48 +48 @@
-
-class Owner(models.Model):
+    auto_id = models.AutoField(primary_key=True)
-    name = models.CharField(max_length=100)
-    place = models.ForeignKey(Place)
+    
+    def __unicode__(self):
+        return "%s at %s" % (self.name, self.place)
+
+class OwnerProfile(models.Model):
+    owner = models.OneToOneField(Owner, primary_key=True)
+    age = models.PositiveIntegerField()
+    
+    def __unicode__(self):
+        return "%s is %d" % (self.owner.name, self.age)
-
-class Restaurant(Place):
@@ -263 +274 @@
-...     print form.as_p()
-<p><label for="id_form-0-name">Name:</label> <input id="id_form-0-name" type="text" name="form-0-name" maxlength="100" /></p>
-_id" id="id_form-0-author_ptr_id
+" id="id_form-0-author_ptr
-
->>> data = {
-...     'form-TOTAL_FORMS': '1', # the number of forms rendered
-...     'form-INITIAL_FORMS': '0', # the number of forms with initial data
-_id
+
-...     'form-0-name': 'Ernest Hemingway',
-...     'form-0-write_speed': '10',
@@ -284 +295 @@
-...     print form.as_p()
-<p><label for="id_form-0-name">Name:</label> <input id="id_form-0-name" type="text" name="form-0-name" value="Ernest Hemingway" maxlength="100" /></p>
-_id" value="..." id="id_form-0-author_ptr_id
+" value="..." id="id_form-0-author_ptr
-<p><label for="id_form-1-name">Name:</label> <input id="id_form-1-name" type="text" name="form-1-name" maxlength="100" /></p>
-_id" id="id_form-1-author_ptr_id
+" id="id_form-1-author_ptr
-
->>> data = {
-...     'form-TOTAL_FORMS': '2', # the number of forms rendered
-...     'form-INITIAL_FORMS': '1', # the number of forms with initial data
-_id
+
-...     'form-0-name': 'Ernest Hemingway',
-...     'form-0-write_speed': '10',
-_id
+
-...     'form-1-name': '',
-...     'form-1-write_speed': '',
@@ -420 +431 @@
-<p><label for="id_form-0-some_field">Some field:</label> <input id="id_form-0-some_field" type="text" name="form-0-some_field" maxlength="100" /></p>
-
+# Custom primary keys with ForeignKey, OneToOneField and AutoField ############
+
+>>> place = Place(name=u'Giordanos', city=u'Chicago')
+>>> place.save()
+
+>>> FormSet = inlineformset_factory(Place, Owner, extra=2, can_delete=False)
+>>> formset = FormSet(instance=place)
+>>> for form in formset.forms:
+...     print form.as_p()
+<p><label for="id_owner_set-0-name">Name:</label> <input id="id_owner_set-0-name" type="text" name="owner_set-0-name" maxlength="100" /><input type="hidden" name="owner_set-0-auto_id" id="id_owner_set-0-auto_id" /></p>
+<p><label for="id_owner_set-1-name">Name:</label> <input id="id_owner_set-1-name" type="text" name="owner_set-1-name" maxlength="100" /><input type="hidden" name="owner_set-1-auto_id" id="id_owner_set-1-auto_id" /></p>
+
+>>> data = {
+...     'owner_set-TOTAL_FORMS': '2',
+...     'owner_set-INITIAL_FORMS': '0',
+...     'owner_set-0-auto_id': '',
+...     'owner_set-0-name': u'Joe Perry',
+...     'owner_set-1-auto_id': '',
+...     'owner_set-1-name': '',
+... }
+>>> formset = FormSet(data, instance=place)
+>>> formset.is_valid()
+True
+>>> formset.save()
+[<Owner: Joe Perry at Giordanos>]
+
+>>> formset = FormSet(instance=place)
+>>> for form in formset.forms:
+...     print form.as_p()
+<p><label for="id_owner_set-0-name">Name:</label> <input id="id_owner_set-0-name" type="text" name="owner_set-0-name" value="Joe Perry" maxlength="100" /><input type="hidden" name="owner_set-0-auto_id" value="1" id="id_owner_set-0-auto_id" /></p>
+<p><label for="id_owner_set-1-name">Name:</label> <input id="id_owner_set-1-name" type="text" name="owner_set-1-name" maxlength="100" /><input type="hidden" name="owner_set-1-auto_id" id="id_owner_set-1-auto_id" /></p>
+<p><label for="id_owner_set-2-name">Name:</label> <input id="id_owner_set-2-name" type="text" name="owner_set-2-name" maxlength="100" /><input type="hidden" name="owner_set-2-auto_id" id="id_owner_set-2-auto_id" /></p>
+
+>>> data = {
+...     'owner_set-TOTAL_FORMS': '3',
+...     'owner_set-INITIAL_FORMS': '1',
+...     'owner_set-0-auto_id': u'1',
+...     'owner_set-0-name': u'Joe Perry',
+...     'owner_set-1-auto_id': '',
+...     'owner_set-1-name': u'Jack Berry',
+...     'owner_set-2-auto_id': '',
+...     'owner_set-2-name': '',
+... }
+>>> formset = FormSet(data, instance=place)
+>>> formset.is_valid()
+True
+>>> formset.save()
+[<Owner: Jack Berry at Giordanos>]
+
+# Ensure a custom primary key that is a ForeignKey or OneToOneField get rendered for the user to choose.
+
+>>> FormSet = modelformset_factory(OwnerProfile)
+>>> formset = FormSet()
+>>> for form in formset.forms:
+...     print form.as_p()
+<p><label for="id_form-0-owner">Owner:</label> <select name="form-0-owner" id="id_form-0-owner">
+<option value="" selected="selected">---------</option>
+<option value="1">Joe Perry at Giordanos</option>
+<option value="2">Jack Berry at Giordanos</option>
+</select></p>
+<p><label for="id_form-0-age">Age:</label> <input type="text" name="form-0-age" id="id_form-0-age" /></p>
+
+>>> owner = Owner.objects.get(name=u'Joe Perry')
+>>> FormSet = inlineformset_factory(Owner, OwnerProfile, max_num=1, can_delete=False)
+
+>>> formset = FormSet(instance=owner)
+>>> for form in formset.forms:
+...     print form.as_p()
+<p><label for="id_ownerprofile-0-age">Age:</label> <input type="text" name="ownerprofile-0-age" id="id_ownerprofile-0-age" /><input type="hidden" name="ownerprofile-0-owner" id="id_ownerprofile-0-owner" /></p>
+
+>>> data = {
+...     'ownerprofile-TOTAL_FORMS': '1',
+...     'ownerprofile-INITIAL_FORMS': '0',
+...     'ownerprofile-0-owner': '',
+...     'ownerprofile-0-age': u'54',
+... }
+>>> formset = FormSet(data, instance=owner)
+>>> formset.is_valid()
+True
+>>> formset.save()
+[<OwnerProfile: Joe Perry is 54>]
+
+>>> formset = FormSet(instance=owner)
+>>> for form in formset.forms:
+...     print form.as_p()
+<p><label for="id_ownerprofile-0-age">Age:</label> <input type="text" name="ownerprofile-0-age" value="54" id="id_ownerprofile-0-age" /><input type="hidden" name="ownerprofile-0-owner" value="1" id="id_ownerprofile-0-owner" /></p>
+
+>>> data = {
+...     'ownerprofile-TOTAL_FORMS': '1',
+...     'ownerprofile-INITIAL_FORMS': '1',
+...     'ownerprofile-0-owner': u'1',
+...     'ownerprofile-0-age': u'55',
+... }
+>>> formset = FormSet(data, instance=owner)
+>>> formset.is_valid()
+True
+>>> formset.save()
+[<OwnerProfile: Joe Perry is 55>]
+
-# Foreign keys in parents ########################################
-

django/trunk/tests/modeltests/model_forms/models.py

@@ -69 +69 @@
-class BetterWriter(Writer):
-    pass
+
+class WriterProfile(models.Model):
+    writer = models.OneToOneField(Writer, primary_key=True)
+    age = models.PositiveIntegerField()
+    
+    def __unicode__(self):
+        return "%s is %s" % (self.writer, self.age)
-
-class PhoneNumber(models.Model):
@@ -812 +819 @@
->>> bw.save()
->>> sorted(model_to_dict(bw).keys())
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-# PhoneNumberField ############################################################