From 93e79b45bc5288d1ca0eb5b6eade30d3c7110b24 Mon Sep 17 00:00:00 2001 From: Nick Sandford Date: Wed, 23 Jan 2013 21:11:46 +0100 Subject: [PATCH] Fixed #17416 -- Added widgets argument to inlineformset_factory and modelformset_factory --- django/forms/models.py | 12 +++++++----- docs/ref/forms/models.txt | 16 ++++++++++++---- docs/topics/forms/modelforms.txt | 23 +++++++++++++++++++++++ tests/modeltests/model_formsets/tests.py | 24 ++++++++++++++++++++++++ 4 files changed, 66 insertions(+), 9 deletions(-) diff --git a/django/forms/models.py b/django/forms/models.py index 74886d7ae04..03a14dc9ff2 100644 --- a/django/forms/models.py +++ b/django/forms/models.py @@ -682,14 +682,15 @@ class BaseModelFormSet(BaseFormSet): super(BaseModelFormSet, self).add_fields(form, index) def modelformset_factory(model, form=ModelForm, formfield_callback=None, - formset=BaseModelFormSet, - extra=1, can_delete=False, can_order=False, - max_num=None, fields=None, exclude=None): + formset=BaseModelFormSet, extra=1, can_delete=False, + can_order=False, max_num=None, fields=None, + exclude=None, widgets=None): """ Returns a FormSet class for the given Django model class. """ form = modelform_factory(model, form=form, fields=fields, exclude=exclude, - formfield_callback=formfield_callback) + formfield_callback=formfield_callback, + widgets=widgets) FormSet = formset_factory(form, formset, extra=extra, max_num=max_num, can_order=can_order, can_delete=can_delete) FormSet.model = model @@ -827,7 +828,7 @@ def inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, - formfield_callback=None): + formfield_callback=None, widgets=None): """ Returns an ``InlineFormSet`` for the given kwargs. @@ -848,6 +849,7 @@ def inlineformset_factory(parent_model, model, form=ModelForm, 'fields': fields, 'exclude': exclude, 'max_num': max_num, + 'widgets': widgets, } FormSet = modelformset_factory(model, **kwargs) FormSet.fk = fk diff --git a/docs/ref/forms/models.txt b/docs/ref/forms/models.txt index c388f402e6b..f3382d32c75 100644 --- a/docs/ref/forms/models.txt +++ b/docs/ref/forms/models.txt @@ -25,12 +25,12 @@ Model Form Functions See :ref:`modelforms-factory` for example usage. -.. function:: modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None) +.. function:: modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None, widgets=None) Returns a ``FormSet`` class for the given ``model`` class. - Arguments ``model``, ``form``, ``fields``, ``exclude``, and - ``formfield_callback`` are all passed through to + Arguments ``model``, ``form``, ``fields``, ``exclude``, + ``formfield_callback`` and ``widgets`` are all passed through to :func:`~django.forms.models.modelform_factory`. Arguments ``formset``, ``extra``, ``max_num``, ``can_order``, and @@ -39,7 +39,11 @@ Model Form Functions See :ref:`model-formsets` for example usage. -.. function:: inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None) + .. versionchanged:: 1.6 + + The widgets parameter was added. + +.. function:: inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None, widgets=None) Returns an ``InlineFormSet`` using :func:`modelformset_factory` with defaults of ``formset=BaseInlineFormSet``, ``can_delete=True``, and @@ -49,3 +53,7 @@ Model Form Functions the ``parent_model``, you must specify a ``fk_name``. See :ref:`inline-formsets` for example usage. + + .. versionchanged:: 1.6 + + The widgets parameter was added. diff --git a/docs/topics/forms/modelforms.txt b/docs/topics/forms/modelforms.txt index c091e715bb7..d9e00d86cfb 100644 --- a/docs/topics/forms/modelforms.txt +++ b/docs/topics/forms/modelforms.txt @@ -650,6 +650,19 @@ exclude:: >>> AuthorFormSet = modelformset_factory(Author, exclude=('birth_date',)) +Specifying widgets to use in the form with ``widgets`` +------------------------------------------------------ + +.. versionadded:: 1.6 + +Using the ``widgets`` parameter, you can specify a dictionary of values to +customize the ``ModelForm``'s widget class for a particular field. This +works the same way as the ``widgets`` dictionary on the inner ``Meta`` +class of a ``ModelForm`` works:: + + >>> AuthorFormSet = modelformset_factory( + ... Author, widgets={'name': Textarea(attrs={'cols': 80, 'rows': 20}) + Providing initial values ------------------------ @@ -930,3 +943,13 @@ of a model. Here's how you can do that:: }) Notice how we pass ``instance`` in both the ``POST`` and ``GET`` cases. + +Specifying widgets to use in the inline form +-------------------------------------------- + +.. versionadded:: 1.6 + +``inlineformset_factory`` uses ``modelformset_factory`` and passes most +of its arguments to ``modelformset_factory``. This means you can use +the ``widgets`` parameter in much the same way as passing it to +``modelformset_factory``. See `Specifying widgets to use in the form with widgets`_ above. diff --git a/tests/modeltests/model_formsets/tests.py b/tests/modeltests/model_formsets/tests.py index e28560b2376..a028e651437 100644 --- a/tests/modeltests/model_formsets/tests.py +++ b/tests/modeltests/model_formsets/tests.py @@ -1190,3 +1190,27 @@ class ModelFormsetTest(TestCase): self.assertFalse(formset.is_valid()) self.assertEqual(formset._non_form_errors, ['Please correct the duplicate data for subtitle which must be unique for the month in posted.']) + + +class TestModelFormsetWidgets(TestCase): + def test_modelformset_factory_widgets(self): + widgets = { + 'name': forms.TextInput(attrs={'class': 'poet'}) + } + PoetFormSet = modelformset_factory(Poet, widgets=widgets) + form = PoetFormSet.form() + self.assertHTMLEqual( + "%s" % form['name'], + '' + ) + + def test_inlineformset_factory_widgets(self): + widgets = { + 'title': forms.TextInput(attrs={'class': 'book'}) + } + BookFormSet = inlineformset_factory(Author, Book, widgets=widgets) + form = BookFormSet.form() + self.assertHTMLEqual( + "%s" % form['title'], + '' + )