ModelForm API reference. For introductory material about using a\nModelForm, see the Creating forms from models topic guide.
Meta APILink to this heading#The _meta API is used to build forms that reflect a Django model. It is\naccessible through the _meta attribute of each model form, and is a\ndjango.forms.models.ModelFormOptions instance.
The structure of the generated form can be customized by defining metadata\noptions as attributes of an inner Meta class. For example:
from django.forms import ModelForm\nfrom myapp.models import Book\n\n\nclass BookForm(ModelForm):\n class Meta:\n model = Book\n fields = ["title", "author"]\n help_texts = {\n "title": "The title of the book",\n "author": "The author of the book",\n }\n # ... other attributes\nRequired attributes are model, and either\nfields or exclude. All\nother Meta attributes are optional.
Optional attributes, other than localized_fields and\nformfield_callback, expect a dictionary that maps a\nmodel field name to a value. Any field that is not defined in the dictionary\nfalls back to the field’s default value.
error_messagesLink to this heading#A dictionary that maps a model field name to a dictionary of error message\nkeys (null, blank, invalid, unique, etc.) mapped to custom\nerror messages.
When a field is not specified, Django will fall back on the error messages\ndefined in that model field’s django.db.models.Field.error_messages\nand then finally on the default error messages for that field type.
excludeLink to this heading#A tuple or list of model field names to be\nexcluded from the form.
Either fields or\nexclude must be set. If neither are set, an\nImproperlyConfigured exception will be\nraised. If exclude is set and\nfields is unset, all model fields, except for\nthose specified in exclude, are included in the\nform.
field_classesLink to this heading#A dictionary that maps a model field name to a Field\nclass, which overrides the form_class used in the model field’s\nField.formfield() method.
When a field is not specified, Django will fall back on the model field’s\ndefault field class.
\nfieldsLink to this heading#A tuple or list of model field names to be\nincluded in the form. The value '__all__' can be used to specify that\nall fields should be included.
If any field is specified in exclude, this will\nnot be included in the form despite being specified in\nfields.
Either fields or\nexclude must be set. If neither are set, an\nImproperlyConfigured exception will be\nraised.
formfield_callbackLink to this heading#A function or callable that takes a model field and returns a\ndjango.forms.Field object.
help_textsLink to this heading#A dictionary that maps a model field name to a help text string.
\nWhen a field is not specified, Django will fall back on that model field’s\nhelp_text.
labelsLink to this heading#A dictionary that maps a model field names to a label string.
\nWhen a field is not specified, Django will fall back on that model field’s\nverbose_name and then the field’s attribute\nname.
localized_fieldsLink to this heading#A tuple or list of model field names to be\nlocalized. The value '__all__' can be used to specify that all fields\nshould be localized.
By default, form fields are not localized, see\nenabling localization of fields for more details.
\nmodelLink to this heading#Required. The django.db.models.Model to be used for the\nModelForm.
widgetsLink to this heading#A dictionary that maps a model field name to a\ndjango.forms.Widget.
When a field is not specified, Django will fall back on the default widget\nfor that particular type of django.db.models.Field.
modelform_factoryLink to this heading#Returns a ModelForm class for the given model.\nYou can optionally pass a form argument to use as a starting point for\nconstructing the ModelForm.
fields is an optional list of field names. If provided, only the named\nfields will be included in the returned fields.
exclude is an optional list of field names. If provided, the named\nfields will be excluded from the returned fields, even if they are listed\nin the fields argument.
formfield_callback is a callable that takes a model field and returns\na form field.
widgets is a dictionary of model field names mapped to a widget.
localized_fields is a list of names of fields which should be\nlocalized.
labels is a dictionary of model field names mapped to a label.
help_texts is a dictionary of model field names mapped to a help text.
error_messages is a dictionary of model field names mapped to a\ndictionary of error messages.
field_classes is a dictionary of model field names mapped to a form\nfield class.
See ModelForm factory function for example usage.
\nYou must provide the list of fields explicitly, either via keyword\narguments fields or exclude, or the corresponding attributes on the\nform’s inner Meta class. See Selecting the fields to use for\nmore information. Omitting any definition of the fields to use will result\nin an ImproperlyConfigured exception.
modelformset_factoryLink to this heading#Returns a FormSet class for the given model class.
Arguments model, form, fields, exclude,\nformfield_callback, widgets, localized_fields, labels,\nhelp_texts, error_messages, and field_classes are all passed\nthrough to modelform_factory().
Arguments formset, extra, can_delete, can_order,\nmax_num, validate_max, min_num, validate_min,\nabsolute_max, can_delete_extra, and renderer are passed\nthrough to formset_factory(). See\nformsets for details.
The edit_only argument allows preventing new objects creation.
See Model formsets for example usage.
\ninlineformset_factoryLink to this heading#Returns an InlineFormSet using modelformset_factory() with\ndefaults of formset=BaseInlineFormSet,\ncan_delete=True, and extra=3.
If your model has more than one ForeignKey to\nthe parent_model, you must specify a fk_name.
See Inline formsets for example usage.
\n