La référence de l’API des formulaires de modèles ModelForm. Pour du contenu d’initiation au sujet de leur utilisation, consultez le guide thématique Création de formulaires à partir de modèles.
Meta des formulaires de modèlesLien vers cette rubrique#L’API _meta est utilisée pour construire les formulaires reflétant des modèles Django. Elle est accessible par l’attribut _meta` de chaque formulaire de modèle et est une instance de ``django.forms.models.ModelFormOptions.
La structure du formulaire généré peut être adaptée en définissant des options de métadonnées en tant qu’attributs de la classe interne Meta. Par exemple :
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\nLes attributs obligatoires sont model, et soit fields, soit exclude. Tous les autres attributs Meta sont facultatifs.
Les attributs facultatifs autres que localized_fields et formfield_callback sont composés par un dictionnaire faisant correspondre un nom de champ de modèle à une valeur. Tout champ non défini dans le dictionnaire va utiliser la valeur par défaut de son type.
error_messagesLien vers cette rubrique#Un dictionnaire faisant correspondre un nom de champ de modèle à un dictionnaire de clés de messages d’erreur (null, blank, invalid, unique, etc.) correspondant à des messages d’erreur personnalisés.
Lorsque un champ n’est pas indiqué, Django se rabat d’abord sur les messages d’erreur définis dans l’attribut django.db.models.Field.error_messages de ce champ de modèle, puis sur les messages d’erreur par défaut de ce type de champ.
excludeLien vers cette rubrique#Un tuple ou une liste de noms de champ de model à exclure du formulaire.
Il est obligatoire de définir fields ou exclude. Si aucun des deux n’est défini, une exception ImproperlyConfigured sera générée. Si attr:~ModelFormOptions.exclude est défini et que fields ne l’est pas, tous les champs du modèle sont inclus dans le formulaire, sauf ces champs exclus.
field_classesLien vers cette rubrique#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.
Lorsque un champ n’est pas indiqué, Django se rabat sur la classe de champ par défaut du champ de modèle.
\nfieldsLien vers cette rubrique#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_callbackLien vers cette rubrique#Une fonction ou autre objet exécutable acceptant un champ de modèle et renvoyant un objet django.forms.Field.
help_textsLien vers cette rubrique#Un dictionnaire faisant correspondre un nom de champ de modèle à un texte d’aide.
\nLorsque un champ n’est pas indiqué, Django se rabat sur la valeur help_text de ce champ de modèle.
labelsLien vers cette rubrique#Un dictionnaire faisant correspondre des noms de champs de modèles à une chaîne qui sera l’étiquette du champ de formulaire.
\nLorsque un champ n’est pas indiqué, Django se rabat sur la valeur verbose_name de ce champ de modèle, puis sur le nom d’attribut du champ.
localized_fieldsLien vers cette rubrique#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.
\nmodelLien vers cette rubrique#Required. The django.db.models.Model to be used for the\nModelForm.
widgetsLien vers cette rubrique#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_factoryLien vers cette rubrique#Renvoie une classe ModelForm pour le modèle donné. Le paramètre facultatif form permet d’indiquer une classe de base pour la construction du ModelForm.
fields est une liste facultative de noms de champs. Quand elle est présente, seuls les champs de cette liste seront inclus dans le formulaire renvoyé.
exclude est une liste facultative de noms de champs. Quand elle est présente, les champs de cette liste sont exclus du formulaire renvoyé, même s’ils figurent dans le paramètre fields.
formfield_callback est un objet exécutable acceptant un champ de modèle et renvoyant un champ de formulaire.
widgets est un dictionnaire faisant correspondre des noms de champs de modèle à des composants de formulaires.
localized_fields est une liste de noms de champs devant être régionalisés.
labels est un dictionnaire faisant correspondre des noms de champs de modèle à des étiquettes.
help_texts est un dictionnaire faisant correspondre des noms de champs de modèle à des textes d’aide.
error_messages est un dictionnaire faisant correspondre des noms de champs de modèle à des dictionnaires de messages d’erreur.
field_classes est un dictionnaire faisant correspondre des noms de champs de modèle à une classe de champ de formulaire.
Voir Fonction de fabrique de ModelForm pour des exemples d’utilisation.
\nVous devez définir explicitement la liste des champs, soit par les paramètres nommés fields ou exclude, soit par les attributs de même nom de la classe interne de formulaire Meta. Voir Sélection des champs à utiliser pour plus d’informations. En omettant toute définition de champs à utiliser, cela aboutira à une exception ImproperlyConfigured.
modelformset_factoryLien vers cette rubrique#Renvoie une classe FormSet pour la classe de modèle donnée.
Les paramètres model, form, fields, exclude, formfield_callback, widgets, localized_fields, labels, help_texts, error_messages et field_classes sont tous transmis à modelform_factory().
Les paramètres formset, extra, can_delete, can_order, max_num, validate_max, min_num, validate_min, absolute_max, can_delete_extra et renderer sont transmis à formset_factory(). Voir Jeux de formulaires pour plus de détails.
L’argument edit_only permet d’empêcher la création de nouveaux objets.
Voir Formulaires groupés de modèles pour des exemples d’utilisation.
\ninlineformset_factoryLien vers cette rubrique#Renvoie un InlineFormSet en utilisant modelformset_factory() avec les valeurs par défaut formset=BaseInlineFormSet, can_delete=True et extra=3.
Si le modèle possède plus d’une clé étrangère ForeignKey vers parent_model, vous devez renseigner le paramètre fk_name.
Voir Sous-formulaires groupés pour des exemples d’utilisation.
\n