如何对 Django Select 小部件中的选择进行分组？

Posted 2023-02-24

【中文标题】如何对 Django Select 小部件中的选择进行分组？

【英文标题】：How to group the choices in a Django Select widget?

【发布时间】：2011-07-02 03:17:11

【问题描述】：

是否可以在 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 需要一个 tuple 用于命名组，我不确定如何将元组转换为 QuerySet （如果我正确理解 QuerySets 的话，这可能是不可能的指向数据的指针，而不是实际数据）。

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

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'answer：

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

（当然是实际代码，我会从数据库中拉取项目数据。）

与他链接的 djangosn-p 相比，最大的变化似乎是 Django 合并了一些代码，从而可以直接将 Iterator 分配给 choices，而不必重写全班。这是非常好的。

【问题讨论】：

DJANGO: ModelChoiceField optgroup tag的可能重复

【参考方案1】：

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

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

我将不得不弄清楚如何将迭代器写给你，但我猜你只需要让它以自定义方式返回一个元组，而不是默认设置。

很高兴回复 cmets，因为我很确定这个答案需要一点微调:)

在下面编辑

刚刚想到并检查了djangosn-ps，结果有人这样做了： ModelChoiceField with optiongroups。它已经有一年了，所以它可能需要一些调整才能与最新的 django 一起使用，但这正是我的想法。

【讨论】：

成功了，谢谢。既知道 choices 字段，又看到 sn-p 中的代码，终于让它工作了。

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

在***.com/questions/14607331/…打开了一个新问题

@meshantz 我收到错误消息：“GroupedModelChoiceField”对象没有属性“cache_choices”

【参考方案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.
            )
        )
    )

【参考方案3】：

您不需要custom iterators。你需要支持that code。只需传递right 选项：

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 admin form。虽然在这种情况下不需要Meta 类。

【讨论】：

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

@JohnC 简而言之，当您需要父母时，请使用select_related。对于儿童，prefetch_related。第一个在同一个查询中连接更多表，第二个运行额外的查询，例如SELECT ... WHERE id IN (...)。但如果使用不当，最终可能会进行更多查询。