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

时间:2011-02-22 16:22:37

标签: python django widget

是否可以在Django select(下拉)窗口小部件中创建命名选择组,当该窗口小部件位于从数据模型自动生成的表单上时?我可以在下面的左侧图片上创建小部件吗?

Two widgets with one grouped

我创建包含命名组的表单的第一个实验是手动完成的,如下所示:

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从模型中自动生成表单的能力。它起作用 - 从某种意义上说它显示了所有选项。但选项不在命名组中,到目前为止,我还没有想出如何这样做 - 如果它甚至可能。

我找到了几个问题,答案是“创建表单构造函数并在那里进行任何特殊处理”。但看起来form.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'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

(当然实际的代码,我会从数据库中提取项目数据。)

他链接的djangosnippet的最大变化似乎是Django已经合并了一些代码,可以直接将Iterator分配给选项,而不是必须覆盖整个类。哪个非常好。

3 个答案:

答案 0 :(得分:13)

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

设置属性以返回自定义迭代器,基于同一模块中的原始ModelChoiceIterator(返回你遇到问题的元组) - 一个新的GroupedModelChoiceIterator或其他一些。

我将不得不完全不知道如何为你编写迭代器,但我的猜测是你需要让它以自定义方式返回一个元组元组,而不是默认设置。

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

以下编辑

刚想到并检查了djangosnippets,结果发现有人这样做了: ModelChoiceField with optiongroups。它已经有一年了,所以可能需要一些调整才能使用最新的django,但这正是我的想法。

答案 1 :(得分:5)

这对我有用,而不是扩展任何当前的django类:

我有一个有机体类型的列表,给出了不同的王国作为选择组。在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.
            )
        )
    )

答案 2 :(得分:1)

您不需要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类。