Ticket #10792: 10792_r10524.diff

django/forms/models.py

@@ -711 +711 @@
                  required=True, widget=None, label=None, initial=None,
                  help_text=None, to_field_name=None, *args, **kwargs):
         self.empty_label = empty_label
+        if required and (initial is not None):
+            self.empty_label = None
         self.cache_choices = cache_choices
 
         # Call Field instead of ChoiceField __init__() because we don't need

tests/regressiontests/forms/models.py

@@ -24 +24 @@
     """For ModelChoiceField and ModelMultipleChoiceField tests."""
     name = models.CharField(max_length=10)
 
+class ChoiceOptionModel(models.Model):
+    """Destination for ChoiceFieldModel's ForeignKey.
+    Can't reuse ChoiceModel because error_message tests require that it have no instances."""
+    name = models.CharField(max_length=10)
+    
+class ChoiceFieldModel(models.Model):
+    """Model with ForeignKey to another model, for testing ModelForm
+    generation with ModelChoiceField."""
+    choice = models.ForeignKey(ChoiceOptionModel, blank=False,
+                               default=lambda: ChoiceOptionModel.objects.all()[0])
+
 class FileModel(models.Model):
     file = models.FileField(storage=temp_storage, upload_to='tests')
 
@@ -86 +97 @@
 >>> instance_form.initial['value']
 12
 >>> shutil.rmtree(temp_storage_location)
+
+In a ModelForm with a ModelChoiceField, if the model's ForeignKey has blank=False and a default,
+no empty option is created (regression test for #10792).
+
+First we need at least one instance of ChoiceOptionModel:
+
+>>> ChoiceOptionModel.objects.create(name='default')
+<ChoiceOptionModel: ChoiceOptionModel object>
+
+>>> class ChoiceFieldForm(ModelForm):
+...     class Meta:
+...         model = ChoiceFieldModel
+>>> list(ChoiceFieldForm().fields['choice'].choices)
+[(1, u'ChoiceOptionModel object')]
+
 """}

docs/ref/forms/fields.txt

@@ -786 +786 @@
         # No empty label
         field2 = forms.ModelChoiceField(queryset=..., empty_label=None)
 
+   Note that if a ``ModelChoiceField`` is required and has a default
+   initial value, no empty choice is created (regardless of the value
+   of ``empty_label``).
+
 ``ModelMultipleChoiceField``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~