Ticket #3257: related_choice_field_empty_label.patch

django/db/models/fields/related.py

@@ -553 +553 @@
         setattr(cls, related.get_accessor_name(), ForeignRelatedObjectsDescriptor(related))
 
     def formfield(self, **kwargs):
-        defaults = {'choices': self.get_choices_default(), 'required': not self.blank, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
+        defaults = {'queryset': self.rel.to._default_manager.all(), 'required': not self.blank, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
         defaults.update(kwargs)
-        return forms.ChoiceField(**defaults)
+        return forms.ModelChoiceField(**defaults)
 
 class OneToOneField(RelatedField, IntegerField):
     def __init__(self, to, to_field=None, **kwargs):
@@ -619 +619 @@
             cls._meta.one_to_one_field = self
 
     def formfield(self, **kwargs):
-        defaults = {'choices': self.get_choices_default(), 'required': not self.blank, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
+        defaults = {'queryset': self.rel.to._default_manager.all(), 'required': not self.blank, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
         defaults.update(kwargs)
-        return forms.ChoiceField(**kwargs)
+        return forms.ModelChoiceField(**kwargs)
 
 class ManyToManyField(RelatedField, Field):
     def __init__(self, to, **kwargs):
@@ -742 +742 @@
         # MultipleChoiceField takes a list of IDs.
         if kwargs.get('initial') is not None:
             kwargs['initial'] = [i._get_pk_val() for i in kwargs['initial']]
-        defaults = {'choices': self.get_choices_default(), 'required': not self.blank, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
+        defaults = {'queryset' : self.rel.to._default_manager.all(), 'required': not self.blank, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
         defaults.update(kwargs)
-        return forms.MultipleChoiceField(**defaults)
+        return forms.ModelMultipleChoiceField(**defaults)
 
 class ManyToOneRel(object):
     def __init__(self, to, field_name, num_in_admin=3, min_num_in_admin=None,

django/newforms/models.py

@@ -4 +4 @@
 """
 
 from forms import BaseForm, DeclarativeFieldsMetaclass, SortedDictFromList
+from fields import ChoiceField, MultipleChoiceField
+from widgets import Select, SelectMultiple
 
-__all__ = ('save_instance', 'form_for_model', 'form_for_instance', 'form_for_fields')
+__all__ = ('save_instance', 'form_for_model', 'form_for_instance', 'form_for_fields',
+           'ModelChoiceField', 'ModelMultipleChoiceField')
 
 def model_save(self, commit=True):
     """
@@ -33 +36 @@
     for f in opts.fields:
         if isinstance(f, models.AutoField):
             continue
-        setattr(instance, f.attname, clean_data[f.name])
+        setattr(instance, f.name, clean_data[f.name])
     if commit:
         instance.save()
         for f in opts.many_to_many:
@@ -96 +99 @@
     "Returns a Form class for the given list of Django database field instances."
     fields = SortedDictFromList([(f.name, f.formfield()) for f in field_list])
     return type('FormForFields', (BaseForm,), {'base_fields': fields})
+
+class ModelChoiceField(ChoiceField): 
+    def __init__(self, queryset, empty_label=u"---------", **kwargs): 
+        self.model = queryset.model 
+        choices=[(obj._get_pk_val(), str(obj)) for obj in queryset]
+        if not empty_label is None:
+            choices = [(u"", empty_label)] + choices
+        ChoiceField.__init__(self, choices=choices, **kwargs) 
+ 
+    def clean(self, value): 
+        new_value = ChoiceField.clean(self, value) 
+        if not new_value: 
+            return None 
+        try: 
+            new_value = self.model._default_manager.get(pk=new_value) 
+        except: 
+            raise ValidationError(gettext(u'Select a valid choice. %s is not one of the available choices.') % value) 
+        return new_value 
+ 
+class ModelMultipleChoiceField(MultipleChoiceField): 
+    def __init__(self, queryset, **kwargs): 
+        self.model = queryset.model
+        MultipleChoiceField.__init__(self, choices=[(obj._get_pk_val(), str(obj)) for obj in queryset], **kwargs) 
+ 
+    def clean(self, value): 
+        new_value = MultipleChoiceField.clean(self, value) 
+        if not new_value: 
+            return [] 
+        return self.model._default_manager.filter(pk__in=new_value)  

tests/modeltests/model_forms/models.py

@@ -24 +24 @@
 
 from django.db import models
 
+class Poll(models.Model): 
+    question = models.CharField(maxlength=200) 
+    def __str__(self):
+        return "Q: %s " % self.question
+
 class Category(models.Model):
     name = models.CharField(maxlength=20)
     url = models.CharField('The URL', maxlength=40)
@@ -281 +286 @@
 <Category: Third>
 >>> Category.objects.get(id=3)
 <Category: Third>
+
+# ModelChoiceField #################################################################
+
+>>> from django.newforms import *
+
+>>> p = Poll(question="Test Question")
+>>> p.save()
+>>> p2 = Poll(question="Second Test Question")
+>>> p2.save()
+
+>>> f = ModelChoiceField(Poll.objects.all())
+>>> f.clean('')
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean(None)
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean(0)
+Traceback (most recent call last):
+...
+ValidationError: [u'Select a valid choice. 0 is not one of the available choices.']
+>>> f.clean(1)
+<Poll: Q: Test Question >
+>>> f.clean(2)
+<Poll: Q: Second Test Question >
+
+>>> f = ModelChoiceField(Poll.objects.filter( pk=1 ), required=False)
+>>> print f.clean('')
+None
+>>> f.clean('')
+>>> f.clean('1')
+<Poll: Q: Test Question >
+>>> f.clean('2')
+Traceback (most recent call last):
+...
+ValidationError: [u'Select a valid choice. 2 is not one of the available choices.']
+
+# ModelMultipleChoiceField #########################################################
+
+>>> f = ModelMultipleChoiceField(Poll.objects.all())
+>>> f.clean(None)
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean([])
+Traceback (most recent call last):
+...
+ValidationError: [u'This field is required.']
+>>> f.clean([1])
+[<Poll: Q: Test Question >]
+>>> f.clean([2])
+[<Poll: Q: Second Test Question >]
+>>> f.clean(['1'])
+[<Poll: Q: Test Question >]
+>>> f.clean(['1', '2'])
+[<Poll: Q: Test Question >, <Poll: Q: Second Test Question >]
+>>> f.clean([1, '2'])
+[<Poll: Q: Test Question >, <Poll: Q: Second Test Question >]
+>>> f.clean((1, '2'))
+[<Poll: Q: Test Question >, <Poll: Q: Second Test Question >]
+>>> f.clean('hello')
+Traceback (most recent call last):
+...
+ValidationError: [u'Enter a list of values.']
+>>> f = ModelMultipleChoiceField(Poll.objects.all(), required=False)
+>>> f.clean([])
+[]
+>>> f.clean(())
+[]
+>>> f.clean(['3'])
+Traceback (most recent call last):
+...
+ValidationError: [u'Select a valid choice. 3 is not one of the available choices.']
+>>> f.clean(['3', '4'])
+Traceback (most recent call last):
+...
+ValidationError: [u'Select a valid choice. 3 is not one of the available choices.']
+>>> f.clean(['1', '5'])
+Traceback (most recent call last):
+...
+ValidationError: [u'Select a valid choice. 5 is not one of the available choices.']
 """}