Custom field order in ModelForms

[killiands]

When deriving forms from models it may be wanted to have a custom ordering and intertwine extra fields with the predefined model fields. Accompanied patch allows this:

Example given:

class UserForm(forms.ModelForm):
    password = forms.CharField(label=_('password'), widget=forms.PasswordInput)
    password2 = forms.CharField(label=_('repeat password'), widget=forms.PasswordInput)
    email2 = forms.EmailField(label=_('repeat email'))
    
    class Meta:
        model = User
        fields = ('username', 'first_name', 'last_name', 'password', 'password2', 'email', 'email2')

As you can see you can both define model fields and custom fields in the meta class and now the form will use that order instead of the model order followed by custom fields.

[killiands]

Patch proposal

[killiands]

Documentation

[killiands]

I added this ticket because I think it's a minor patch that would make things much easier when creating customized model forms. Now you have to 'hack' the output, just to change field order. Too bad it's set at post-1.0. It actually doesn't break anything (tested it on new fields, model fields, overridden fields & non-existant fields).

[miracle2k]

Apparently related ticket:
​http://code.djangoproject.com/ticket/5986

[(none)]

Milestone post-1.0 deleted

[Alex Gaynor]

#888 was a dupe.

[Alex Gaynor]

Err #8888

[Russell Keith-Magee]

(In [10062]) Fixed #8164 -- Fields on a ModelForm are now ordered in the order specified in the fields attribute of the ModelForm's Meta class. Thanks to Alex Gaynor for the patch.

[Marco Bonetti]

Is it just me or doesn't the checked-in fix work as in the original example? I get a nasty error when I try to create a ModelForm having extra fields in the 'fields' list that aren't in the Model.

[Alex Gaynor]

If you think there's a bug in the code that went in, please file a bug.

[chrisrbennett]

The added iteration of Meta fields in this patch will break (faulty) assignment of field names not properly sequenced.

Previously, fields = ("foofield") worked. Now it doesn't. I'm sure I'm not the only person that falls into the "want one item dict, but forgot trailing comma" trap.

[anentropic]

This fix only seems to apply to ModelForms... surely we should be able to do the same thing for regular forms too? If you want one form to inherit off another?

Here's a hack I found on StackOverflow to achieve the neccessary order with a regular form:
​http://stackoverflow.com/questions/350799/how-does-django-know-the-order-to-render-form-fields/1191310#1191310

[anentropic]

Replying to anentropic:

This fix only seems to apply to ModelForms... surely we should be able to do the same thing for regular forms too? If you want one form to inherit off another?

Here's a hack I found on StackOverflow to achieve the neccessary order with a regular form:
​http://stackoverflow.com/questions/350799/how-does-django-know-the-order-to-render-form-fields/1191310#1191310

(example they use is a ModelForm but I tried it and it works with regular Form)

[Russell Keith-Magee]

If you want to request a new feature, file a new ticket.

[Jacob]

Milestone 1.1 deleted