如何在Django Select小部件中对选项进行分组？

Question

在Django自动生成的表单中，是否可以创建具有命名分组选择的下拉框？我能否创建左侧图片中的小部件？

我第一次尝试创建具有命名分组的表单是手动完成的，就像这样：

class GroupMenuOrderForm(forms.Form):
    food_list = [(1, 'burger'), (2, 'pizza'), (3, 'taco'),]
        drink_list = [(4, 'coke'), (5, 'pepsi'), (6, 'root beer'),]
        item_list = ( ('food', tuple(food_list)), ('drinks', tuple(drink_list)),)
        itemsField = forms.ChoiceField(choices = tuple(item_list))

    def GroupMenuOrder(request):
        theForm = GroupMenuOrderForm()
        return render_to_response(menu_template, {'form': theForm,})
        # generates the widget in left-side picture

它很好地起作用了，在左侧创建了下拉小部件，其中包含命名分组。

然后我创建了一个数据模型，它基本上具有相同的结构，并利用了Django从模型自动生成表单的能力。 它可以工作-在显示所有选项方面是可以的。 但是选项不在命名分组中，到目前为止，我还没有找到如何实现这一点-如果可能的话。

我发现了几个问题的答案是“创建一个表单构造函数并在那里进行任何特殊的处理”。 但似乎forms.ChoiceField需要一个元组来进行命名分组，并且我不确定如何将元组转换为QuerySet（如果我正确理解QuerySet是指向数据而不是实际数据，那么这可能是不可能的）。

我用于数据模型的代码是：

class ItemDesc(models.Model):
    ''' one of "food", "drink", where ID of “food” = 1, “drink” = 2 '''
    desc = models.CharField(max_length=10, unique=True)
    def __unicode__(self):
        return self.desc

class MenuItem(models.Model):
    ''' one of ("burger", 1), ("pizza", 1), ("taco", 1),
        ("coke", 2), ("pepsi", 2), ("root beer", 2) '''
    name = models.CharField(max_length=50, unique=True)
    itemDesc = models.ForeignKey(ItemDesc)
    def __unicode__(self):
        return self.name

class PatronOrder(models.Model):
    itemWanted = models.ForeignKey(MenuItem)

class ListMenuOrderForm(forms.ModelForm):
    class Meta:
        model = PatronOrder

def ListMenuOrder(request):
    theForm = ListMenuOrderForm()
    return render_to_response(menu_template, {'form': theForm,})
    # generates the widget in right-side picture

如果必要的话，我会更改数据模型，但这似乎是一个简单明了的结构。也许外键太多了？折叠数据并接受非规范化？ :) 或者有没有一种方法将元组转换为QuerySet，或者任何可以被ModelChoiceField接受的东西？

更新：基于meshantz的回答，最终代码如下：

class FooIterator(forms.models.ModelChoiceIterator):
    def __init__(self, *args, **kwargs):
        super(forms.models.ModelChoiceIterator, self).__init__(*args, **kwargs)
    def __iter__(self):
            yield ('food', [(1L, u'burger'), (2L, u'pizza')])
            yield ('drinks', [(3L, u'coke'), (4L, u'pepsi')])

class ListMenuOrderForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super(ListMenuOrderForm, self).__init__(*args, **kwargs)
        self.fields['itemWanted'].choices = FooIterator()
    class Meta:
        model = PatronOrder

(当然，实际代码中，我会让某个东西从 数据库 中提取项目数据。)

与他提供的 djangosnippet 相比，最大的改变似乎是 Django 已经整合了一些代码，使得可以直接将一个迭代器赋值给 choices，而不必覆盖整个类。这非常好。

- John C

---

可能是DJANGO: ModelChoiceField optgroup tag的重复问题。 - congusbongus

Answer 1

在快速查看django.forms.models中的ModelChoiceField代码后，我建议尝试扩展该类并覆盖其choice属性。

设置属性以返回自定义迭代器，基于同一模块中的原始ModelChoiceIterator（返回您遇到问题的元组） - 新的GroupedModelChoiceIterator或某些内容。

如何编写该迭代器的确切方法我得让你自己来思考，但我猜想你只需要以自定义方式获取返回元组的元组，而不是默认设置。

很高兴回复评论，因为我相信这个答案需要一些微调 :)

编辑下面

刚有一个想法并检查了djangosnippets，结果发现有人已经做到了: 带选项组的ModelChoiceField。它已经一年了，所以可能需要对最新的django进行一些调整，但这正是我想要的。

- meshantz

---

做到了，谢谢。既了解了choices字段，又看到了代码片段，最终让它工作了。 - John C

我有一个类似的情况，我想使用CheckboxSelectMultiple小部件，但是我只得到了整个组的一个复选框。有什么想法吗？ - snakesNbronies

在 http://stackoverflow.com/questions/14607331/django-form-choices-groupby-with-checkboxselectmultiple-widget 上开了一个新的问题。 - snakesNbronies

@meshantz 我收到了错误信息：'GroupedModelChoiceField' 对象没有 'cache_choices' 属性。 - AmiNadimi

Answer 2

以下是我所采用的方法，不需要扩展当前任何django类:

我有一个生物种类列表，将不同的王国作为optgroup。在OrganismForm表单中，您可以从下拉选择框中选择有机体，并按照王国的optgroup进行排序，然后列出该王国的所有有机体。如下所示:

  [----------------|V]
  |Plantae         |
  |  Angiosperm    |
  |  Conifer       |
  |Animalia        |
  |  Mammal        |
  |  Amphibian     |
  |  Marsupial     |
  |Fungi           |
  |  Zygomycota    |
  |  Ascomycota    |
  |  Basidiomycota |
  |  Deuteromycota |
  |...             |
  |________________|

models.py

from django.models import Model

class Kingdom(Model):
    name = models.CharField(max_length=16)

class Organism(Model):
    kingdom = models.ForeignKeyField(Kingdom)
    name = models.CharField(max_length=64)

forms.py:

from models import Kingdom, Organism

class OrganismForm(forms.ModelForm):
    organism = forms.ModelChoiceField(
        queryset=Organism.objects.all().order_by('kingdom__name', 'name')
    )
    class Meta:
        model = Organism

views.py:

from models import Organism, Kingdom
from forms import OrganismForm
form = OrganismForm()
form.fields['organism'].choices = list()

# Now loop the kingdoms, to get all organisms in each.
for k in Kingdom.objects.all():
    # Append the tuple of OptGroup Name, Organism.
    form.fields['organism'].choices = form.fields['organism'].choices.append(
        (
            k.name, # First tuple part is the optgroup name/label
            list( # Second tuple part is a list of tuples for each option.
                (o.id, o.name) for o in Organism.objects.filter(kingdom=k).order_by('name')
                # Each option itself is a tuple of id and name for the label.
            )
        )
    )

- Furbeenator

Answer 3

您不需要 自定义迭代器。您需要支持 那段代码。只需传递 正确的 选项：

from django import forms
from django.db.models import Prefetch

class ProductForm(forms.ModelForm):
    class Meta:
        model = Product
        fields = [...]

    def __init__(self, *args, **kwargs):
        super(ProductForm, self).__init__(*args, **kwargs)
        cats = Category.objects \
            .filter(category__isnull=True) \
            .order_by('order') \
            .prefetch_related(Prefetch('subcategories',
                queryset=Category.objects.order_by('order')))
        self.fields['subcategory'].choices = \
            [("", self.fields['subcategory'].empty_label)] \
            + [(c.name, [
                (self.fields['subcategory'].prepare_value(sc),
                    self.fields['subcategory'].label_from_instance(sc))
                for sc in c.subcategories.all()
            ]) for c in cats]

这里，

class Category(models.Model):
    category = models.ForeignKey('self', null=True, on_delete=models.CASCADE,
        related_name='subcategories', related_query_name='subcategory')

class Product(models.Model):
    subcategory = models.ForeignKey(Category, on_delete=models.CASCADE,
        related_name='products', related_query_name='product')

这种技术也可以用于自定义Django管理界面表单，但是在这种情况下不需要使用Meta类。

- x-yuri

---

看起来很有趣。我从未听说过prefetch_related。 - John C

@JohnC 简而言之，当您需要在后续操作中使用父级对象时，请使用 select_related。对于子级对象，请使用 prefetch_related。前者会在同一查询中连接更多的表，而后者则会运行额外的查询，例如 SELECT ... WHERE id IN (...)。但是，如果使用不当，则可能会导致执行更多的查询。 - x-yuri