Ticket #13769: fields-kwargs.diff

django/forms/models.py

@@ -150 +150 @@
             data[f.name] = f.value_from_object(instance)
     return data
 
-def fields_for_model(model, fields=None, exclude=None, widgets=None, formfield_callback=lambda f, **kwargs: f.formfield(**kwargs)):
+def fields_for_model(model, fields=None, exclude=None, widgets=None, fields_kwargs=None,
+        formfield_callback=lambda f, **kwargs: f.formfield(**kwargs)):
     """
     Returns a ``SortedDict`` containing form fields for the given model.
 
@@ -171 +172 @@
             continue
         if exclude and f.name in exclude:
             continue
-        if widgets and f.name in widgets:
-            kwargs = {'widget': widgets[f.name]}
+        if fields_kwargs and f.name in fields_kwargs:
+            kwargs = fields_kwargs[f.name].copy()
         else:
             kwargs = {}
+        if widgets and f.name in widgets:
+            kwargs['widget'] = widgets[f.name]
         formfield = formfield_callback(f, **kwargs)
         if formfield:
             field_list.append((f.name, formfield))
@@ -194 +197 @@
         self.fields = getattr(options, 'fields', None)
         self.exclude = getattr(options, 'exclude', None)
         self.widgets = getattr(options, 'widgets', None)
+        self.fields_kwargs = getattr(options, 'fields_kwargs', None)
 
 
 class ModelFormMetaclass(type):
@@ -216 +220 @@
         opts = new_class._meta = ModelFormOptions(getattr(new_class, 'Meta', None))
         if opts.model:
             # If a model is defined, extract form fields from it.
-            fields = fields_for_model(opts.model, opts.fields,
-                                      opts.exclude, opts.widgets, formfield_callback)
+            fields = fields_for_model(opts.model, opts.fields, opts.exclude,
+                opts.widgets, opts.fields_kwargs, formfield_callback)
             # Override default model fields with any custom declared ones
             # (plus, include all the other declared fields).
             fields.update(declared_fields)

tests/modeltests/model_forms/models.py

@@ -322 +322 @@
 >>> CategoryForm.base_fields.keys()
 ['name']
 
+Using 'fields_kwargs'
+
+>>> class CategoryForm(ModelForm):
+...
+...     class Meta:
+...         model = Category
+...         fields = ['name', 'url', 'slug']
+...         fields_kwargs = {
+...             'name': {'label': 'Category name', 'widget': forms.Textarea(attrs={'rows': '5', 'cols': '20'})},
+...             'url': {'max_length': 30},
+...             'slug': {'max_length': 10, 'widget': forms.TextInput(attrs={'class': 'slug'})},
+...         }
+
+>>> print CategoryForm()
+<tr><th><label for="id_name">Category name:</label></th><td><textarea id="id_name" rows="5" cols="20" name="name"></textarea></td></tr>
+<tr><th><label for="id_url">The URL:</label></th><td><input id="id_url" type="text" name="url" maxlength="30" /></td></tr>
+<tr><th><label for="id_slug">Slug:</label></th><td><input id="id_slug" type="text" class="slug" name="slug" maxlength="10" /></td></tr>
+
 Using 'widgets'
 
 >>> class CategoryForm(ModelForm):
@@ -343 +361 @@
 >>> str(CategoryForm()['slug'])
 '<input id="id_slug" type="text" name="slug" maxlength="20" />'
 
+Using 'fields_kwargs' and 'widgets' at once - 'widgets' have higher priority
+
+>>> class CategoryForm(ModelForm):
+...
+...     class Meta:
+...         model = Category
+...         fields = ['name', 'url', 'slug']
+...         widgets = {
+...             'name': forms.Textarea,
+...             'url': forms.TextInput(attrs={'class': 'url'})
+...         }
+...         fields_kwargs = {
+...             'name': {'label': 'Category name', 'widget': forms.Textarea(attrs={'rows': '5', 'cols': '20'})},
+...             'url': {'max_length': 30},
+...             'slug': {'max_length': 10, 'widget': forms.TextInput(attrs={'class': 'slug'})},
+...         }
+
+>>> str(CategoryForm()['name'])
+'<textarea id="id_name" rows="10" cols="40" name="name"></textarea>'
+
+>>> str(CategoryForm()['url'])
+'<input id="id_url" type="text" class="url" name="url" maxlength="30" />'
+
+>>> str(CategoryForm()['slug'])
+'<input id="id_slug" type="text" class="slug" name="slug" maxlength="10" />'
+
 Don't allow more than one 'model' definition in the inheritance hierarchy.
 Technically, it would generate a valid form, but the fact that the resulting
 save method won't deal with multiple objects is likely to trip up people not