Opened 11 years ago

Last modified 5 months ago

#10403 assigned New feature

provide declarative syntax to define FormSets - including ModelFormSet and InlineFormSet

Reported by: Koen Biermans <koen.biermans@…> Owned by: Parth Patil
Component: Forms Version: master
Severity: Normal Keywords: formset modelformset inlineformset
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: yes
Needs tests: yes Patch needs improvement: yes
Easy pickings: no UI/UX: no


Provide a declarative mechanism to define modelformsets or inlineformsets.

The attached patch allows definitions like this:

class AuthorForm(forms.ModelForm):
    class Meta:
        model = Author

class DeclarativeAuthorFormSet(forms.models.ModelFormSet):
    form = AuthorForm
    model = Author
    extra = 3


class BookForm(forms.ModelForm):
    class Meta:
        model = Book

class DeclarativeAuthorBooksFormSet(forms.models.InlineFormSet):
    model = Book
    form = BookForm
    parent = 'author'

An advantage is that the defined form is directly used as the form class in the formset, not as a base class for a new form class (what inlineformset_factory does). This way specific field definitions and other customisations in the form work like they should so you don't need to redefine things in init().

Attachments (2)

declarativeformsets.diff (15.9 KB) - added by Koen Biermans <koen.biermans@…> 11 years ago.
patch to provide declarative syntax for modelformset and inlineformset
django-10403.diff (27.7 KB) - added by Bas Peschier 9 years ago.

Download all attachments as: .zip

Change History (12)

Changed 11 years ago by Koen Biermans <koen.biermans@…>

Attachment: declarativeformsets.diff added

patch to provide declarative syntax for modelformset and inlineformset

comment:1 Changed 11 years ago by Jacob

Triage Stage: UnreviewedDesign decision needed

comment:2 Changed 9 years ago by Chris Beaven

Severity: Normal
Type: New feature

comment:3 Changed 9 years ago by Stephen Burrows

Easy pickings: unset
Keywords: formset added
Needs documentation: set
Needs tests: set
Patch needs improvement: set
Summary: provide declarative syntax to define ModelFormSet and InlineFormSetprovide declarative syntax to define FormSets - including ModelFormSet and InlineFormSet
UI/UX: unset

Closed #16289 as a duplicate - it proposed essentially the same thing as this ticket, but included all FormSets, not just ModelFormSets. Hence I'm widening the scope of this a little. (Also marking as needs tests since the tests in the patch are doctests.)

comment:4 Changed 9 years ago by Bas Peschier

Ok, so I missed this one O:)

I disagree with the implementation in the patch, no MetaClass is needed and just simple additions to the class definitions to make it work, maybe with the exception of InlineFormSet. Will attach a patch later on.

Changed 9 years ago by Bas Peschier

Attachment: django-10403.diff added

comment:5 Changed 8 years ago by rasca

Adding a comment from #16289:

This would be very useful for a nicer implementation of the formset derived cbv #16256.

The BaseInlineFormSet? is the only tricky one with the _get_foreign_key() and the max_num override when fk.unique=True .

I'd also move the defaults (e.g. extra=3) to the BaseFormSet? and make the factories only pass dict keys whose value isn't None to type().

comment:6 Changed 7 years ago by Carl Meyer

Triage Stage: Design decision neededAccepted

The current factory-function implementation of formsets is unnecessarily confusing to new users, and unlike anything else in Django. It can also cause obscure issues with things that should "just work" (see e.g. It's ironic that we provide declarative syntax for things like models and forms where it requires metaclass magic, but in the case of formsets where a declarative syntax is a simple matter of normal Python subclassing, we don't :-)

Haven't reviewed the latest patch in depth, but the broad strokes look correct to me.

comment:10 Changed 5 years ago by Tim Graham

I don't know that deprecating the factory functions (at least immediately) is a good idea. This could cause a lot of annoying churn for large projects.

comment:11 Changed 15 months ago by Parth Patil

Owner: changed from nobody to Parth Patil
Status: newassigned

comment:12 Changed 14 months ago by Parth Patil

Here is a link to the pull request. This is the first iteration of the patch so may require some critical review.

comment:13 Changed 5 months ago by Asif Saifuddin Auvi

Parth, are you willing to complete this for 3.1?

Note: See TracTickets for help on using tickets.
Back to Top