Home » Django » How to get the label of a choice in a Django forms ChoiceField?

How to get the label of a choice in a Django forms ChoiceField?

Posted by: admin November 30, 2017 Leave a comment

Questions:

I have a ChoiceField, now how do I get the “label” when I need it?

class ContactForm(forms.Form):
     reason = forms.ChoiceField(choices=[("feature", "A feature"),
                                         ("order", "An order")],
                                widget=forms.RadioSelect)

form.cleaned_data["reason"] would only give me “feature” or “order” or so.

Answers:

This may help:

reason = form.cleaned_data['reason']
reason = dict(form.fields['reason'].choices)[reason]

Questions:
Answers:

See the docs on Model.get_FOO_display(). So, should be something like :

ContactForm.get_reason_display()

In a template, use like this:

{{ OBJNAME.get_FIELDNAME_display }}

Questions:
Answers:

This the easiest way to do this: Model instance reference: Model.get_FOO_display()

You can use this function which will return the display name: ObjectName.get_FieldName_display()

Replace ObjectName with your class name and FieldName with the field of which you need to fetch the display name of.

Questions:
Answers:

If the form instance is bound, you can use

chosen_label = form.instance.get_FOO_display()

Questions:
Answers:

Here is a way I came up with. There may be an easier way. I tested it using python manage.py shell:

>>> cf = ContactForm({'reason': 'feature'})
>>> cf.is_valid()
True
>>> cf.fields['reason'].choices
[('feature', 'A feature')]
>>> for val in cf.fields['reason'].choices:
...     if val[0] == cf.cleaned_data['reason']:
...             print val[1]
...             break
...
A feature

Note: This probably isn’t very Pythonic, but it demonstrates where the data you need can be found.

Questions:
Answers:

You can have your form like this:

#forms.py
CHOICES = [('feature', "A feature"), (order", "An order")]
class ContactForm(forms.Form):
     reason = forms.ChoiceField(choices=CHOICES,
                                widget=forms.RadioSelect)

Then this would give you what you want:

reason = dict(CHOICES)[form.cleaned_data["reason"]]

Questions:
Answers:

I think maybe @webjunkie is right.

If you’re reading from the form from a POST then you would do

def contact_view(request):
    if request.method == 'POST':
        form = ContactForm(request.POST)
        if form.is_valid():
            contact = form.save()
            contact.reason = form.cleaned_data['reason']
            contact.save()

Leave a Reply

Your email address will not be published. Required fields are marked *