Ticket #4412: 4412-r6025.diff

django/db/models/base.py

@@ -324 +324 @@
 
     def _get_FIELD_display(self, field):
         value = getattr(self, field.attname)
-        return force_unicode(dict(field.choices).get(value, value), strings_only=True)
+        flatchoices = []
+        for choice in field.choices:
+            if type(choice[1]) in (list, tuple):
+                flatchoices.extend(choice[1])
+            else:
+                flatchoices.append(choice)
+        return force_unicode(dict(flatchoices).get(value, value), strings_only=True)
 
     def _get_next_or_previous_by_FIELD(self, field, is_next, **kwargs):
         qn = connection.ops.quote_name

django/newforms/fields.py

@@ -473 +473 @@
         value = smart_unicode(value)
         if value == u'':
             return value
-        valid_values = set([smart_unicode(k) for k, v in self.choices])
+        valid_values = [] 
+        for k, v in self.choices: 
+            if type(v) in (tuple, list): 
+                valid_values.extend([k2[0] for k2 in v]) 
+            else:
+                valid_values.append(k) 
+        valid_values = set([smart_unicode(v) for v in valid_values])        
         if value not in valid_values:
             raise ValidationError(ugettext(u'Select a valid choice. That choice is not one of the available choices.'))
         return value
@@ -494 +500 @@
             raise ValidationError(ugettext(u'Enter a list of values.'))
         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])
+        valid_values = [] 
+        for k, v in self.choices: 
+            if type(v) in (tuple, list): 
+                valid_values.extend([k2[0] for k2 in v]) 
+            else:
+                valid_values.append(k) 
+        valid_values = set([smart_unicode(v) for v in valid_values])        
         for val in new_value:
             if val not in valid_values:
                 raise ValidationError(ugettext(u'Select a valid choice. %s is not one of the available choices.') % val)

django/newforms/widgets.py

@@ -174 +174 @@
         output = [u'<select%s>' % flatatt(final_attrs)]
         str_value = force_unicode(value) # Normalize to string.
         for option_value, option_label in chain(self.choices, choices):
-            option_value = force_unicode(option_value)
-            selected_html = (option_value == str_value) and u' selected="selected"' or ''
-            output.append(u'<option value="%s"%s>%s</option>' % (escape(option_value), selected_html, escape(force_unicode(option_label))))
+            if type(option_label) in (list, tuple):
+                output.append(u'<optgroup label="%s">' % escape(force_unicode(option_value)))
+                for group_option_value, group_option_label in option_label:
+                    group_option_value = force_unicode(group_option_value)
+                    selected_html = (group_option_value == str_value) and u' selected="selected"' or ''
+                    output.append(u'<option value="%s"%s>%s</option>' % (escape(group_option_value), selected_html, escape(force_unicode(group_option_label))))
+                output.append(u'</optgroup>')
+            else:
+                option_value = force_unicode(option_value)
+                selected_html = (option_value == str_value) and u' selected="selected"' or ''
+                output.append(u'<option value="%s"%s>%s</option>' % (escape(option_value), selected_html, escape(force_unicode(option_label))))
         output.append(u'</select>')
         return u'\n'.join(output)
 
@@ -211 +219 @@
         output = [u'<select multiple="multiple"%s>' % flatatt(final_attrs)]
         str_values = set([force_unicode(v) for v in value]) # Normalize to strings.
         for option_value, option_label in chain(self.choices, choices):
-            option_value = force_unicode(option_value)
-            selected_html = (option_value in str_values) and ' selected="selected"' or ''
-            output.append(u'<option value="%s"%s>%s</option>' % (escape(option_value), selected_html, escape(force_unicode(option_label))))
+            if type(option_label) in (list, tuple):
+                output.append(u'<optgroup label="%s">' % escape(force_unicode(option_value)))
+                for group_option_value, group_option_label in option_label:
+                    group_option_value = force_unicode(group_option_value)
+                    selected_html = (group_option_value in str_values) and u' selected="selected"' or ''
+                    output.append(u'<option value="%s"%s>%s</option>' % (escape(group_option_value), selected_html, escape(force_unicode(group_option_label))))
+                output.append(u'</optgroup>')
+            else:
+                option_value = force_unicode(option_value)
+                selected_html = (option_value in str_values) and u' selected="selected"' or ''
+                output.append(u'<option value="%s"%s>%s</option>' % (escape(option_value), selected_html, escape(force_unicode(option_label))))
         output.append(u'</select>')
         return u'\n'.join(output)
 

tests/regressiontests/forms/tests.py

@@ -395 +395 @@
 <option value="4">4</option>
 </select>
 
+Choices can be nested one level in order to create HTML optgroups:
+>>> w = Select(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 1">
+<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 1">
+<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 1">
+<option value="inner1" selected="selected">Inner 1</option>
+<option value="inner2">Inner 2</option>
+</optgroup>
+</select>
+
 # NullBooleanSelect Widget ####################################################
 
 >>> w = NullBooleanSelect()
@@ -536 +563 @@
 >>> w.render('nums', ['ŠĐĆŽćžšđ'], choices=[('ŠĐĆŽćžšđ', 'ŠĐabcĆŽćžšđ'), ('ćžšđ', 'abcćžšđ')])
 u'<select multiple="multiple" name="nums">\n<option value="1">1</option>\n<option value="2">2</option>\n<option value="3">3</option>\n<option value="\u0160\u0110\u0106\u017d\u0107\u017e\u0161\u0111" selected="selected">\u0160\u0110abc\u0106\u017d\u0107\u017e\u0161\u0111</option>\n<option value="\u0107\u017e\u0161\u0111">abc\u0107\u017e\u0161\u0111</option>\n</select>'
 
+Choices can be nested one level in order to create HTML optgroups:
+>>> w = SelectMultiple(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 1">
+<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 1">
+<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 1">
+<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 1">
+<option value="inner1">Inner 1</option>
+<option value="inner2" selected="selected">Inner 2</option>
+</optgroup>
+</select>
+
 # RadioSelect Widget ##########################################################
 
 >>> w = RadioSelect()

docs/newforms.txt

@@ -1083 +1083 @@
     * Validates that the given value exists in the list of choices.
 
 Takes one extra argument, ``choices``, which is an iterable (e.g., a list or
-tuple) of 2-tuples to use as choices for this field.
+tuple) of 2-tuples to use as choices for this field. This argument accepts
+the same formats as the ``choices`` argument to a model field. See the 
+`model API documentation on choices`_ for more details.
 
+.. _model API documentation on choices: ../model-api#choices
+
 ``DateField``
 ~~~~~~~~~~~~~
 

docs/model-api.txt

@@ -552 +552 @@
     class Foo(models.Model):
         gender = models.CharField(max_length=1, choices=GENDER_CHOICES)
 
+You can also collect your available choices into named groups, which will
+be used for display 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
 retrieve the human-readable name for the field's current value. See
 `get_FOO_display`_ in the database API documentation.