Topic guide Working with forms Building a formBuilding a form in Django

We don’t need to do much in our name.html template: All the form’s fields and their attributes will be unpacked into HTML markup from that {{ form }} by Django’s template language.

Django documentation

Django provides a rich framework to facilitate the creation of forms and the manipulation of form data.

Reference Widgets Built-in widgetsWidgets handling input of text

classPasswordInput[source] : - input_type: 'password' - template_name: 'django/forms/widgets/password.html' - Renders as: <input type="password" ...>

Topic guide Working with forms Building a form

Suppose you want to create a simple form on your website, in order to obtain the user’s name.

Reference The Forms API

Form.errors.get_json_data(escape_html=False) Returns the errors as a dictionary suitable for serializing to JSON. Form.errors.as_json() returns serialized JSON, while this returns the error data before it’s serialized. The escape_html parameter behaves as described in Form.errors.as_json().

Reference The Forms API Outputting forms as HTML

classErrorList(initlist=None,error_class=None,renderer=None,field_id=None)[source] : By default, forms use django.forms.utils.ErrorList to format validation errors. ErrorList is a list like object where initlist is the list of errors. In addition this class has the following attributes and methods.

Reference Widgets Built-in widgetsWidgets handling input of text

New in Django 5.2. classTelInput[source] : - input_type: 'tel' - template_name: 'django/forms/widgets/tel.html' - Renders as: <input type="tel" ...>

Reference Model field reference Field options

Field.choices[source] A mapping or iterable in the format described below to use as choices for this field.

Reference Model field reference Field types

The default form widget for this field is a TextInput. CharField has the following extra arguments: CharField.max_length : The maximum length (in characters) of the field. The max_length is enforced at the database level and in Django’s validation using MaxLengthValidator.

Topic guide Using the Django authentication system Authentication in web requests

classBaseUserCreationForm[source] : A ModelForm for creating a new user. This is the recommended base class if you need to customize the user creation form. classPasswordChangeForm[source] : A form for allowing a user to change their password.

Topic guide Formsets Validating the number of forms in a formset

If validate_max=True is passed to formset_factory(), validation will also check that the number of forms in the data set, minus those marked for deletion, is less than or equal to max_num.

Topic guide Formsets Validating the number of forms in a formset

If validate_min=True is passed to formset_factory(), validation will also check that the number of forms in the data set, minus those marked for deletion, is greater than or equal to min_num.

Topic guide Creating forms from models ModelForm

Every ModelForm also has a save() method. This method creates and saves a database object from the data bound to the form.

Topic guide Creating forms from models Inline formsets

When overriding methods on InlineFormSet, you should subclass BaseInlineFormSet rather than BaseModelFormSet. For example, if you want to override clean(): See also Overriding clean() on a ModelFormSet. Then when you create your inline formset, pass in the optional argument formset:

Reference The Django admin site InlineModelAdmin objects

The shared features are: form fieldsets fields formfield_overrides exclude filter_horizontal filter_vertical ordering prepopulated_fields get_fieldsets() get_queryset() radio_fields readonly_fields raw_id_fields formfield_for_choice_field() formfield_for_foreignkey() formfield_for_manytomany() has_module_permission() The InlineModelAdmin class adds or customizes: InlineModelAdmin.model : The model which the inline is using. This is required.

Reference The flatpages app How to add, change and delete flatpages

The flatpage form > used in the admin performs this validation check, and can be imported from > django.contrib.flatpages.forms.FlatpageForm and used in your own > views.

Reference

This optional module contains model fields and form fields for a number of PostgreSQL specific data types. NOTE: Django is, and will continue to be, a database-agnostic web framework.

Reference

TIP: Widgets should not be confused with the form fields. > Form fields deal with the logic of input validation and are used directly > in templates.

Reference Widgets Base widget classes

`render(name,value,attrs=None,renderer=None)`[[source]](https://github.com/django/django/blob/stable/5.2.x/django/forms/widgets.py#L327) : Renders a widget to HTML using the given renderer. If `renderer` is `None`, the renderer from the [`FORM_RENDERER`](../settings.md#std-setting-FORM_RENDERER) setting is used. `value_from_datadict(data,files,name)`[[source]](https://github.com/django/django/blob/stable/5.2.x/django/forms/widgets.py#L341) : Given a dictionary of data and this widget’s name, returns the value of this widget.

Reference Model field reference Field types

This handles the storage and retrieval of your files. See Managing files for details on how to provide this object. The default form widget for this field is a ClearableFileInput.