#32933: Point users to BoundField.initial instead of
Form.get_initial_for_field()
------------------------------------------------+------------------------
Reporter: Chris Jerdonek | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
Currently, the documentation points users to
`Form.get_initial_for_field(field, field_name)` to get the initial data
for a form field. However, I think it would be better to point users to
`BoundField.initial`, e.g. using the pattern `form[field_name].initial`.
(`BoundField.initial` should also be added to the
[https://docs.djangoproject.com/en/3.2/ref/forms/api/#attributes-of-
boundfield BoundField attribute documentation], as it seems to have been
left out.)
There are a couple reasons I think users should be steered away from
`get_initial_for_field()`. One reason is that the API is simpler because
it doesn't require passing redundant `field` and `field_name` arguments.
Another reason is that going through `BoundField` has the advantage of
using the `BoundField` instance's cache, as `initial` is a cached
property. (I'm going to be filing another ticket related to the latter
difference, later.)
--
Ticket URL: <https://code.djangoproject.com/ticket/32933>
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 [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/052.e3b6c7d9b61f01345e4c63f98fb8ee39%40djangoproject.com.
