Login

ModelChoiceField & ModelMultipleChoiceField with optgroups

Author:
denvaar
Posted:
July 4, 2016
Language:
Python
Version:
1.7
Tags:
fields optgroup
Score:
3 (after 3 ratings)

Fields that support HTML optgroups. Adapted from this snippet and updated to work with latest version of Django (1.9) and additional ModelMultipleChoiceField support added.

Example Usage:

tag = GroupedModelChoiceField(queryset=Tag.objects.all(), group_by_field='parent')
positions = GroupedModelMultiChoiceField(queryset=Position.objects.all(),
                 group_by_field='agency')
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
from itertools import groupby
from django.forms.models import (
    ModelChoiceIterator, ModelChoiceField, ModelMultipleChoiceField
)


class Grouped(object):
    def __init__(self, queryset, group_by_field,
                 group_label=None, *args, **kwargs):
        """ 
        ``group_by_field`` is the name of a field on the model to use as
                           an optgroup.
        ``group_label`` is a function to return a label for each optgroup.
        """
        super(Grouped, self).__init__(queryset, *args, **kwargs)
        self.group_by_field = group_by_field
        if group_label is None:
            self.group_label = lambda group: group
        else:
            self.group_label = group_label
   
    def _get_choices(self):
        if hasattr(self, '_choices'):
            return self._choices
        return GroupedModelChoiceIterator(self)


class GroupedModelChoiceIterator(ModelChoiceIterator):
    def __iter__(self):
        if self.field.empty_label is not None:
            yield ("", self.field.empty_label)
        queryset = self.queryset.all()
        if not queryset._prefetch_related_lookups:
            queryset = queryset.iterator()
        for group, choices in groupby(self.queryset.all(),
                    key=lambda row: getattr(row, self.field.group_by_field)):
            if self.field.group_label(group):
                yield (
                    self.field.group_label(group),
                    [self.choice(ch) for ch in choices]
                )


class GroupedModelChoiceField(Grouped, ModelChoiceField):
    choices = property(Grouped._get_choices, ModelChoiceField._set_choices)


class GroupedModelMultiChoiceField(Grouped, ModelMultipleChoiceField):
    choices = property(Grouped._get_choices, ModelMultipleChoiceField._set_choices)

More like this

Comments

yaselc (on September 17, 2016):

Hi, I used this snippet in my form and it prints correctly the widget, but now the options in the select are not marked, How can I pull from the db the selections and how can I save them? I'm using the multiple choice widget.

#

alexpirine (on November 7, 2016):

Any change this gets into core? Did you try post a ticket?

#

Please login first before commenting.