#23681: NullBooleanSelect should have choices kwarg
-----------------------------+--------------------------------------
Reporter: benjaoming | Owner: benjaoming
Type: New feature | Status: assigned
Component: Forms | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+--------------------------------------
Changes (by benjaoming):
* status: new => assigned
* needs_better_patch: => 0
* needs_tests: => 0
* owner: nobody => benjaoming
* needs_docs: => 0
Old description:
> `NullBooleanSelect` is responsible of making the values 1, 2, and 3 turn
> into None, True or False. That's why having custom "choices" kwarg is
> perhaps a bit over the top. Well, it's pretty meaningless to have a
> utility class if you start passing a choices kwarg that contains half of
> the code that makes up NullBooleanSelect.
>
> However, I need one small feature from this widget! Namely, that the
> following...
>
> {{{
> class NullBooleanSelect(Select):
> """
> A Select Widget intended to be used with NullBooleanField.
> """
> def __init__(self, attrs=None):
> choices = (('1', ugettext_lazy('Unknown')),
> ('2', ugettext_lazy('Yes')),
> ('3', ugettext_lazy('No')))
> super(NullBooleanSelect, self).__init__(attrs, choices)
> }}}
>
> ...is changed to:
>
> {{{
> class NullBooleanSelect(Select):
> """
> A Select Widget intended to be used with NullBooleanField.
> """
> def __init__(self, empty_label=None, attrs=None):
> choices = (('1', empty_label or ugettext_lazy('Unknown')),
> ('2', ugettext_lazy('Yes')),
> ('3', ugettext_lazy('No')))
> super(NullBooleanSelect, self).__init__(attrs, choices)
> }}}
>
> The motivation is that I often leave out labels to have them put as the
> default first option of the Select. An example use:
>
> {{{
> class MyForm(forms.Form):
> has_payments = forms.NullBooleanField(
> label="",
> required=False,
> widget=NullBooleanSelect(empty_label=_(u"Has previous
> payments?"))
> help_text=_(u"Only show subscriptions that have previously been
> charged"),
> )
>
> }}}
>
> Even more preferable, would be to place the `empty_label` kwarg in
> `NullBooleanField`, as that would match the options for ModelChoiceField.
New description:
`NullBooleanSelect` is responsible of making the values 1, 2, and 3 turn
into None, True or False. That's very nice of it, however it does not
allow to customize the texts of the choices.
I'm not sure if exposing the internal 1, 2, 3 representation is a good
idea, but it would seem okay since it follows the convention of other
Select widgets. Ideally, I would like to see this...
{{{
class NullBooleanSelect(Select):
"""
A Select Widget intended to be used with NullBooleanField.
"""
def __init__(self, attrs=None):
choices = (('1', ugettext_lazy('Unknown')),
('2', ugettext_lazy('Yes')),
('3', ugettext_lazy('No')))
super(NullBooleanSelect, self).__init__(attrs, choices)
}}}
...changed to:
{{{
class NullBooleanSelect(Select):
"""
A Select Widget intended to be used with NullBooleanField.
"""
def __init__(self, choices=None, attrs=None):
if not choices:
choices = (('1', empty_label or ugettext_lazy('Unknown')),
('2', ugettext_lazy('Yes')),
('3', ugettext_lazy('No')))
super(NullBooleanSelect, self).__init__(attrs, choices)
}}}
The motivation is that I often leave out labels to have them put as the
default first option of the Select. An example use:
{{{
class MyForm(forms.Form):
gender = forms.NullBooleanField(
label="",
required=False,
widget=NullBooleanSelect(choices=[("1", "Male and female"),
("2", "Only female"),
("3", "Only Male")])
help_text=_(u"Only show subscriptions that have previously been
charged"),
)
}}}
Even more preferable, would be to place the `choices` kwarg in
`NullBooleanField`, as that would match the options for ChoiceField.
<b>Updated</b> In the original issue report, I put `empty_label` but
realized that when selecting "Yes", it was impossible for the user to see
what "Yes" was the answer to.
--
--
Ticket URL: <https://code.djangoproject.com/ticket/23681#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/068.a2467fa9c6d313fb43a8fb0d317f0836%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
