Ticket #8164: modelforms-fields-order.diff

django/forms/models.py

@@ -149 +149 @@
     fields will be excluded from the returned fields, even if they are listed
     in the ``fields`` argument.
     """
-    # TODO: if fields is provided, it would be nice to return fields in that order
     field_list = []
     opts = model._meta
     for f in opts.fields + opts.many_to_many:
@@ -162 +161 @@
         formfield = formfield_callback(f)
         if formfield:
             field_list.append((f.name, formfield))
-    return SortedDict(field_list)
+    field_dict = SortedDict(field_list)
+    if fields:
+        field_dict.keyOrder = [f for f in fields if (not exclude) or (exclude and f not in exclude)]
+    return field_dict
 
 class ModelFormOptions(object):
     def __init__(self, options=None):

docs/topics/forms/modelforms.txt

@@ -259 +259 @@
 
 2. Use the ``fields`` attribute of the ``ModelForm``'s inner ``Meta``
    class.  This attribute, if given, should be a list of field names
-   to include in the form.
+   to include in the form.  The order of the items in ``fields`` will be the 
+   order the field's appear in when rendered if ``fields`` is provided.
 
 3. Use the ``exclude`` attribute of the ``ModelForm``'s inner ``Meta``
    class.  This attribute, if given, should be a list of field names

tests/modeltests/model_forms/models.py

@@ -331 +331 @@
 <tr><th><label for="id_slug">Slug:</label></th><td><input id="id_slug" type="text" name="slug" maxlength="20" /></td></tr>
 <tr><th><label for="id_checkbox">Checkbox:</label></th><td><input type="checkbox" name="checkbox" id="id_checkbox" /></td></tr>
 
+# test using fields to provide ordering to the fields
+>>> class CategoryForm(ModelForm):
+...     class Meta:
+...         model = Category
+...         fields = ['url', 'name']
+
+>>> CategoryForm.base_fields.keys()
+['url', 'name']
+
+>>> print CategoryForm()
+<tr><th><label for="id_url">The URL:</label></th><td><input id="id_url" type="text" name="url" maxlength="40" /></td></tr>
+<tr><th><label for="id_name">Name:</label></th><td><input id="id_name" type="text" name="name" maxlength="20" /></td></tr>
+
 # Old form_for_x tests #######################################################
 
 >>> from django.forms import ModelForm, CharField