Model forms

ModelForm API reference. For introductory material about using a ModelForm, see the Skapa formulär från modeller topic guide.

Model form Meta API

class ModelFormOptions[source]

The _meta API is used to build forms that reflect a Django model. It is accessible through the _meta attribute of each model form, and is an django.forms.models.ModelFormOptions instance.

The structure of the generated form can be customized by defining metadata options as attributes of an inner Meta class. For example:

from django.forms import ModelForm
from myapp.models import Book


class BookForm(ModelForm):
    class Meta:
        model = Book
        fields = ["title", "author"]
        help_texts = {
            "title": "The title of the book",
            "author": "The author of the book",
        }
        # ... other attributes

Required attributes are model, and either fields or exclude. All other Meta attributes are optional.

Optional attributes, other than localized_fields and formfield_callback, expect a dictionary that maps a model field name to a value. Any field that is not defined in the dictionary falls back to the field’s default value.

Invalid field names

Invalid or excluded field names in an optional dictionary attribute have no effect, since fields that are not included are not accessed.

Invalid Meta class attributes

You may define any attribute on a Meta class. Typos or incorrect attribute names do not raise an error.

Felmeddelanden

ModelFormOptions.error_messages

A dictionary that maps a model field name to a dictionary of error message keys (null, blank, invalid, unique, etc.) mapped to custom error messages.

When a field is not specified, Django will fall back on the error messages defined in that model field’s django.db.models.Field.error_messages and then finally on the default error messages for that field type.

exclude

ModelFormOptions.exclude

A tuple or list of model field names to be excluded from the form.

Either fields or exclude must be set. If neither are set, an ImproperlyConfigured exception will be raised. If exclude is set and fields is unset, all model fields, except for those specified in exclude, are included in the form.

field_classes

ModelFormOptions.field_classes

A dictionary that maps a model field name to a Field class, which overrides the form_class used in the model field’s Field.formfield() method.

When a field is not specified, Django will fall back on the model field’s default field class.

fält

ModelFormOptions.fields

A tuple or list of model field names to be included in the form. The value '__all__' can be used to specify that all fields should be included.

If any field is specified in exclude, this will not be included in the form despite being specified in fields.

Either fields or exclude must be set. If neither are set, an ImproperlyConfigured exception will be raised.

formfield_callback

ModelFormOptions.formfield_callback

A function or callable that takes a model field and returns a django.forms.Field object.

help_texts

ModelFormOptions.help_texts

A dictionary that maps a model field name to a help text string.

When a field is not specified, Django will fall back on that model field’s help_text.

labels

ModelFormOptions.labels

A dictionary that maps a model field names to a label string.

When a field is not specified, Django will fall back on that model field’s verbose_name and then the field’s attribute name.

localized_fields

ModelFormOptions.localized_fields

A tuple or list of model field names to be localized. The value '__all__' can be used to specify that all fields should be localized.

By default, form fields are not localized, see enabling localization of fields for more details.

modell

ModelFormOptions.model

Required. The django.db.models.Model to be used for the ModelForm.

widgets

ModelFormOptions.widgets

A dictionary that maps a model field name to a django.forms.Widget.

When a field is not specified, Django will fall back on the default widget for that particular type of django.db.models.Field.

Model form factory functions

modellform_fabrik

modelform_factory(model, form=ModelForm, fields=None, exclude=None, formfield_callback=None, widgets=None, localized_fields=None, labels=None, help_texts=None, error_messages=None, field_classes=None)[source]

Returnerar en ModelForm-klass för den angivna modellen. Du kan valfritt skicka ett form-argument som ska användas som utgångspunkt för att konstruera ModelForm.

fields är en valfri lista med fältnamn. Om den anges kommer endast de namngivna fälten att ingå i de returnerade fälten.

exclude är en valfri lista med fältnamn. Om den anges kommer de angivna fälten att uteslutas från de returnerade fälten, även om de finns listade i argumentet fields.

formfield_callback är en callable som tar ett modellfält och returnerar ett formulärfält.

widgets är en ordbok med namn på modellfält som mappas till en widget.

localized_fields är en lista med namn på fält som ska lokaliseras.

labels är en ordbok med namn på modellfält som mappas till en etikett.

help_texts är en ordbok med namn på modellfält som mappats till en hjälptext.

error_messages är en ordbok med namn på modellfält som mappas till en ordbok med felmeddelanden.

field_classes är en ordbok med namn på modellfält som mappas till en formulärfältklass.

Se ModelForm fabriksfunktion för exempel på användning.

Du måste ange listan med fält explicit, antingen via nyckelordsargumenten fields eller exclude, eller motsvarande attribut på formulärets inre Meta-klass. Se Välja de fält som ska användas för mer information. Om du utelämnar någon definition av de fält som ska användas kommer det att resultera i ett ImproperlyConfigured undantag.

modellformset_factory

modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None, widgets=None, validate_max=False, localized_fields=None, labels=None, help_texts=None, error_messages=None, min_num=None, validate_min=False, field_classes=None, absolute_max=None, can_delete_extra=True, renderer=None, edit_only=False)[source]

Returnerar en FormSet-klass för den angivna model-klassen.

Argumenten model, form, fields, exclude, formfield_callback, widgets, localized_fields, labels, help_texts, error_messages och field_classes skickas alla till modelform_factory().

Argumenten formset, extra, can_delete, can_order, max_num, validate_max, min_num, validate_min, absolute_max, can_delete_extra och renderer skickas till formset_factory(). Se formsets för mer information.

Argumentet edit_only gör det möjligt att :ref:``förhindra att nya objekt skapas <model-formsets-edit-only>`.

Se Modellformsatser för exempel på användning.

inlineformset_factory

inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None, widgets=None, validate_max=False, localized_fields=None, labels=None, help_texts=None, error_messages=None, min_num=None, validate_min=False, field_classes=None, absolute_max=None, can_delete_extra=True, renderer=None, edit_only=False)[source]

Returnerar ett InlineFormSet med hjälp av modelformset_factory() med standardvärdena formset=BaseInlineFormSet, can_delete=True och extra=3.

Om din modell har mer än en ForeignKey till parent_model, måste du ange ett fk_name.

Se Inline-formulär för exempel på användning.