How to get rid of the bogus choice generated by RadioSelect of Django Form

Question

I am using ModelForm on Django 1.3.

models.py:

class UserProfile(models.Model):
...
gender = models.CharField(max_length=1, blank=True, choices=(('M', 'Male'), ('F', 'Female'), ('Unspecified', '')), default='M')
...

forms.py:

class UserProfileForm(ModelForm):
    class Meta:
        model = UserProfile
        fields = ('gender')
        widgets = {
            'gender': forms.RadioSelect(),
        }

When this widget is rendered into HTML, I got

<ul> 
<li><label for="id_gender_0"><input type="radio" id="id_gender_0" value="" name="gender" />---------</label></li> 
<li><label for="id_gender_1"><input checked="checked" type="radio" id="id_gender_1" value="M" name="gender" /> Male</label></li> 
<li><label for="id_gender_2"><input type="radio" id="id_gender_2" value="F" name="gender" />Female</label></li> 
<li><label for="id_gender_3"><input type="radio" id="id_gender_3" value="" name="gender" /> Unspecified</label></li> 
</ul>

Problem: How can I get rid of the bogus choice "--------"?

The same problem was brought up by another stackoverflow user months ago (Here). I have tried the accepted solution in there (as you can see) but that didn't work for me.

score 9 · Accepted Answer · edited Apr 07 '13 at 04:32

9

Even without blank=True it shows the extra input. I have created a new Widget:

from itertools import chain
from django.forms import RadioSelect
from django.utils.encoding import force_unicode

class RadioSelectNotNull(RadioSelect):
    def get_renderer(self, name, value, attrs=None, choices=()):
        """Returns an instance of the renderer."""
        if value is None: value = ''
        str_value = force_unicode(value) # Normalize to string.
        final_attrs = self.build_attrs(attrs)
        choices = list(chain(self.choices, choices))
        if choices[0][0] == '':
            choices.pop(0)
        return self.renderer(name, str_value, final_attrs, choices)

edited Apr 07 '13 at 04:32

freyley

4,145
3
20
25

answered Aug 26 '11 at 13:14

NickJ

104
1
4

2

NickJ's answer appears to be correct, but I would like to add one thing. If I'm not mistaken, in the following line choices = list(chain(self.choices, choices)) chain requires an extra import: from itertools import chain – Ben Rosnick Apr 02 '12 at 03:22
How to do it in django 1.11 – Muhammad Zeshan Arif Sep 03 '19 at 15:26

score 6 · Answer 2 · answered Oct 07 '12 at 19:58

6

Set blank=False (or just remove it) and also add default='Unspecified'

answered Oct 07 '12 at 19:58

frnhr

12,354
9
63
90

score 1 · Answer 3 · edited May 13 '15 at 17:37

By default the widget used by ModelChoiceField will have an empty choice at the top of the list.

You can change the text of this label (which is "---------" by default) with the empty_label attribute, or you can disable the empty label entirely by setting empty_label to None:

A custom empty label:

field1 = forms.ModelChoiceField(queryset=..., empty_label="(Nothing)")

No empty label:

field2 = forms.ModelChoiceField(queryset=..., empty_label=None)

score 1 · Answer 4 · answered Apr 28 '11 at 19:53

1

You can set the choices when you set the widget. It's showing the ---- because in your model you have blank=True.

Just use the choices arg of the widget and set it to the choices you set in your model.

answered Apr 28 '11 at 19:53

dting

38,604
10
95
114

This happens to me even when `blank=False` on the model. – Ben Davis Sep 19 '17 at 19:12

score 0 · Answer 5 · answered Sep 04 '19 at 06:52

Django <= 1.10

RadioSelectNotNull widget

from itertools import chain
from django.forms import RadioSelect
from django.utils.encoding import force_unicode

class RadioSelectNotNull(RadioSelect):
"""
A widget which removes the default '-----' option from RadioSelect
"""
    def get_renderer(self, name, value, attrs=None, choices=()):
        """Returns an instance of the renderer."""
        if value is None: value = ''
        str_value = force_unicode(value) # Normalize to string.
        final_attrs = self.build_attrs(attrs)
        choices = list(chain(self.choices, choices))
        if choices[0][0] == '':
            choices.pop(0)
        return self.renderer(name, str_value, final_attrs, choices)

Django >= 1.11

As after Django 1.10 following method is no more in RadioSelect or in its ancestors. That's why upper widget will not remove bogus choice generated by RadioSelect.

def get_renderer(self, name, value, attrs=None, choices=()):

So to remove bogus choice generated by RadioSelect use following widget. I have tested this till Django 2.0

from django.forms import RadioSelect
class RadioSelectNotNull(RadioSelect):
    """
    A widget which removes the default '-----' option from RadioSelect
    """
    def optgroups(self, name, value, attrs=None):
        """Return a list of optgroups for this widget."""
        if self.choices[0][0] == '':
            self.choices.pop(0)
        return super(RadioSelectNotNull, self).optgroups(name, value, attrs)

How to get rid of the bogus choice generated by RadioSelect of Django Form

5 Answers5

Linked