Changeset 7977

Timestamp:

07/19/08 02:53:02 (3 months ago)

Author:

russellm

Message:

Fixed #4412 -- Added support for optgroups, both in the model when defining choices, and in the form field and widgets when the optgroups are displayed. Thanks to Matt McClanahan? <cardinal@dodds.net>, Tai Lee <real.human@mrmachine.net> and SmileyChris? for their contributions at various stages in the life of this ticket.

Files:

• django/trunk/django/db/models/base.py (modified) (1 diff)
• django/trunk/django/db/models/fields/__init__.py (modified) (2 diffs)
• django/trunk/django/forms/fields.py (modified) (3 diffs)
• django/trunk/django/forms/widgets.py (modified) (2 diffs)
• django/trunk/docs/model-api.txt (modified) (1 diff)
• django/trunk/docs/newforms.txt (modified) (2 diffs)
• django/trunk/tests/regressiontests/forms/fields.py (modified) (8 diffs)
• django/trunk/tests/regressiontests/forms/widgets.py (modified) (2 diffs)

django/trunk/django/db/models/base.py

@@ -427 +427 @@
-    def _get_FIELD_display(self, field):
-        value = getattr(self, field.attname)
-
+flat
-
-    def _get_next_or_previous_by_FIELD(self, field, is_next, **kwargs):

django/trunk/django/db/models/fields/__init__.py

@@ -289 +289 @@
-            field_objs = [oldforms.SelectField]
-
-get_choices_default()
+flatchoices
-        else:
-            field_objs = self.get_manipulator_field_objs()
@@ -408 +408 @@
-    choices = property(_get_choices)
-
+    def _get_flatchoices(self):
+        flat = []
+        for choice, value in self.get_choices_default():
+            if type(value) in (list, tuple):
+                flat.extend(value)
+            else:
+                flat.append((choice,value))
+        return flat
+    flatchoices = property(_get_flatchoices)
+    
-    def save_form_data(self, instance, data):
-        setattr(instance, self.name, data)

django/trunk/django/forms/fields.py

@@ -586 +586 @@
-    widget = Select
-    default_error_messages = {
-That choice
+%(value)s
-    }
-
@@ -616 +616 @@
-        if value == u'':
-            return value
-
-
+
-            raise ValidationError(self.error_messages['invalid_choice'] % {'value': value})
-        return value
-
+    def valid_value(self, value):
+        "Check to see if the provided value is a valid choice"
+        for k, v in self.choices:
+            if type(v) in (tuple, list):
+                # This is an optgroup, so look inside the group for options
+                for k2, v2 in v:
+                    if value == smart_unicode(k2):
+                        return True
+            else:
+                if value == smart_unicode(k):
+                    return True
+        return False
+        
-class MultipleChoiceField(ChoiceField):
-    hidden_widget = MultipleHiddenInput
@@ -641 +653 @@
-        new_value = [smart_unicode(val) for val in value]
-        # Validate that each value in the value list is in self.choices.
-        valid_values = set([smart_unicode(k) for k, v in self.choices])
-        for val in new_value:
-val not in valid_values
+not self.valid_value(val)
-                raise ValidationError(self.error_messages['invalid_choice'] % {'value': val})
-        return new_value

django/trunk/django/forms/widgets.py

@@ -346 +346 @@
-        final_attrs = self.build_attrs(attrs, name=name)
-        output = [u'<select%s>' % flatatt(final_attrs)]
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        for option_value, option_label in chain(self.choices, choices):
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-class NullBooleanSelect(Select):
@@ -381 +396 @@
-        return bool(initial) != bool(data)
-
-
-
-
-
-
-
+
-    def render(self, name, value, attrs=None, choices=()):
-        if value is None: value = []
-        final_attrs = self.build_attrs(attrs, name=name)
-        output = [u'<select multiple="multiple"%s>' % flatatt(final_attrs)]
-
-
-
-
-
-
-
-
+
+
+
+
-        return mark_safe(u'\n'.join(output))
-

django/trunk/docs/model-api.txt

@@ -554 +554 @@
-    class Foo(models.Model):
-        gender = models.CharField(max_length=1, choices=GENDER_CHOICES)
+
+You can also collect your available choices into named groups that can
+be used for organizational purposes::
+
+    MEDIA_CHOICES = (
+        ('Audio', (
+                ('vinyl', 'Vinyl'),
+                ('cd', 'CD'),
+            )
+        ),
+        ('Video', (
+                ('vhs', 'VHS Tape'),
+                ('dvd', 'DVD'),
+            )
+        ),
+        ('unknown', 'Unknown'),
+    )
+
+The first element in each tuple is the name to apply to the group. The 
+second element is an iterable of 2-tuples, with each 2-tuple containing
+a value and a human-readable name for an option. Grouped options may be 
+combined with ungrouped options within a single list (such as the 
+`unknown` option in this example).
-
-For each model field that has ``choices`` set, Django will add a method to

django/trunk/docs/newforms.txt

@@ -1237 +1237 @@
-
-Takes one extra argument, ``choices``, which is an iterable (e.g., a list or
-
+
+
+
+
+
-
-``DateField``
@@ -1445 +1449 @@
-
-Takes one extra argument, ``choices``, which is an iterable (e.g., a list or
-
+
+
+
-
-``NullBooleanField``

django/trunk/tests/regressiontests/forms/fields.py

@@ -981 +981 @@
-# ChoiceField #################################################################
-
-1'), ('2', '2
+One'), ('2', 'Two
->>> f.clean('')
-Traceback (most recent call last):
@@ -997 +997 @@
-Traceback (most recent call last):
-...
-That choice
-
-1'), ('2', '2
+3
+
+One'), ('2', 'Two
->>> f.clean('')
-u''
@@ -1011 +1011 @@
-Traceback (most recent call last):
-...
-That choice
+3
-
->>> f = ChoiceField(choices=[('J', 'John'), ('P', 'Paul')])
@@ -1019 +1019 @@
-Traceback (most recent call last):
-...
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-# NullBooleanField ############################################################
@@ -1037 +1055 @@
-# MultipleChoiceField #########################################################
-
-1'), ('2', '2
+One'), ('2', 'Two
->>> f.clean('')
-Traceback (most recent call last):
@@ -1073 +1091 @@
-ValidationError: [u'Select a valid choice. 3 is not one of the available choices.']
-
-1'), ('2', '2
+One'), ('2', 'Two
->>> f.clean('')
-[]
@@ -1101 +1119 @@
-ValidationError: [u'Select a valid choice. 3 is not one of the available choices.']
-
+>>> f = MultipleChoiceField(choices=[('Numbers', (('1', 'One'), ('2', 'Two'))), ('Letters', (('3','A'),('4','B'))), ('5','Other')])
+>>> f.clean([1])
+[u'1']
+>>> f.clean(['1'])
+[u'1']
+>>> f.clean([1, 5])
+[u'1', u'5']
+>>> f.clean([1, '5'])
+[u'1', u'5']
+>>> f.clean(['1', 5])
+[u'1', u'5']
+>>> f.clean(['1', '5'])
+[u'1', u'5']
+>>> f.clean(['6'])
+Traceback (most recent call last):
+...
+ValidationError: [u'Select a valid choice. 6 is not one of the available choices.']
+>>> f.clean(['1','6'])
+Traceback (most recent call last):
+...
+ValidationError: [u'Select a valid choice. 6 is not one of the available choices.']
+
+
-# ComboField ##################################################################
-
@@ -1166 +1207 @@
-Traceback (most recent call last):
-...
-That choice
+fields.py
->>> fix_os_paths(f.clean(path + 'fields.py'))
-u'.../django/forms/fields.py'

django/trunk/tests/regressiontests/forms/widgets.py

@@ -459 +459 @@
-</select>
-
+Choices can be nested one level in order to create HTML optgroups:
+>>> w.choices=(('outer1', 'Outer 1'), ('Group "1"', (('inner1', 'Inner 1'), ('inner2', 'Inner 2'))))
+>>> print w.render('nestchoice', None)
+<select name="nestchoice">
+<option value="outer1">Outer 1</option>
+<optgroup label="Group &quot;1&quot;">
+<option value="inner1">Inner 1</option>
+<option value="inner2">Inner 2</option>
+</optgroup>
+</select>
+
+>>> print w.render('nestchoice', 'outer1')
+<select name="nestchoice">
+<option value="outer1" selected="selected">Outer 1</option>
+<optgroup label="Group &quot;1&quot;">
+<option value="inner1">Inner 1</option>
+<option value="inner2">Inner 2</option>
+</optgroup>
+</select>
+
+>>> print w.render('nestchoice', 'inner1')
+<select name="nestchoice">
+<option value="outer1">Outer 1</option>
+<optgroup label="Group &quot;1&quot;">
+<option value="inner1" selected="selected">Inner 1</option>
+<option value="inner2">Inner 2</option>
+</optgroup>
+</select>
+
-# NullBooleanSelect Widget ####################################################
-
@@ -626 +655 @@
->>> w._has_changed([1, 2], [u'1', u'3'])
-True
+
+# Choices can be nested one level in order to create HTML optgroups:
+>>> w.choices = (('outer1', 'Outer 1'), ('Group "1"', (('inner1', 'Inner 1'), ('inner2', 'Inner 2'))))
+>>> print w.render('nestchoice', None)
+<select multiple="multiple" name="nestchoice">
+<option value="outer1">Outer 1</option>
+<optgroup label="Group &quot;1&quot;">
+<option value="inner1">Inner 1</option>
+<option value="inner2">Inner 2</option>
+</optgroup>
+</select>
+
+>>> print w.render('nestchoice', ['outer1'])
+<select multiple="multiple" name="nestchoice">
+<option value="outer1" selected="selected">Outer 1</option>
+<optgroup label="Group &quot;1&quot;">
+<option value="inner1">Inner 1</option>
+<option value="inner2">Inner 2</option>
+</optgroup>
+</select>
+
+>>> print w.render('nestchoice', ['inner1'])
+<select multiple="multiple" name="nestchoice">
+<option value="outer1">Outer 1</option>
+<optgroup label="Group &quot;1&quot;">
+<option value="inner1" selected="selected">Inner 1</option>
+<option value="inner2">Inner 2</option>
+</optgroup>
+</select>
+
+>>> print w.render('nestchoice', ['outer1', 'inner2'])
+<select multiple="multiple" name="nestchoice">
+<option value="outer1" selected="selected">Outer 1</option>
+<optgroup label="Group &quot;1&quot;">
+<option value="inner1">Inner 1</option>
+<option value="inner2" selected="selected">Inner 2</option>
+</optgroup>
+</select>
-
-# RadioSelect Widget ##########################################################