Ticket #5372: formset_refactor_3.diff

a/django/contrib/admin/options.py

@@ -331 +331 @@
-        "Hook for specifying fieldsets for the change form."
-        if self.declared_fieldsets:
-            return self.declared_fieldsets
-, obj
+
-        return [(None, {'fields': form.base_fields.keys()})]
-
-    def form_add(self, request):
@@ -342 +342 @@
-            fields = flatten_fieldsets(self.declared_fieldsets)
-        else:
-            fields = None
-
+model
-
-, obj
+
-        """
-        Returns a Form class for use in the admin change view.
-        """
@@ -352 +352 @@
-            fields = flatten_fieldsets(self.declared_fieldsets)
-        else:
-            fields = None
-form_for_instance(obj
+modelform_for_model(self.model
-
-    def save_add(self, request, model, form, formsets, post_url_continue):
-        """
@@ -492 +492 @@
-            # Object list will give 'Permission Denied', so go back to admin home
-            post_url = '../../../'
-
-Model
+
-        inline_formsets = []
-        obj = self.model()
-        if request.method == 'POST':
-Model
+
-            for FormSet in self.formsets_add(request):
-obj, data=request.POST, files=
+request.POST, 
-                inline_formsets.append(inline_formset)
-            if all_valid(inline_formsets) and form.is_valid():
-                return self.save_add(request, model, form, inline_formsets, '../%s/')
-        else:
-Model
+
-            for FormSet in self.formsets_add(request):
-obj
+
-                inline_formsets.append(inline_formset)
-
-        adminForm = AdminForm(form, list(self.fieldsets_add(request)), self.prepopulated_fields)
@@ -552 +552 @@
-        if request.POST and request.POST.has_key("_saveasnew"):
-            return self.add_view(request, form_url='../../add/')
-
-ModelForm = self.form_change(request, obj
+Form = self.form_change(request
-        inline_formsets = []
-        if request.method == 'POST':
-Model
+
-            for FormSet in self.formsets_change(request, obj):
-obj, request.POST, request.FILES
+request.POST, request.FILES, instance=obj
-                inline_formsets.append(inline_formset)
-
-            if all_valid(inline_formsets) and form.is_valid():
-                return self.save_change(request, model, form, inline_formsets)
-        else:
-ModelForm(
+Form(instance=obj, initial=request.GET
-            for FormSet in self.formsets_change(request, obj):
-
+instance=
-                inline_formsets.append(inline_formset)
-
-        ## Populate the FormWrapper.

a/django/newforms/formsets.py

@@ -1 @@
-
-
+
+
+
+
+
+
+
+
+
-from widgets import HiddenInput, Media
-from util import ErrorList, ValidationError
-
-
+FormSet', '
-
-# special field names
-FORM_COUNT_FIELD_NAME = 'COUNT'
@@ -20 +27 @@
-        self.base_fields[FORM_COUNT_FIELD_NAME] = IntegerField(widget=HiddenInput)
-        super(ManagementForm, self).__init__(*args, **kwargs)
-
+class BaseFormSetMetaclass(type):
+    def __new__(cls, name, bases, attrs, **options):
+        fields = [(field_name, attrs.pop(field_name)) for field_name, obj in attrs.items() if isinstance(obj, Field)]
+        fields.sort(lambda x, y: cmp(x[1].creation_counter, y[1].creation_counter))
+        
+        # If this class is subclassing another FormSet, ad that FormSet's fields.
+        # Note that we loop over the bases in *reverse*. This is necessary in
+        # order to preserve the correct order of fields.
+        for base in bases[::-1]:
+            if hasattr(base, "base_fields"):
+                fields = base.base_fields.items() + fields
+        attrs["base_fields"] = SortedDict(fields)
+        
+        opts = FormSetOptions(options and options or attrs.get("Meta", None))
+        attrs["_meta"] = opts
+        
+        return type.__new__(cls, name, bases, attrs)
+
-class BaseFormSet(object):
-    """A collection of instances of the same Form class."""
-
@@ -37 +62 @@
-            self.management_form = ManagementForm(data, files, auto_id=self.auto_id, prefix=self.prefix)
-            if self.management_form.is_valid():
-                self.total_forms = self.management_form.cleaned_data[FORM_COUNT_FIELD_NAME]
-
-
+_meta.
+_meta.
-            else:
-                # not sure that ValidationError is the best thing to raise here
-                raise ValidationError('ManagementForm data is missing or has been tampered with')
-        elif initial:
-            self.change_form_count = len(initial)
-            self.required_forms = len(initial)
-
+_meta.
-            self.management_form = ManagementForm(initial={FORM_COUNT_FIELD_NAME: self.total_forms}, auto_id=self.auto_id, prefix=self.prefix)
-        else:
-            self.change_form_count = 0
-            self.required_forms = 0
-
+_meta.
-            self.management_form = ManagementForm(initial={FORM_COUNT_FIELD_NAME: self.total_forms}, auto_id=self.auto_id, prefix=self.prefix)
-
-    def _get_add_forms(self):
-        """Return a list of all the add forms in this ``FormSet``."""
-        FormClass = self.form_class
-        if not hasattr(self, '_add_forms'):
-            add_forms = []
-            for i in range(self.change_form_count, self.total_forms):
@@ -64 +88 @@
-                    kwargs['data'] = self.data
-                if self.files:
-                    kwargs['files'] = self.files
-FormClass
+self.get_form_class(i)
-                self.add_fields(add_form, i)
-                add_forms.append(add_form)
-            self._add_forms = add_forms
@@ -73 +97 @@
-
-    def _get_change_forms(self):
-        """Return a list of all the change forms in this ``FormSet``."""
-        FormClass = self.form_class
-        if not hasattr(self, '_change_forms'):
-            change_forms = []
-            for i in range(0, self.change_form_count):
@@ -84 +107 @@
-                    kwargs['files'] = self.files
-                if self.initial:
-                    kwargs['initial'] = self.initial[i]
-FormClass
+self.get_form_class(i)
-                self.add_fields(change_form, i)
-                change_forms.append(change_form)
-
+ 
-        return self._change_forms
-    change_forms = property(_get_change_forms)
-
@@ -117 +140 @@
-        # Process change forms
-        for form in self.change_forms:
-            if form.is_valid():
-
+_meta.
-                    self.deleted_data.append(form.cleaned_data)
-                else:
-                    self.cleaned_data.append(form.cleaned_data)
@@ -144 +167 @@
-        add_errors.reverse()
-        errors.extend(add_errors)
-        # Sort cleaned_data if the formset is orderable.
-
+_meta.
-            self.cleaned_data.sort(lambda x,y: x[ORDERING_FIELD_NAME] - y[ORDERING_FIELD_NAME])
-        # Give self.clean() a chance to do validation
-        try:
@@ -167 +190 @@
-        via formset.non_form_errors()
-        """
-        return self.cleaned_data
+    
+    def get_form_class(self, index):
+        """
+        A hook to change a form class object.
+        """
+        FormClass = self._meta.form
+        FormClass.base_fields = self.base_fields
+        return FormClass
-
-    def add_fields(self, form, index):
-        """A hook for adding extra fields on to each form instance."""
-
+_meta.
-            form.fields[ORDERING_FIELD_NAME] = IntegerField(label='Order', initial=index+1)
-
+_meta.
-            form.fields[DELETION_FIELD_NAME] = BooleanField(label='Delete', required=False)
-
-    def add_prefix(self, index):
@@ -192 +223 @@
-        else:
-            return Media()
-    media = property(_get_media)
+
+class FormSet(BaseFormSet):
+    __metaclass__ = BaseFormSetMetaclass
-    
-
+
+
-    """Return a FormSet for the given form class."""
-
-
-
+
+
+
+
+
+
+
+
-def all_valid(formsets):
-    """Returns true if every formset in formsets is valid."""
-    valid = True

a/django/newforms/models.py

@@ -13 +13 @@
-from util import ValidationError, ErrorList
-from forms import BaseForm
-from fields import Field, ChoiceField, IntegerField, EMPTY_VALUES
-
+
+
-from widgets import Select, SelectMultiple, HiddenInput, MultipleHiddenInput
-
-__all__ = (
-    'ModelForm', 'BaseModelForm', 'model_to_dict', 'fields_for_model',
-    'save_instance', 'form_for_model', 'form_for_instance', 'form_for_fields',
-
+modelform_for_model', '
-    'ModelChoiceField', 'ModelMultipleChoiceField',
-)
-
@@ -209 +210 @@
-            field_list.append((f.name, formfield))
-    return SortedDict(field_list)
-
-class ModelFormOptions(object):
-    def __init__(self, options=None):
-        self.model = getattr(options, 'model', None)
-        self.fields = getattr(options, 'fields', None)
-        self.exclude = getattr(options, 'exclude', None)
-
-class ModelFormMetaclass(type):
-
-
-
+
+
-        fields = [(field_name, attrs.pop(field_name)) for field_name, obj in attrs.items() if isinstance(obj, Field)]
-        fields.sort(lambda x, y: cmp(x[1].creation_counter, y[1].creation_counter))
-
@@ -230 +224 @@
-                fields = base.base_fields.items() + fields
-        declared_fields = SortedDict(fields)
-
-ModelFormOptions(
+cls.get_options(options and options or 
-        attrs['_meta'] = opts
-
-        # Don't allow more than one Meta model defenition in bases. The fields
@@ -262 +256 @@
-        else:
-            attrs['base_fields'] = declared_fields
-        return type.__new__(cls, name, bases, attrs)
+    
+    def _get_options(cls, options=None):
+        """
+        Returns the options instance for this class.
+        """
+        return ModelFormOptions(options)
+    get_options = classmethod(_get_options)
-
-class BaseModelForm(BaseForm):
-    def __init__(self, instance, data=None, files=None, auto_id='id_%s', prefix=None,
@@ -290 +291 @@
-class ModelForm(BaseModelForm):
-    __metaclass__ = ModelFormMetaclass
-
+# this should really be named form_for_model.
+def modelform_for_model(model, form=BaseModelForm,
+                        formfield_callback=lambda f: f.formfield(), **options):
+    opts = model._meta
+    options.update({"model": model})
+    return ModelFormMetaclass(opts.object_name + "ModelForm", (form,),
+                              {}, **options)
+
-
-# Fields #####################################################################
-
@@ -404 +413 @@
-
-# Model-FormSet integration ###################################################
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
-class BaseModelFormSet(BaseFormSet):
-    """
-    A ``FormSet`` for editing a queryset and/or adding new objects to it.
-    """
-    model = None
-    queryset = None
-
-qs, 
+
-        kwargs = {'data': data, 'files': files, 'auto_id': auto_id, 'prefix': prefix}
-
-
+
+
+
+
+
+
-        super(BaseModelFormSet, self).__init__(**kwargs)
+    
+    def get_queryset(self, **kwargs):
+        """
+        Hook to returning a queryset for this model.
+        """
+        return self._meta.model._default_manager.all()
-
-    def save_new(self, form, commit=True):
-        """Saves and returns a new model instance for the given form."""
-
+_meta.
-
-    def save_instance(self, form, instance, commit=True):
-        """Saves and returns an existing model instance for the given form."""
@@ -461 +458 @@
-            return []
-        # Put the objects from self.get_queryset into a dict so they are easy to lookup by pk
-        existing_objects = {}
+        opts = self._meta
-        for obj in self.queryset:
-            existing_objects[obj.pk] = obj
-        saved_instances = []
-        for form in self.change_forms:
-self
-self
+opts
+opts
-                obj.delete()
-            else:
-                saved_instances.append(self.save_instance(form, obj, commit=commit))
@@ -474 +472 @@
-
-    def save_new_objects(self, commit=True):
-        new_objects = []
+        opts = self._meta
-        for form in self.add_forms:
-            if form.is_empty():
-                continue
-            # If someone has marked an add form for deletion, don't save the
-            # object. At some point it would be nice if we didn't display
-            # the deletion widget for add forms.
-self
+opts
-                continue
-            new_objects.append(self.save_new(form, commit=commit))
-        return new_objects
-
-    def add_fields(self, form, index):
-        """Add a hidden field for the object's primary key."""
-
+_meta.
-        form.fields[self._pk_field_name] = IntegerField(required=False, widget=HiddenInput)
-        super(BaseModelFormSet, self).add_fields(form, index)
-
-
-
+
+
+
+
+
-    """
-    Returns a FormSet class for the given Django model class. This FormSet
-    will contain change forms for every instance of the given model as well
@@ -501 +503 @@
-    This is essentially the same as ``formset_for_queryset``, but automatically
-    uses the model's default manager to determine the queryset.
-    """
-form = form_for_model(model, form=form, fields=fields, formfield_callback=formfield_callback)
-FormSet = formset_for_form(form, formset, extra, orderable, deletable
-FormSet.model = model
-return FormSet
+opts = model._meta
+options.update({"model": model}
+return ModelFormSetMetaclass(opts.object_name + "ModelFormSet", (formset,),
+                             {}, **options)
-
-
+
+
+
+
+
+
-    """A formset for child objects related to a parent."""
-instance, data=None, files=None
+*args, **kwargs
-        from django.db.models.fields.related import RelatedObject
-
+
+
+
-        # is there a better way to get the object descriptor?
-
-
-
+
+
+
+
+
+
+
+
-
-
+, **kwargs
-        """
-        Returns this FormSet's queryset, but restricted to children of 
-        self.instance
-        """
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    def save_new(self, form, commit=True):
-        kwargs = {self.fk.get_attname(): self.instance.pk}
-
+_meta.
-        return save_instance(form, new_obj, commit=commit)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
+
+
-    """
-    Returns an ``InlineFormset`` for the given kwargs.
-
-    You must provide ``fk_name`` if ``model`` has more than one ``ForeignKey``
-    to ``parent_model``.
-    """
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+

/dev/null

@@ +1 @@
+
+from forms import BaseForm
+
+class BaseFormOptions(object):
+    """
+    The base class for all options that are associated to a form object.
+    """
+    def __init__(self, options=None):
+        self.fields = self._dynamic_attribute(options, "fields")
+        self.exclude = self._dynamic_attribute(options, "exclude")
+    
+    def _dynamic_attribute(self, obj, key, default=None):
+        try:
+            return getattr(obj, key)
+        except AttributeError:
+            try:
+                return obj[key]
+            except (TypeError, KeyError):
+                # key doesnt exist in obj or obj is None
+                return default
+
+class ModelFormOptions(BaseFormOptions):
+    """
+    Encapsulates the options on a ModelForm class.
+    """
+    def __init__(self, options=None):
+        self.model = self._dynamic_attribute(options, "model")
+        super(ModelFormOptions, self).__init__(options)
+
+class FormSetOptions(BaseFormOptions):
+    """
+    Encapsulates the options on a FormSet class.
+    """
+    def __init__(self, options=None):
+        self.form = self._dynamic_attribute(options, "form", BaseForm)
+        self.num_extra = self._dynamic_attribute(options, "num_extra", 1)
+        self.orderable = self._dynamic_attribute(options, "orderable", False)
+        self.deletable = self._dynamic_attribute(options, "deletable", False)
+        super(FormSetOptions, self).__init__(options)
+
+class ModelFormSetOptions(FormSetOptions, ModelFormOptions):
+    pass
+
+class InlineFormSetOptions(ModelFormSetOptions):
+    def __init__(self, options=None):
+        super(InlineFormSetOptions, self).__init__(options)
+        self.parent_model = self._dynamic_attribute(options, "parent_model")
+        self.fk_name = self._dynamic_attribute(options, "fk_name")
+    

a/tests/modeltests/model_formsets/models.py

@@ -16 +16 @@
-
-__test__ = {'API_TESTS': """
-
-
+, ModelFormSet
-
-
-
+
-
-
+
+
+
+
+
+
->>> for form in formset.forms:
-...     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" /><input type="hidden" name="form-0-id" id="id_form-0-id" /></p>
@@ -35 +39 @@
-...     'form-2-name': '',
-... }
-
-qs, data=
+
->>> formset.is_valid()
-True
-
@@ -49 +53 @@
-
-
-Gah! We forgot Paul Verlaine. Let's create a formset to edit the existing
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
->>> for form in formset.forms:
-...     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="Arthur Rimbaud" maxlength="100" /><input type="hidden" name="form-0-id" value="2" id="id_form-0-id" /></p>
@@ -73 +84 @@
-...     'form-2-name': 'Paul Verlaine',
-... }
-
-qs, data=
+
->>> formset.is_valid()
-True
-
@@ -90 +101 @@
-This probably shouldn't happen, but it will. If an add form was marked for
-deltetion, make sure we don't save that form.
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
->>> for form in formset.forms:
-...     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="Arthur Rimbaud" maxlength="100" /></p>
@@ -117 +135 @@
-...     'form-3-DELETE': 'on',
-... }
-
-qs, data=
+
->>> formset.is_valid()
-True
-
@@ -134 +152 @@
-We can also create a formset that is tied to a parent model. This is how the
-admin system's edit inline functionality works.
-
-
+
+
+
+
+
+
+
+
-
->>> AuthorBooksFormSet = inline_formset(Author, Book, deletable=False, extra=3)
->>> author = Author.objects.get(name='Charles Baudelaire')
-
-
+instance=
->>> for form in formset.forms:
-...     print form.as_p()
-<p><label for="id_book_set-0-title">Title:</label> <input id="id_book_set-0-title" type="text" name="book_set-0-title" maxlength="100" /><input type="hidden" name="book_set-0-id" id="id_book_set-0-id" /></p>
@@ -153 +177 @@
-...     'book_set-2-title': '',
-... }
-
-author, data=data
+data, instance=author
->>> formset.is_valid()
-True
-
@@ -169 +193 @@
-one. This time though, an edit form will be available for every existing
-book.
-
-
+
+
+
+
+
+
+
->>> author = Author.objects.get(name='Charles Baudelaire')
-
-
+instance=
->>> for form in formset.forms:
-...     print form.as_p()
-<p><label for="id_book_set-0-title">Title:</label> <input id="id_book_set-0-title" type="text" name="book_set-0-title" value="Les Fleurs du Mal" maxlength="100" /><input type="hidden" name="book_set-0-id" value="1" id="id_book_set-0-id" /></p>
@@ -187 +217 @@
-...     'book_set-2-title': '',
-... }
-
-author, data=data
+data, instance=author
->>> formset.is_valid()
-True
-

a/tests/regressiontests/forms/formsets.py

@@ -2 +2 @@
-formset_tests = """
-# Basic FormSet creation and usage ############################################
-
-For now,
-best way to create a FormSet is by using the formset_for_form function
+Create
+formset as you would a regular form by defining the fields declaratively
-
->>> from django.newforms import Form, CharField, IntegerField, ValidationError
-
+
+
-
-(Form
+FormSet(FormSet
-...     choice = CharField()
-...     votes = IntegerField()
-
->>> ChoiceFormSet = formset_for_form(Choice)
-
-
-A FormSet constructor takes the same arguments as Form. Let's create a FormSet
-for adding data. By default, it displays 1 blank form. It can display more,
@@ -145 +144 @@
->>> formset.errors
-[{'votes': [u'This field is required.'], 'choice': [u'This field is required.']}]
-
+# Subclassing a FormSet class #################################################
+
+We can subclass a FormSet to add addition fields to an already exisiting
+FormSet.
+
+>>> class SecondChoiceFormSet(ChoiceFormSet):
+...     is_public = BooleanField()
+
+>>> formset = SecondChoiceFormSet(auto_id=False, prefix="choices")
+>>> for form in formset.forms:
+...     print form.as_ul()
+<li>Choice: <input type="text" name="choices-0-choice" /></li>
+<li>Votes: <input type="text" name="choices-0-votes" /></li>
+<li>Is public: <input type="checkbox" name="choices-0-is_public" /></li>
-
-# Displaying more than 1 blank form ###########################################
-
-pass a
-num_extra argument to formset_for_form
+create an inner
+Meta class with an attribute num_extra
-
-
+
+
+
-
-
+NumExtra
->>> for form in formset.forms:
-...    print form.as_ul()
-<li>Choice: <input type="text" name="choices-0-choice" /></li>
@@ -177 +192 @@
-...     'choices-2-votes': '',
-... }
-
-
+NumExtra
->>> formset.is_valid()
-True
->>> formset.cleaned_data
@@ -196 +211 @@
-...     'choices-2-votes': '',
-... }
-
-
+NumExtra
->>> formset.is_valid()
-True
->>> formset.cleaned_data
@@ -215 +230 @@
-...     'choices-2-votes': '',
-... }
-
-
+NumExtra
->>> formset.is_valid()
-False
->>> formset.errors
@@ -226 +241 @@
-data.
-
->>> initial = [{'choice': u'Calexico', 'votes': 100}]
-
+NumExtra
->>> for form in formset.forms:
-...    print form.as_ul()
-<li>Choice: <input type="text" name="choices-0-choice" value="Calexico" /></li>
@@ -254 +269 @@
-...     'choices-3-votes': '',
-... }
-
-
+NumExtra
->>> formset.is_valid()
-False
->>> formset.errors
@@ -263 +278 @@
-
-# FormSets with deletion ######################################################
-
-with an agrument to
-
-
+by setting deletable to True
+
+When 
-rather than formset.cleaned_data
-
-
+