Allow Select and SelectMultiple widgets to render HTML optgroups from nested choices structures

[Tai Lee]

if the label of a choices iterable is a list or tuple, treat that option as an option group with the value as the label.

this shouldn't break any backwards compatibility and negates the need for a separate SelectGrouped widget (which has been previously rejected).

[Matt McClanahan <cardinal@…>]

Initial implementation proposal. An example choices structure (from the tests in the patch):

choices = (
    ('outer1', 'Outer 1'),
    ('Group 1', (
            ('inner1', 'Inner 1'),
            ('inner2', 'Inner 2'),
        )
    )
)

yields the following HTML:

<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>

[Jacob]

Accepted; needs documentation.

[Matt McClanahan <cardinal@…>]

That reminded me that I overlooked get_FIELD_display. Done and done.

[Matt McClanahan <cardinal@…>]

Updated for the unicode branch merge

[Matt McClanahan <cardinal@…>]

Bugfix, sigh.

[Tai Lee <real.human@…>]

updated to work on trunk, after unicode changes.

[Simon G. <dev@…>]

Ready for checkin: JKM accepted, has tests, has docs, looks good.

[Russell Keith-Magee]

Update to r6025, plus some polish to docs and implementation

[Matt McClanahan]

Discussion: ​http://groups.google.com/group/django-developers/browse_thread/thread/6c6e3b40fdc5fee3/

[Matt McClanahan]

Er. No, I don't own this. :P

[Malcolm Tredinnick]

I think "ready to checkin" is a little optimistic at this point. As Russell points out in the related django-dev thread, the patch will have problems with existing admin, so it needs to wait until after newforms-admin is merged.

[Tai Lee <real.human@…>]

Updated to r7000.

[Chris Beaven]

Note: I've got an updated version of this patch running which fixes a few issues... If i haven't put it live in a week, bug me about it.

[Chris Beaven]

Updated patch, fixed to work with multiple select and old admin

[Chris Beaven]

This new patch allows this to continue with the old admin (even if it is going to be short-lived - i needed it for now) and also makes MultipleSelect work. I abstracted some of the widget rendering logic between Select and MultipleSelect which also meant making MultipleSelect a subclass of Select, which I always thought it should have been anyway...

Added tests for the new MultipleSelect functionality.

[Chris Beaven]

Amusingly, I see that Russ had already done the SelectMultiple work. But I like my abstraction a bit better.

[Russell Keith-Magee]

(In [7977]) 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@…>, Tai Lee <real.human@…> and SmileyChris for their contributions at various stages in the life of this ticket.

[Santiago Zarate]

i found a small problem when using nested choice structures:

on models.py

class Item(models.Model):

#common object properties
name = models.CharField(max_length=60)
category = models.CharField("Item Category", max_length=20, choices=ITEM_TREE)

on admin.py

class ItemAdmin(admin.ModelAdmin):

list_display = ('name', 'category',)
list_filter = ('category',)

when i browse to: /admin/item/item/

i see the choices bot most of them are python's tuples

Filter
By Item Category

All
Outer 1
(('inner1', 'Inner 1'),
('inner2', 'Inner 2'))

(screenshot: ​http://imagenes.zarate.net.ve/varias/djangobug.png)

[Karen Tracey]

Please do not reopen fixed tickets to report new problems. If there is a problem with new function added by this ticket, it should be reported in its own ticket. This also sounds vaguely familiar so do check to see if it's already been reported in an open ticket.

Also, please use preview before submitting your ticket and learn the basics of WikiFormatting so that your text will be readable.

[Ramiro Morales]

Replying to kmtracey:

This also sounds vaguely familiar so do check to see if it's already been reported in an open ticket.

I couldn't find an pre-existing ticket about this so I've opened #9954.

[Jacob]

Milestone 1.0 beta deleted