How to generate a dropdown input with a Django ModelForm?

Question

I have the following model:

from django.db import model

class Fruit(models.Model):
    fruit_name = models.CharField(max_length=100)

And A form like this:

from django import forms 
from .models import SomeModel

class FruitForm(forms.ModelForm):
    some_input = forms.CharField(max_length=100)
    class Meta:
        model = Fruit
        fields = ['fruit_name']

This guide shows me how to create a dropdown like this:

fruit = [
    ('orange', 'Oranges'),
    ('cantaloupe', 'Cantaloupes'),
    ('mango', 'Mangoes'),
    ('honeydew', 'Honeydews'),
]
class TestForm(forms.Form):
    some_input = forms.CharField(max_length=100)
    favorite_fruit = forms.CharField(widget=forms.Select(choices=FRUIT_CHOICES))

What I want to happen is for the key/value tuple list to generate based on the fruit_id and fruit_name columns of the Fruit model, without the need to manually insert the data into the FruitForm.

What am I missing here?

willeM_ Van Onsem · Accepted Answer · 2019-08-25 20:51:32Z

Usually you do that with a ModelChoiceField [Django-doc]:

from django import forms

class TestForm(forms.Form):
    some_input = forms.CharField(max_length=100)
    favorite_fruit = forms.ModelChoiceField(queryset=Fruit.objects.all())

In your Fruit model, you then implement the __str__ method to decide how to render your fruit. Here that would be:

from django.db import model

class Fruit(models.Model):
    fruit_name = models.CharField(max_length=100)

    def __str__(self):
        return self.fruit_name

You can alter the queryset= parameter, for example to filter the queryset in advance. For example if you only want to show Fruit that starts with an A, you can filter like:

from django import forms

# example: only show fruit that starts with an A
class TestForm(forms.Form):
    some_input = forms.CharField(max_length=100)
    favorite_fruit = forms.ModelChoiceField(
        queryset=Fruit.objects.filter(fruit_name__startswith='A')
    )

Collectives™ on Stack Overflow

How to generate a dropdown input with a Django ModelForm?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related