Ticket #4653: form_for_instance_blank_option-r3.diff

django/db/models/fields/__init__.py

@@ -392 +392 @@
         "Returns a django.newforms.Field instance for this database Field."
         defaults = {'required': not self.blank, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
         if self.choices:
-            defaults['widget'] = forms.Select(choices=self.get_choices())
+            defaults['widget'] = forms.Select(choices=self.get_choices(include_blank=self.blank or not (self.has_default() or 'initial' in kwargs)))
         if self.has_default():
             defaults['initial'] = self.get_default()
         defaults.update(kwargs)

tests/modeltests/model_forms/models.py

@@ -30 +30 @@
     (3, 'Live'),
 )
 
+STEERING_TYPE = (
+    ('left', 'Left steering wheel'),
+    ('right', 'Right steering wheel'),
+)
+
+FUEL_TYPE = (
+    ('gas', 'Gasoline'),
+    ('diesel', 'Diesel'),
+    ('other', 'Other'),
+)
+
+TRANSMISSION_TYPE = (
+    ('at', 'Automatic'),
+    ('mt', 'Manual'),
+    ('cvt', 'CVT'),
+)
+
 class Category(models.Model):
     name = models.CharField(max_length=20)
     slug = models.SlugField(max_length=20)
@@ -70 +87 @@
     def __unicode__(self):
         return self.phone
 
+class Car(models.Model):
+    name = models.CharField(max_length=50)
+    steering = models.CharField(max_length=5, choices=STEERING_TYPE, default='left')
+    fuel = models.CharField(max_length=10, choices=FUEL_TYPE)
+    transmission = models.CharField(max_length=3, choices=TRANSMISSION_TYPE, blank=True, help_text='Leave empty if not applicable.')
+
 __test__ = {'API_TESTS': """
 >>> from django.newforms import form_for_model, form_for_instance, save_instance, BaseForm, Form, CharField
 >>> import datetime
@@ -592 +615 @@
 True
 >>> f.cleaned_data
 {'phone': u'312-555-1212', 'description': u'Assistance'}
+
+# form_for_* blank choices ####################################################
+
+Show the form for a new Car. Note that steering field doesn't include the blank choice,
+because the field is obligatory and has an explicit default.
+>>> CarForm = form_for_model(Car)
+>>> f = CarForm(auto_id=False)
+>>> print f
+<tr><th>Name:</th><td><input type="text" name="name" maxlength="50" /></td></tr>
+<tr><th>Steering:</th><td><select name="steering">
+<option value="left" selected="selected">Left steering wheel</option>
+<option value="right">Right steering wheel</option>
+</select></td></tr>
+<tr><th>Fuel:</th><td><select name="fuel">
+<option value="" selected="selected">---------</option>
+<option value="gas">Gasoline</option>
+<option value="diesel">Diesel</option>
+<option value="other">Other</option>
+</select></td></tr>
+<tr><th>Transmission:</th><td><select name="transmission">
+<option value="" selected="selected">---------</option>
+<option value="at">Automatic</option>
+<option value="mt">Manual</option>
+<option value="cvt">CVT</option>
+</select><br />Leave empty if not applicable.</td></tr>
+
+Create a Car, and display the form for modifying it. Note that now the fuel
+selector doesn't include the blank choice as well, since the field is
+obligatory and can not be changed to be blank.
+>>> honda = Car(name='Honda Accord Wagon', steering='right', fuel='gas', transmission='at')
+>>> honda.save()
+>>> HondaForm = form_for_instance(honda)
+>>> f = HondaForm(auto_id=False)
+>>> print f
+<tr><th>Name:</th><td><input type="text" name="name" value="Honda Accord Wagon" maxlength="50" /></td></tr>
+<tr><th>Steering:</th><td><select name="steering">
+<option value="left">Left steering wheel</option>
+<option value="right" selected="selected">Right steering wheel</option>
+</select></td></tr>
+<tr><th>Fuel:</th><td><select name="fuel">
+<option value="gas" selected="selected">Gasoline</option>
+<option value="diesel">Diesel</option>
+<option value="other">Other</option>
+</select></td></tr>
+<tr><th>Transmission:</th><td><select name="transmission">
+<option value="">---------</option>
+<option value="at" selected="selected">Automatic</option>
+<option value="mt">Manual</option>
+<option value="cvt">CVT</option>
+</select><br />Leave empty if not applicable.</td></tr>
 """}

AUTHORS

@@ -272 +272 @@
     Vinay Sajip <vinay_sajip@yahoo.co.uk>
     David Schein
     scott@staplefish.com
+    Ilya Semenov <semenov@inetss.com>
     serbaut@gmail.com
     John Shaffer <jshaffer2112@gmail.com>
     Pete Shinners <pete@shinners.org>

docs/newforms.txt

@@ -1849 +1849 @@
 
     * If the model field has ``choices`` set, then the form field's ``widget``
       will be set to ``Select``, with choices coming from the model field's
-      ``choices``.
+      ``choices``. The choices will include the blank choice which is selected
+      by default. If the field is required, that effectively forces a user to
+      make a selection. The blank choice will not be included if the model
+      field has ``blank=False`` and explicit ``default`` value.
 
 Finally, note that you can override the form field used for a given model
 field. See "Overriding the default field types" below.
@@ -2100 +2103 @@
 this data is not bound to the form. You will need to bind data to the
 form before the form can be saved.
 
+Unlike ``form_for_model()``, a choice field in form created by
+``form_for_instance()`` will not include the blank choice if the respective model
+field has ``blank=False``. The default choice is drawn from the instance, and
+there's no need to force a user to make a selection.
+
 When you call ``save()`` on a form created by ``form_for_instance()``,
 the database instance will be updated. As in ``form_for_model()``, ``save()``
 will raise ``ValueError`` if the data doesn't validate.