Fixed #23681, Fixed #27445 -- Doc'd setting choices for NullBooleanField widgets.

[jacobtylerwalls]

ticket-23681

[matthiask]

Maybe I'm being dense but I still wouldn't know which values to provide to the choices argument. An example would be enormously helpful here, e.g. choices = [("Yes", _("Yes")), ("No", _("No")), ...] – or is it choices = [(0, ...), (1, ...), ...], or choices = [(True, ...), (False, ...), ...]? I'm always unsure.

[jacobtylerwalls]

Agreed an example would be beneficial. In that case, how about moving this tip box to the documentation for models.BooleanField?

[matthiask]

That may be a good idea anyway especially since NullBooleanField has already been deprecated (see https://docs.djangoproject.com/en/dev/releases/3.1/#deprecated-features-3-1)

[matthiask]

Thanks for the example, that's much better!

Sorry for misleading you regarding the place where to put the tip though, I was confused and thought the tip was already part of the models documentation. Also, only models.NullBooleanField has been deprecated, forms.NullBooleanField is still fine. I think the tip is more useful as a part of the forms.NullBooleanField documentation... sorry for the back and forth.

[jacobtylerwalls]

No worries, I sincerely welcome feedback on where this will be most useful. Will swap it in a sec.

[jacobtylerwalls]

Just to clarify ... you suggest I put the tip on the forms.NullBooleanField docs so that a user realizes, hey I don't want forms.NullBooleanField at all when I can set choices upstream on models.BooleanField and get a forms.TypedChoiceField instead, which allows different widgets!

[matthiask]

(I am confused and also confusing tonight, sorry.)

The ticket description mentions forms, that's why I thought that the forms documentation may be the best place to put this tip.

Now that the tip is part of the forms.NullBooleanField documentation I suggest you add a None choice and refer to NullBooleanField directly. The TypedChoiceField doesn't work in this case because it doesn't know how to coerce e.g. a string value of "False".

[jacobtylerwalls]

Figuring out the contemporary relevance of an old ticket is tough -- but what's evident is that something needs to be documented.

My interpretation of the ticket was that OP wanted a way to set choices on a forms.NullBooleanField. The consensus was to document Select widgets as the way to do that. Then years go by and models.NullBooleanField is deprecated but models.BooleanField(null=True) appears. Now, if I take your suggested tip, I don't believe it works -- there appear to be some issues with some of the Select widgets interacting with forms.NullBooleanField that @dcsmith1 was looking at in #12946. So I was trying to step around this whole thing, per the last comment on ticket-23681 and Mariusz's comment on #12946 that really you can just set this all the way upstream on the model layer if you're happy with getting a TypedChoiceField. My first question is -- what is the coercion issue you are experiencing with the approach I suggest? I'm not seeing that, I just see booleans being evaluted.

In sum, this could either wait until #12946 is reviewed, or, it could proceed independently as a way to show folks how to get out of this jam entirely by accepting TypedChoiceField. Given that this ticket is a 6yo documentation ticket and we have another ticket for the development issue, that was my thought -- provide a sufficient way for a Django user to discover how to customize the choices on a models.BooleanField where null may be either True or False. But I'm open to taking another direction here.

[carltongibson]

OK, super. Thanks all for the work here. 🥇