djangodocs.org

1305 sections across all versions Narrow to Django 6.0 (current) →

Topic guide Creating forms from models

inlineformset_factory uses modelformset_factory and passes most of its arguments to modelformset_factory. This means you can use the widgets parameter in much the same way as passing it to modelformset_factory. See Specifying widgets to use in the form with widgets above.

dev

Reference The Forms API

Form.fields You can access the fields of Form instance from its fields attribute: You can alter the field and BoundField of Form instance to change the way it is presented in the form: Beware not to alter the base_fields attribute …

4.2 5.0 5.1 5.2 6.0

label

Reference Form fields Core field arguments

Field.label The label argument lets you specify the “human-friendly” label for this field. This is used when the Field is displayed in a Form.

label_suffix

Reference Form fields

Field.label_suffix The label_suffix argument lets you override the form’s label_suffix on a per-field basis:

dev

help_text

Reference Form fields

If you provide help_text, it will be displayed next to the Field when the Field is rendered by one of the convenience Form methods (e.g., as_ul()). Like the model field’s help_text, this value isn’t HTML-escaped in automatically-generated forms.

dev

localize

Reference Form fields Core field arguments

Field.localize The localize argument enables the localization of form data input, as well as the rendered output. See the format localization documentation for more information.

disabled

Reference Form fields Core field arguments

Field.disabled The disabled boolean argument, when set to True, disables a form field using the disabled HTML attribute so that it won’t be editable by users.

bound_field_class

Reference Form fields

Field.bound_field_class The bound_field_class attribute allows a per-field override of Form.bound_field_class.

dev

has_changed()

Reference Form fields

Field.has_changed()[source] The has_changed() method is used to determine if the field value has changed from the initial value. Returns True or False. See the Form.has_changed documentation for more information.

dev

ChoiceField

Reference Form fields

classChoiceField(**kwargs)[source] : - Default widget: Select - Empty value: '' (an empty string) - Normalizes to: A string. - Validates that the given value exists in the list of choices. - Error message keys: required, invalid_choice

dev

FilePathField

Reference Form fields

classFilePathField(**kwargs)[source] : - Default widget: Select - Empty value: '' (an empty string) - Normalizes to: A string. - Validates that the selected choice exists in the list of choices. - Error message keys: required, invalid_choice

dev

ModelChoiceField

Reference Form fields

classModelChoiceField(**kwargs)[source] : - Default widget: Select - Empty value: None - Normalizes to: A model instance. - Validates that the given id exists in the queryset. - Error message keys: required, invalid_choice

dev

Creating custom fields

Reference Form fields

To do this, create a subclass of django.forms.Field. Its only requirements are that it implement a clean() method and that its __init__() method accept the core arguments mentioned above (required, label, initial, widget, help_text).

dev

Basic forms

Topic guide Form handling with class-based views

Given a contact form: forms.py The view can be constructed using a FormView: views.py Notes: FormView inherits TemplateResponseMixin so template_name can be used here. The default implementation for form_valid() simply redirects to the success_url.

dev