Lorsque vous créez une classe Form, la partie la plus importante est de définir les champs du formulaire. Chaque champ possède sa propre logique de validation, ainsi que quelques autres points d’entrée.
Même si l’emploi principal des classes Field concerne la définition de classes Form, il est aussi possible de les instancier et de les utiliser directement pour obtenir une meilleure idée de leur fonctionnement. Chaque instance Field possède une méthode clean() acceptant un seul paramètre et qui renvoie une valeur « nettoyée » ou qui génère une exception django.core.exceptions.ValidationError:
>>> from django import forms\n>>> f = forms.EmailField()\n>>> f.clean("foo@example.com")\n'foo@example.com'\n>>> f.clean("invalid email address")\nTraceback (most recent call last):\n...\nValidationError: ['Enter a valid email address.']\nChaque constructeur de classe Field accepte au moins trois paramètres. Certaines classes acceptent d’autres paramètres spécifiques à la classe, mais ceux qui suivent sont toujours acceptés :
requiredLien vers cette rubrique#Par défaut, chaque classe Field suppose qu’une valeur est obligatoire, ce qui fait que si vous ne fournissez pas de valeur (que ce soit None ou une chaîne vide("")), clean() génère une exception ValidationError:
>>> from django import forms\n>>> f = forms.CharField()\n>>> f.clean("foo")\n'foo'\n>>> f.clean("")\nTraceback (most recent call last):\n...\nValidationError: ['This field is required.']\n>>> f.clean(None)\nTraceback (most recent call last):\n...\nValidationError: ['This field is required.']\n>>> f.clean(0)\n'0'\n>>> f.clean(True)\n'True'\n>>> f.clean(False)\n'False'\nPour indiquer qu’un champ n’est pas obligatoire, passez required=False au constructeur de Field:
>>> f = forms.CharField(required=False)\n>>> f.clean("foo")\n'foo'\n>>> f.clean("")\n''\n>>> f.clean(None)\n''\n>>> f.clean(0)\n'0'\n>>> f.clean(True)\n'True'\n>>> f.clean(False)\n'False'\nLorsque required=False est défini pour un champ Field et que vous fournissez une valeur vide à clean(), la valeur renvoyée est une valeur vide normalisée et aucune exception ValidationError n’est générée. Pour CharField, la valeur renvoyée correspond à empty_value qui est une chaîne vide par défaut. Pour les autres classes Field, il peut s’agir de None (cela varie en fonction du champ).
Les composants des champs de formulaire obligatoires possèdent l’attribut HTML required. Il est possible de désactiver cela en définissant l’attribut Form.use_required_attribute à False. L’attribut required n’est pas ajouté aux formulaires groupés car la validation des navigateurs n’est pas toujours correcte quand on ajoute ou qu’on supprime de tels formulaires.
labelLien vers cette rubrique#Le paramètre label permet d’indiquer une étiquette conviviale pour le champ. Cette valeur est utilisée lorsque le champ Field est affiché dans un formulaire Form.
Comme expliqué dans Affichage des formulaires en HTML, l’étiquette par défaut d’un champ Field est générée à partir du nom de champ en convertissant tous les soulignements en espaces et en mettant en majuscule la première lettre. Indiquez une chaîne dans label si ce comportement par défaut ne produit pas un résultat convenable. Utilisez une chaîne vide ("") pour masquer l’étiquette.
Voici un exemple complet de formulaire implémentant label pour deux de ses champs. Nous avons indiqué auto_id=False pour simplifier l’affichage :
>>> from django import forms\n>>> class CommentForm(forms.Form):\n... name = forms.CharField(label="Your name")\n... url = forms.URLField(label="Your website", required=False)\n... comment = forms.CharField()\n...\n>>> f = CommentForm(auto_id=False)\n>>> print(f)\n<div>Your name:<input type="text" name="name" required></div>\n<div>Your website:<input type="url" name="url"></div>\n<div>Comment:<input type="text" name="comment" required></div>\nlabel_suffixLien vers cette rubrique#Le paramètre label_suffix permet de surcharger l’attribut label_suffix d’un formulaire pour un champ particulier :
>>> class ContactForm(forms.Form):\n... age = forms.IntegerField()\n... nationality = forms.CharField()\n... captcha_answer = forms.IntegerField(label="2 + 2", label_suffix=" =")\n...\n>>> f = ContactForm(label_suffix="?")\n>>> print(f)\n<div><label for="id_age">Age?</label><input type="number" name="age" required id="id_age"></div>\n<div><label for="id_nationality">Nationality?</label><input type="text" name="nationality" required id="id_nationality"></div>\n<div><label for="id_captcha_answer">2 + 2 =</label><input type="number" name="captcha_answer" required id="id_captcha_answer"></div>\ninitialLien vers cette rubrique#Le paramètre initial permet d’indiquer la valeur initiale à utiliser lors de l’affichage HTML du champ dans un formulaire Form non lié.
Pour indiquer des données initiales dynamiques, voir le paramètre Form.initial.
Le cas d’utilisation typique est lorsque l’on veut afficher un formulaire vierge dans lequel un champ contient initialement une valeur. Par exemple :
\n>>> from django import forms\n>>> class CommentForm(forms.Form):\n... name = forms.CharField(initial="Your name")\n... url = forms.URLField(initial="https://")\n... comment = forms.CharField()\n...\n>>> f = CommentForm(auto_id=False)\n>>> print(f)\n<div>Name:<input type="text" name="name" value="Your name" required></div>\n<div>Url:<input type="url" name="url" value="https://" required></div>\n<div>Comment:<input type="text" name="comment" required></div>\nVous vous demandez peut-être pourquoi on ne passe pas simplement un dictionnaire de valeurs initiales dans le paramètre data au moment d’afficher le formulaire ? Le problème de cette solution est que cela provoque la validation des données et que le résultat HTML contiendra alors d’éventuelles erreurs de validation :
>>> class CommentForm(forms.Form):\n... name = forms.CharField()\n... url = forms.URLField()\n... comment = forms.CharField()\n...\n>>> default_data = {"name": "Your name", "url": "https://"}\n>>> f = CommentForm(default_data, auto_id=False)\n>>> print(f)\n<div>Name:\n <input type="text" name="name" value="Your name" required>\n</div>\n<div>Url:\n <ul class="errorlist"><li>Enter a valid URL.</li></ul>\n <input type="url" name="url" value="https://" required aria-invalid="true">\n</div>\n<div>Comment:\n <ul class="errorlist"><li>This field is required.</li></ul>\n <input type="text" name="comment" required aria-invalid="true">\n</div>\nC’est pourquoi les valeurs initiales ne sont affichées que pour les formulaires non liés. Pour les formulaires liés, le résultat HTML utilise les données liées.
\nNotez également que les valeurs initiales ne sont pas utilisées comme données de repli dans la validation lorsqu’une valeur de champ est manquante. Les valeurs initiales sont uniquement destinées à l’affichage initial d’un formulaire :
\n>>> class CommentForm(forms.Form):\n... name = forms.CharField(initial="Your name")\n... url = forms.URLField(initial="https://")\n... comment = forms.CharField()\n...\n>>> data = {"name": "", "url": "", "comment": "Foo"}\n>>> f = CommentForm(data)\n>>> f.is_valid()\nFalse\n# The form does *not* fallback to using the initial values.\n>>> f.errors\n{'url': ['This field is required.'], 'name': ['This field is required.']}\nAu lieu d’une constante, il est aussi possible de transmettre un objet exécutable :
\n>>> import datetime\n>>> class DateForm(forms.Form):\n... day = forms.DateField(initial=datetime.date.today)\n...\n>>> print(DateForm())\n<div><label for="id_day">Day:</label><input type="text" name="day" value="2023-02-11" required id="id_day"></div>\nL’objet exécutable ne sera évalué qu’au moment où le formulaire non lié est affiché, et non pas au moment de sa définition.
\nwidgetLien vers cette rubrique#Le paramètre widget permet d’indiquer une classe Widget à utiliser lors du rendu HTML de ce champ. Voir Composants de formulaires (« widgets ») pour plus d’informations.
help_textLien vers cette rubrique#Le paramètre help_text vous permet de définir du texte descriptif pour ce champ. S’il est défini, il sera affiché près du champ lorsque celui-ci sera affiché en HTML par l’une des méthodes de raccourci de Form (par ex. as_ul()).
Tout comme l’attribut help_text d’un champ de modèle, cette valeur n’est pas sujette à l’échappement HTML dans les formulaires générés automatiquement.
Voici un exemple complet de formulaire implémentant help_text pour deux de ses champs. Nous avons indiqué auto_id=False pour simplifier l’affichage :
>>> from django import forms\n>>> class HelpTextContactForm(forms.Form):\n... subject = forms.CharField(max_length=100, help_text="100 characters max.")\n... message = forms.CharField()\n... contact_email = forms.EmailField(help_text="Your email (so we can reply).")\n...\n>>> f = HelpTextContactForm(auto_id=False)\n>>> print(f)\n<div>Subject:<div class="helptext">100 characters max.</div><input type="text" name="subject" maxlength="100" required></div>\n<div>Message:<input type="text" name="message" required></div>\n<div>Contact email:<div class="helptext">Your email (so we can reply).</div><input type="email" name="contact_email" maxlength="320" required></div>\nLorsqu’un champ possède un texte d’aide, celui-ci est associé à son composant de saisie par l’attribut HTML aria-describedby. Si le composant est produit dans un <fieldset>, alors aria-describedby est ajouté à cet élément, sinon il est ajouté à l’élément <input> du composant.
>>> from django import forms\n>>> class UserForm(forms.Form):\n... username = forms.CharField(max_length=255, help_text="e.g., user@example.com")\n...\n>>> f = UserForm()\n>>> print(f)\n<div>\n<label for="id_username">Username:</label>\n<div class="helptext" id="id_username_helptext">e.g., user@example.com</div>\n<input type="text" name="username" maxlength="255" required aria-describedby="id_username_helptext" id="id_username">\n</div>\nLors de l’ajout d’un attribut aria-describedby personnalisé, prenez soin d’inclure également l’identifiant id de l’élément help_text (si utilisé) dans l’ordre souhaité. Pour les lecteurs d’écran, les descriptions seront lues dans leur ordre d’apparition dans aria-describedby:
>>> class UserForm(forms.Form):\n... username = forms.CharField(\n... max_length=255,\n... help_text="e.g., user@example.com",\n... widget=forms.TextInput(\n... attrs={"aria-describedby": "custom-description id_username_helptext"},\n... ),\n... )\n...\n>>> f = UserForm()\n>>> print(f["username"])\n<input type="text" name="username" aria-describedby="custom-description id_username_helptext" maxlength="255" id="id_username" required>\nerror_messagesLien vers cette rubrique#Le paramètre error_messages permet de redéfinir les messages par défaut que le champ renvoie. Passez un dictionnaire dont les clés correspondent aux messages d’erreur que vous voulez redéfinir. Par exemple, voici le message d’erreur par défaut :
>>> from django import forms\n>>> generic = forms.CharField()\n>>> generic.clean("")\nTraceback (most recent call last):\n ...\nValidationError: ['This field is required.']\nEt voici un message d’erreur personnalisé :
\n>>> name = forms.CharField(error_messages={"required": "Please enter your name"})\n>>> name.clean("")\nTraceback (most recent call last):\n ...\nValidationError: ['Please enter your name']\nDans la section Classes de champs Field intégrées ci-dessous, chaque champ Field définit les clés de messages d’erreur qu’il utilise.
validatorsLien vers cette rubrique#Le paramètre validators permet de définir une liste de fonctions de validation pour le champ.
Consultez la documentation des validateurs pour plus d’informations.
\nlocalizeLien vers cette rubrique#Le paramètre localize active la régionalisation des données de formulaires, aussi bien au niveau de la saisie que de l’affichage produit.
Consultez la documentation sur la régionalisation de la mise en forme pour plus d’informations.
\ndisabledLien vers cette rubrique#Le paramètre booléen disabled, lorsqu’il est défini à True, désactive un champ de formulaire en utilisant l’attribut HTML disabled afin qu’il ne soit pas modifiable par les utilisateurs. Même si quelqu’un forçait la modification de la valeur du champ soumis au serveur, elle serait ignorée en faveur de la valeur fournie initialement au formulaire.
template_nameLien vers cette rubrique#L’argument template_name permet d’utiliser un gabarit personnalisé lorsque le champ est produit avec as_field_group(). Par défaut, cette valeur est "django/forms/field.html". Elle peut être adaptée pour chaque champ en surchargeant cet attribut ou plus généralement en surchargeant le gabarit par défaut, voir aussi Redéfinition des gabarits de champs intégrés.
bound_field_classLien vers cette rubrique#L’attribut bound_field_class permet une surcharge par champ de Form.bound_field_class.
has_changed()Lien vers cette rubrique#La méthode has_changed() est utilisée pour déterminer si la valeur du champ a été modifiée par rapport à sa valeur initiale. Renvoie True ou False.
Consultez la documentation de Form.has_changed pour plus de détails.
Field intégréesLien vers cette rubrique#Bien évidemment, la bibliothèque des formulaires est livrée avec une série de classes Field représentant les besoins de validation les plus courants. Cette section décrit chaque champ intégré dans Django.
Pour chaque champ, nous indiquons le composant utilisé par défaut quand widget n’est pas précisé. Nous indiquons également la valeur renvoyée lorsqu’une valeur vide est fournie (voir la section sur required ci-dessus pour comprendre ce que cela signifie).
BooleanFieldLien vers cette rubrique#Composant par défaut : CheckboxInput
Valeur vide : False
Est normalisé en : une valeur Python True ou False.
Valide que la valeur est True (signifiant par exemple que la case à cocher est cochée) si required=True pour ce champ.
Clés de messages d’erreur : required
CharFieldLien vers cette rubrique#Composant par défaut : TextInput
Valeur vide : ce qui a été indiqué dans empty_value.
Est normalisé en : une chaîne.
Utilise MaxLengthValidator et MinLengthValidator si max_length et min_length sont fournis. Sinon, toutes les entrées sont valides.
Clés de messages d’erreur : required, max_length, min_length
Possède les paramètres facultatifs suivants liés à la validation :
\nQuand ils sont fournis, ces paramètres garantissent que la chaîne de caractères correspond au maximum ou au minimum à la longueur donnée.
\nSi True (valeur par défaut), la valeur sera épurée d’éventuelles espaces initiales ou finales.
La valeur à utiliser pour représenter une valeur vide. Contient une chaîne vide par défaut.
\nChoiceFieldLien vers cette rubrique#Composant par défaut : Select
Valeur vide : '' (une chaîne vide)
Est normalisé en : une chaîne.
Valide que la valeur donnée existe dans la liste à choix.
Clés de messages d’erreur : required, invalid_choice
Le message d’erreur invalid_choice peut contenir %(value)s, qui sera remplacé par le choix sélectionné.
Accepte un paramètre supplémentaire :
\nSoit un object itérable de tuples à 2 valeurs à utiliser comme liste de choix pour ce champ, soit un type énumération, soit un objet exécutable qui renvoie un tel objet itérable. Ce paramètre accepte les mêmes formats que le paramètre choices d’un champ de modèle. Consultez la documentation des champs de modèles sur les choix pour plus de détails. Si le paramètre est un exécutable, il est évalué lors de chaque initialisation du formulaire contenant le champ, en plus de l’évaluation au moment du rendu. Par défaut, c’est une liste vide.
DateFieldLien vers cette rubrique#Composant par défaut : DateInput
Valeur vide : None
Est normalisé en : un objet Python datetime.date.
Valide que la valeur donnée est un objet datetime.date, datetime.datetime ou une chaîne mise en forme dans un format de date particulier.
Clés de messages d’erreur : required, invalid
Accepte un paramètre facultatif :
\nUn objet itérable de chaînes de format utilisées pour essayer de convertir une chaîne en un objet datetime.date valide.
Si aucun paramètre input_formats n’est indiqué, les formats d’entrée par défaut sont lus dans la clé DATE_INPUT_FORMATS du format de langue actif, ou dans le réglage DATE_INPUT_FORMATS si la régionalisation est désactivée. Voir aussi la régionalisation des formats.
DateTimeFieldLien vers cette rubrique#Composant par défaut : DateTimeInput
Valeur vide : None
Est normalisé en : un objet Python datetime.datetime.
Valide que la valeur donnée est un objet datetime.datetime, datetime.date ou une chaîne mise en forme dans un format de date/heure particulier.
Clés de messages d’erreur : required, invalid
Accepte un paramètre facultatif :
\nUn objet itérable de chaînes de format utilisées pour essayer de convertir une chaîne en un objet datetime.datetime valide, en plus des formats ISO 8601.
Le champ accepte toujours les chaînes mises en forme selon le format ISO 8601 ou apparenté reconnues par parse_datetime(). Voici quelques exemples :
'2006-10-25 14:30:59'
'2006-10-25T14:30:59'
'2006-10-25 14:30'
'2006-10-25T14:30'
'2006-10-25T14:30Z'
'2006-10-25T14:30+02:00'
'2006-10-25'
Si aucun paramètre input_formats n’est indiqué, les formats d’entrée par défaut sont lus dans les clés DATETIME_INPUT_FORMATS et DATE_INPUT_FORMATS du format de langue actif, ou dans les réglages DATETIME_INPUT_FORMATS et DATE_INPUT_FORMATS si la régionalisation est désactivée. Voir aussi la régionalisation des formats.
DecimalFieldLien vers cette rubrique#Composant par défaut : NumberInput lorsque Field.localize vaut False, sinon TextInput.
Valeur vide : None
Est normalisé en : un objet Python decimal.
Valide que la valeur donnée est un nombre décimal. Utilise MaxValueValidator et MinValueValidator si max_value et min_value sont fournis. Utilise StepValueValidator si step_size est fourni. Les espaces de début et de fin sont ignorés.
Clés de messages d’erreur : required, invalid, max_value, min_value, max_digits, max_decimal_places, max_whole_digits, step_size.
Les messages d’erreur max_value et min_value peuvent contenir %(limit_value)s, qui sera remplacé par la limite concernée. Sur le même principe, les messages d’erreur max_digits, max_decimal_places et max_whole_digits peuvent contenir %(max)s.
Accepte cinq paramètres facultatifs :
\nCes paramètres contrôlent les intervalles de valeurs autorisées dans le champ et doivent être exprimés en valeurs decimal.Decimal.
Le nombre maximum de chiffres autorisés dans la valeur (avant et après le point décimal, sans tenir compte des zéros initiaux).
\nLe nombre maximal de décimales autorisées.
\nLimite la validité des entrées à un multiple entier de step_size. Si min_value est aussi indiquée, elle est ajoutée comme valeur de décalage pour déterminer si la taille de pas correspond.
DurationFieldLien vers cette rubrique#Composant par défaut : TextInput
Valeur vide : None
Est normalisé en : un objet Python timedelta.
Valide que la valeur donnée est une chaîne qui peut être convertie en une différence de temps timedelta. La valeur doit être comprise entre datetime.timedelta.min et datetime.timedelta.max.
Clés de messages d’erreur : required, invalid, overflow.
Accepte tout format que parse_duration() peut analyser.
EmailFieldLien vers cette rubrique#Composant par défaut : EmailInput
Valeur vide : ce qui a été indiqué dans empty_value.
Est normalisé en : une chaîne.
Utilise EmailValidator pour valider que la valeur donnée est une adresse de courriel valide, en utilisant une expression régulière moyennement complexe.
Clés de messages d’erreur : required, invalid
Possède les paramètres facultatifs max_length, min_length et empty_value, qui fonctionnent exactement comme pour CharField. Le paramètre max_length contient par défaut 320 (voir RFC 3696 Section 3).
FileFieldLien vers cette rubrique#Composant par défaut : ClearableFileInput
Valeur vide : None
Est normalisé en : un objet UploadedFile englobant le contenu du fichier et son nom dans un seul objet.
Peut valider que des données de fichier non vides ont été fournies au formulaire.
Clés de messages d’erreur : required, invalid, missing, empty, max_length
Accepte les paramètres facultatifs pour la validation, max_length et allow_empty_file. S’ils sont présents, ils garantissent respectivement que la longueur du nom de fichier ne dépasse pas la longueur indiquée et que la validation passe même quand le contenu du fichier est vide.
Pour en savoir plus au sujet de l’objet UploadedFile, consultez la documentation sur les envois de fichiers.
Lorsque vous utilisez un champ FileField dans un formulaire, vous ne devez pas oublier de lier les données de fichier au formulaire.
L’erreur max_length porte sur la longueur du nom de fichier. Dans le message d’erreur de cette clé, %(max)d sera remplacé par la longueur maximale du nom de fichier et %(length)d sera remplacé par la longueur effective du nom de fichier.
FilePathFieldLien vers cette rubrique#Composant par défaut : Select
Valeur vide : '' (une chaîne vide)
Est normalisé en : une chaîne.
Valide que le choix sélectionné existe dans la liste à choix.
Clés de messages d’erreur : required, invalid_choice
Ce champ permet de choisir parmi des fichiers dans un répertoire désigné. Il accepte cinq paramètres supplémentaires ; seul path est obligatoire :
Le chemin absolu vers le répertoire dont le contenu doit être présent dans la liste. Ce répertoire doit exister.
\nSi False (valeur par défaut), seul le contenu au premier niveau de path sera à disposition dans les choix possibles. Si True, le répertoire sera parcouru récursivement et tous ses descendants seront inclus dans les choix possibles.
Un motif d’expression régulière ; seuls les fichiers dont les noms correspondent à cette expression seront disponibles dans la liste à choix.
\nFacultatif. Vaut True ou False. La valeur par défaut est True. Indique si les fichiers de l’emplacement spécifié doivent être inclus. Il faut que l’une des deux valeurs, ce champ ou allow_folders, soit True.
Facultatif. Vaut True ou False. La valeur par défaut est False. Indique si tous les répertoires à l’intérieur de l’emplacement spécifié doivent être inclus. Il faut que l’une des deux valeurs, ce champ ou allow_files, soit True.
FilePathField has the following method:
Scans the directory at path and refreshes the field’s\nchoices. This is called automatically during __init__(), but it can\nalso be called explicitly to pick up files added to the directory\nafter the field was first instantiated (usually at server startup). For\nexample, call it in a form’s __init__() to get fresh choices per\nrequest:
class MyForm(forms.Form):\n my_file = forms.FilePathField(path="/path/to/dir")\n\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.fields["my_file"].set_choices()\nFloatFieldLien vers cette rubrique#Composant par défaut : NumberInput lorsque Field.localize vaut False, sinon TextInput.
Valeur vide : None
Est normalisé en : un objet Python float.
Valide que la valeur donnée est un nombre à virgule (float). Utilise MaxValueValidator et MinValueValidator si max_value et min_value sont fournis. Utilise StepValueValidator si step_size est fourni. Les espaces de début et de fin sont permis, comme pour la fonction float() de Python.
Clés de messages d’erreur : required, invalid, max_value, min_value, step_size.
Accepte trois paramètres facultatifs :
\nCes paramètres contrôlent l’intervalle des valeurs autorisées dans ce champ.
\nLimite la validité des entrées à un multiple entier de step_size. Si min_value est aussi indiquée, elle est ajoutée comme valeur de décalage pour déterminer si la taille de pas correspond.
GenericIPAddressFieldLien vers cette rubrique#Un champ contenant soit une adresse IPv4, soit une adresse IPv6.
\nComposant par défaut : TextInput
Valeur vide : '' (une chaîne vide)
Est normalisé en : une chaîne. Les adresses IPv6 sont normalisées selon la description ci-dessous.
Valide que la valeur donnée est une adresse IP valide.
Clés de messages d’erreur : required, invalid, max_length
La normalisation d’adresse IPv6 respecte la section 2.2 de la RFC 4291 Section 2.2, y compris l’utilisation du format IPv4 suggéré dans le 3e paragraphe de cette section, comme ::ffff:192.0.2.0. Par exemple, 2001:0::0:01 sera normalisé en 2001::1 et ::ffff:0a0a:0a0a en ::ffff:10.10.10.10. Tous les caractères sont convertis en minuscules.
Accepte trois paramètres facultatifs :
\nLimite la validité des saisies au protocole indiqué. Les valeurs possibles sont 'both' (les deux protocoles acceptés, valeur par défaut), 'IPv4' ou 'IPv6'. La correspondance n’est pas sensible à la casse.
Décode les adresses IPv4 mappées comme ::ffff:192.0.2.1. Si cette option est activée, cette adresse serait décodée en 192.0.2.1. L’option est désactivée par défaut. Utilisable uniquement quand protocol est défini à 'both'.
39 par défaut, et se comporte autrement comme pour un champ CharField.
ImageFieldLien vers cette rubrique#Composant par défaut : ClearableFileInput
Valeur vide : None
Est normalisé en : un objet UploadedFile englobant le contenu du fichier et son nom dans un seul objet.
Valide que les données de fichier ont été liées au formulaire. Utilise aussi FileExtensionValidator pour valider que l’extension de fichier est prise en charge par Pillow.
Clés de messages d’erreur : required, invalid, missing, empty, invalid_image
L’emploi de ImageField requiert que pillow soit installé et gère les formats d’image que vous utilisez. Si vous obtenez une erreur d’image corrompue (corrupt image) lorsque vous téléversez une image, cela signifie généralement que Pillow ne prend pas en charge son format. Pour corriger cela, installez la bibliothèque correspondante et réinstallez Pillow.
Lorsque vous utilisez un champ ImageField dans un formulaire, vous ne devez pas oublier de lier les données de fichier au formulaire.
Après que le champ a été nettoyé et validé, l’objet UploadedFile comportera un attribut supplémentaire image contenant l’instance Image de Pillow utilisée pour contrôler que le fichier est une image valide. Pillow ferme le descripteur de fichier sous-jacent après avoir vérifié l’image ; ainsi, alors que certains attributs de données non image tels que format, height et width sont accessibles, ce n’est pas le cas des méthodes qui accèdent aux données image sous-jacentes, telles que getdata() ou getpixel(), sauf si vous prenez la peine de réouvrir le fichier. Par exemple :
>>> from PIL import Image\n>>> from django import forms\n>>> from django.core.files.uploadedfile import SimpleUploadedFile\n>>> class ImageForm(forms.Form):\n... img = forms.ImageField()\n...\n>>> file_data = {"img": SimpleUploadedFile("test.png", b"file data")}\n>>> form = ImageForm({}, file_data)\n# Pillow closes the underlying file descriptor.\n>>> form.is_valid()\nTrue\n>>> image_field = form.cleaned_data["img"]\n>>> image_field.image\n<PIL.PngImagePlugin.PngImageFile image mode=RGBA size=191x287 at 0x7F5985045C18>\n>>> image_field.image.width\n191\n>>> image_field.image.height\n287\n>>> image_field.image.format\n'PNG'\n>>> image_field.image.getdata()\n# Raises AttributeError: 'NoneType' object has no attribute 'seek'.\n>>> image = Image.open(image_field)\n>>> image.getdata()\n<ImagingCore object at 0x7f5984f874b0>\nDe plus, UploadedFile.content_type sera également mis à jour avec le type de contenu de l’image pour autant que Pillow puisse le déterminer, sinon il prend la valeur None.
IntegerFieldLien vers cette rubrique#Composant par défaut : NumberInput lorsque Field.localize vaut False, sinon TextInput.
Valeur vide : None
Est normalisé en : un nombre entier Python.
Valide que la valeur donnée est un nombre entier. Utilise MaxValueValidator et MinValueValidator si max_value et min_value sont fournis. Utilise StepValueValidator si step_size est fourni. Les espaces de début et de fin sont permis, comme pour la fonction int() de Python.
Clés de messages d’erreur : required, invalid, max_value, min_value, step_size
Les messages d’erreur max_value, min_value et step_size peuvent contenir %(limit_value)s, qui sera remplacé par la limite concernée.
Accepte trois paramètres facultatifs liés à la validation :
\nCes paramètres contrôlent l’intervalle des valeurs autorisées dans ce champ.
\nLimite la validité des entrées à un multiple entier de step_size. Si min_value est aussi indiquée, elle est ajoutée comme valeur de décalage pour déterminer si la taille de pas correspond.
JSONFieldLien vers cette rubrique#Un champ qui accepte des données codées en JSON pour un champ JSONField.
Composant par défaut : Textarea
Valeur vide : None
Est normalisé en : une représentation Python de la valeur JSON (habituellement une valeur dict, list ou None), en fonction de JSONField.decoder.
Valide que la valeur donnée est une structure JSON valide.
Clés de messages d’erreur : required, invalid
Accepte deux paramètres facultatifs :
\nUne sous-classe de json.JSONEncoder pour sérialiser les types de données non prises en charge par le sérialiseur JSON standard (par ex. datetime.datetime ou UUID). Par exemple, vous pouvez utiliser la classe DjangoJSONEncoder.
Contient json.JSONEncoder par défaut.
Une sous-classe de json.JSONDecoder pour désérialiser l’entrée. La désérialisation pourrait devoir tenir compte de l’incertitude liée au type de la valeur d’entrée. Par exemple, vous courez le risque de renvoyer un objet datetime qui était en fait une chaîne qui était fortuitement au même format que celui choisi pour les objets datetime.
Le decoder peut être utiliser pour valider les données entrées. Si json.JSONDecodeError est générée durant la désérialisation, une exception ValidationError sera produite.
Contient json.JSONDecoder par défaut.
MultipleChoiceFieldLien vers cette rubrique#Composant par défaut : SelectMultiple
Valeur vide : [] (une liste vide)
Est normalisé en : une liste de chaînes.
Valide que chaque valeur dans la liste donnée existe dans la liste à choix.
Clés de messages d’erreur : required, invalid_choice, invalid_list
Le message d’erreur invalid_choice peut contenir %(value)s, qui sera remplacé par le choix sélectionné.
Requiert un paramètre supplémentaire obligatoire, choices, comme pour ChoiceField.
NullBooleanFieldLien vers cette rubrique#Composant par défaut : NullBooleanSelect
Valeur vide : None
Est normalisé en : une valeur Python True, False ou None.
Ne valide rien (c’est-à-dire qu’il n’y a jamais d’exception ValidationError).
NullBooleanField peut être utilisé avec des composants tels que Select ou RadioSelect en indiquant les choix choices du composant
NullBooleanField(\n widget=Select(\n choices=[\n ("", "Unknown"),\n (True, "Yes"),\n (False, "No"),\n ]\n )\n)\nRegexFieldLien vers cette rubrique#Composant par défaut : TextInput
Valeur vide : ce qui a été indiqué dans empty_value.
Est normalisé en : une chaîne.
Utilise RegexValidator pour valider que la valeur donnée correspond à une certaine expression régulière.
Clés de messages d’erreur : required, invalid
Requiert un paramètre supplémentaire obligatoire :
\nUne expression régulière exprimée sous forme de chaîne ou d’objet expression régulière compilée.
\nAccepte également max_length, min_length, strip et empty_value, qui fonctionnent exactement comme pour CharField.
Contient False par défaut. Quand ce paramètre est activé, l’épuration des espaces initiales et finales s’effectue avant la validation par l’expression régulière.
SlugFieldLien vers cette rubrique#Composant par défaut : TextInput
Valeur vide : ce qui a été indiqué dans empty_value.
Est normalisé en : une chaîne.
Utilise validate_slug ou validate_unicode_slug pour valider que la valeur donnée ne contient que des lettres, des nombres, des soulignements et des tirets.
Clés de messages d’erreur : required, invalid
Ce champ est prévu pour l’affichage des champs de modèle SlugField dans les formulaires.
Accepte deux paramètres facultatifs :
\nUne valeur booléenne indiquant au champ d’accepter des lettres Unicode en plus des lettres ASCII de base. La valeur par défaut est False.
La valeur à utiliser pour représenter une valeur vide. Contient une chaîne vide par défaut.
\nTimeFieldLien vers cette rubrique#Composant par défaut : TimeInput
Valeur vide : None
Est normalisé en : un objet Python datetime.time.
Valide que la valeur donnée est un objet datetime.time ou une chaîne mise en forme dans un format d’heure particulier.
Clés de messages d’erreur : required, invalid
Accepte un paramètre facultatif :
\nUn objet itérable de chaînes de format utilisées pour essayer de convertir une chaîne en un objet datetime.time valide.
Si aucun paramètre input_formats n’est indiqué, les formats d’entrée par défaut sont lus dans la clé TIME_INPUT_FORMATS du format de langue actif, ou dans le réglage TIME_INPUT_FORMATS si la régionalisation est désactivée. Voir aussi la régionalisation des formats.
TypedChoiceFieldLien vers cette rubrique#Similaire à ChoiceField, sauf que TypedChoiceField accepte deux paramètres supplémentaires, coerce et empty_value.
Composant par défaut : Select
Valeur vide : ce qui a été indiqué dans empty_value.
Est normalisé en : une valeur du type indiqué par le paramètre coerce.
Valide que la valeur donnée existe dans la liste à choix et qu’elle peut être transformée dans le bon type.
Clés de messages d’erreur : required, invalid_choice
Accepte des paramètres supplémentaires :
\nUne fonction acceptant un paramètre et renvoyant une valeur transtypée. Comme exemple, on peut mentionner les fonctions Python int, float, bool et les autres types. Par défaut, il s’agit de la fonction identité. Notez que le forçage de type se produit après la validation de saisie, il est donc possible de forcer une valeur qui n’est pas présente dans choices.
La valeur utilisée pour signifier « vide ». Par défaut, il s’agit de la chaîne vide ; None est une autre option assez fréquente ici. Remarquez que le type de cette valeur ne sera pas transformé par le contenu du paramètre coerce, il faut donc la choisir en conséquence.
TypedMultipleChoiceFieldLien vers cette rubrique#Similaire à MultipleChoiceField, sauf que TypedMultipleChoiceField accepte deux paramètres supplémentaires, coerce et empty_value.
Composant par défaut : SelectMultiple
Valeur vide : ce qui a été indiqué dans empty_value
Est normalisé en : une liste de valeurs du type indiqué par le paramètre coerce.
Valide que les valeurs données existent dans la liste à choix et qu’elles peuvent être transformées dans le bon type.
Clés de messages d’erreur : required, invalid_choice
Le message d’erreur invalid_choice peut contenir %(value)s, qui sera remplacé par le choix sélectionné.
Accepte deux paramètres supplémentaires, coerce et empty_value, comme pour TypedChoiceField.
URLFieldLien vers cette rubrique#Composant par défaut : URLInput
Valeur vide : ce qui a été indiqué dans empty_value.
Est normalisé en : une chaîne.
Utilise URLValidator pour valider que la valeur donnée est une URL valide.
Clés de messages d’erreur : required, invalid
Possède les paramètres facultatifs max_length, min_length et empty_value, qui fonctionnent exactement comme pour CharField, ainsi qu’un argument supplémentaire :
Le protocole supposé des URL qui n’en contiennent pas. Vaut "https" par défaut. Par exemple, si assume_scheme vaut "https" et que la valeur fournie est "exemple.com", la valeur normalisée sera "https://exemple.com".
UUIDFieldLien vers cette rubrique#Composant par défaut : TextInput
Valeur vide : None
Est normalisé en : un objet UUID.
Clés de messages d’erreur : required, invalid
Ce champ accepte toute chaîne dans un format accepté par le paramètre hex du constructeur UUID.
Field intégrées plus complexesLien vers cette rubrique#ComboFieldLien vers cette rubrique#Composant par défaut : TextInput
Valeur vide : '' (une chaîne vide)
Est normalisé en : une chaîne.
Valide que la valeur donnée est valide pour chacun des champs indiqués en paramètre de ComboField.
Clés de messages d’erreur : required, invalid
Requiert un paramètre supplémentaire obligatoire :
\nLa liste des champs devant être utilisés pour valider la valeur du champ (dans l’ordre de leur présentation).
\n>>> from django.forms import ComboField\n>>> f = ComboField(fields=[CharField(max_length=20), EmailField()])\n>>> f.clean("test@example.com")\n'test@example.com'\n>>> f.clean("longemailaddress@example.com")\nTraceback (most recent call last):\n...\nValidationError: ['Ensure this value has at most 20 characters (it has 28).']\nMultiValueFieldLien vers cette rubrique#Composant par défaut : TextInput
Valeur vide : '' (une chaîne vide)
Est normalisé en : le type renvoyé par la méthode compress de la sous-classe.
Valide que les valeurs données sont valides pour chacun des champs indiqués en paramètre de MultiValueField.
Clés de messages d’erreur : required, invalid, incomplete
Agrège la logique de plusieurs champs qui produisent une seule valeur en commun.
\nCe champ est abstrait et doit être hérité. Au contraire des champs à valeur unique, les sous-classes de MultiValueField ne doivent pas implémenter clean() mais plutôt compress().
Requiert un paramètre supplémentaire obligatoire :
\nUn tuple de champs dont les valeurs sont nettoyées puis ultérieurement combinées en une seule valeur. Chaque valeur du champ est nettoyée par le champ correspondant dans fields – la première valeur est nettoyée par le premier champ, la deuxième valeur par le deuxième champ, etc. Lorsque tous les champs ont été nettoyés, la liste de ces valeurs est combinée en une valeur unique par compress().
Accepte aussi des paramètre facultatifs :
\nLa valeur par défaut est True, auquel cas une erreur de validation required est générée si aucune valeur n’est fournie pour aucun champ.
Lorsque la valeur est False, l’attribut Field.required peut être défini à False pour des champs individuels pour les rendre facultatifs. Si aucune valeur n’est fournie pour un champ obligatoire, une erreur de validation incomplete est générée.
Un message d’erreur incomplete par défaut peut être défini dans la sous-classe de MultiValueField, ou il est possible de définir des messages différents pour chaque champ individuellement. Par exemple :
from django.core.validators import RegexValidator\n\n\nclass PhoneField(MultiValueField):\n def __init__(self, **kwargs):\n # Define one message for all fields.\n error_messages = {\n "incomplete": "Enter a country calling code and a phone number.",\n }\n # Or define a different message for each field.\n fields = (\n CharField(\n error_messages={"incomplete": "Enter a country calling code."},\n validators=[\n RegexValidator(r"^[0-9]+$", "Enter a valid country calling code."),\n ],\n ),\n CharField(\n error_messages={"incomplete": "Enter a phone number."},\n validators=[RegexValidator(r"^[0-9]+$", "Enter a valid phone number.")],\n ),\n CharField(\n validators=[RegexValidator(r"^[0-9]+$", "Enter a valid extension.")],\n required=False,\n ),\n )\n super().__init__(\n error_messages=error_messages,\n fields=fields,\n require_all_fields=False,\n **kwargs\n )\nDoit être une sous-classe de django.forms.MultiWidget. La valeur par défaut est TextInput, qui n’est probablement pas très utile dans ce cas.
Accepte une liste de valeurs valides et renvoie une version « compressée » de ces valeurs dans une seule valeur. Par exemple, SplitDateTimeField est une sous-classe qui combine un champ heure et un champ date en un seul objet datetime.
Cette méthode doit être implémentée par les sous-classes.
\nSplitDateTimeFieldLien vers cette rubrique#Composant par défaut : SplitDateTimeWidget
Valeur vide : None
Est normalisé en : un objet Python datetime.datetime.
Valide que la valeur donnée est un objet datetime.datetime ou une chaîne mise en forme dans un format de date/heure particulier.
Clés de messages d’erreur : required, invalid, invalid_date, invalid_time
Accepte deux paramètres facultatifs :
\nUne liste de chaînes de format utilisées pour essayer de convertir une chaîne en un objet datetime.date valide.
Si aucun paramètre input_date_formats n’est indiqué, ce sont les formats de saisie par défaut de DateField qui sont utilisés.
Une liste de chaînes de format utilisées pour essayer de convertir une chaîne en un objet datetime.time valide.
Si aucun paramètre input_time_formats n’est indiqué, ce sont les formats de saisie par défaut de TimeField qui sont utilisés.
Deux champs sont disponibles pour représenter les relations entre modèles : ModelChoiceField and ModelMultipleChoiceField. Ces deux champs exigent un seul paramètre queryset utilisé pour créer les choix du champ. Lors de la validation du formulaire, ces champs placent soit un objet de modèle (dans le cas de ModelChoiceField), soit plusieurs objets de modèle (dans le cas de ModelMultipleChoiceField) dans le dictionnaire cleaned_data du formulaire.
Pour des usages plus complexes, il est possible d’indiquer queryset=None au moment de déclarer le champ de formulaire, puis de remplir queryset dans la méthode __init__() du formulaire :
class FooMultipleChoiceForm(forms.Form):\n foo_select = forms.ModelMultipleChoiceField(queryset=None)\n\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.fields["foo_select"].queryset = ...\nModelChoiceField et ModelMultipleChoiceField ont les deux un attribut iterator qui spécifie la classe utilisée pour itérer sur le jeu de requête lors de la génération des choix. Voir Itération sur les choix relationnels pour plus de détails.
ModelChoiceFieldLien vers cette rubrique#Composant par défaut : Select
Valeur vide : None
Est normalisé en : une instance de modèle.
Valide que l’identifiant donné existe dans le jeu de requête.
Clés de messages d’erreur : required, invalid_choice
Le message d’erreur invalid_choice peut contenir %(value)s, qui sera remplacé par le choix sélectionné.
Permet de sélectionner un seul objet de modèle, adapté à la représentation d’une clé étrangère. Notez que le composant par défaut de ModelChoiceField devient difficilement utilisable au fur et à mesure que le nombre de choix possibles augmente. Il n’est pas recommandé de l’utiliser lorsque le nombre d’éléments à choix dépasse 100.
Un seul paramètre est obligatoire :
\nUn jeu de requête QuerySet d’objets de modèles constituant la source des choix possibles pour le champ et qui est utilisé aussi pour valider le choix de l’utilisateur. Il est évalué au moment du rendu du formulaire.
ModelChoiceField accepte aussi plusieurs paramètres facultatifs :
By default the <select> widget used by ModelChoiceField will\nhave an empty choice at the top of the list. You can change the text of\nthis label (which is "- Select an option -" by default) with the\nempty_label attribute, or you can disable the empty label entirely\nby setting empty_label to None:
# A custom empty label\nfield1 = forms.ModelChoiceField(queryset=..., empty_label="(Nothing)")\n\n# No empty label\nfield2 = forms.ModelChoiceField(queryset=..., empty_label=None)\nNotez qu’aucun choix vide n’est créé (quelle que soit la valeur de empty_label) si un champ ModelChoiceField est obligatoire et possède une valeur initiale par défaut, ou que son composant widget est class:~django.forms.RadioSelect et que son argument blank est False.
Ce paramètre facultatif est utilisé pour désigner le champ à utiliser comme valeur des choix dans le composant du champ. Contrôlez qu’il s’agit bien d’un champ unique du modèle, sinon la valeur sélectionnée pourrait correspondre à plus d’un objet. Par défaut ce paramètre vaut None, ce qui signifie que c’est la clé primaire de chaque objet qui est utilisée. Par exemple :
# No custom to_field_name\nfield1 = forms.ModelChoiceField(queryset=...)\nproduirait :
\n<select id="id_field1" name="field1">\n<option value="obj1.pk">Object1</option>\n<option value="obj2.pk">Object2</option>\n...\n</select>\net :
\n# to_field_name provided\nfield2 = forms.ModelChoiceField(queryset=..., to_field_name="name")\nproduirait :
\n<select id="id_field2" name="field2">\n<option value="obj1.name">Object1</option>\n<option value="obj2.name">Object2</option>\n...\n</select>\nLors de l’utilisation du composant RadioSelect, cet argument booléen facultatif détermine si un choix vide est créé. Par défaut, blank vaut False, auquel cas aucun choix vide n’est créé.
ModelChoiceField possède également cet attribut :
La classe d’itération utilisée pour générer les choix du champ à partir de queryset. Par défaut, ModelChoiceIterator.
La méthode __str__() du modèle sera appelée pour générer les représentations textuelles des objets à faire figurer dans les choix du champ. Pour fournir des représentations personnalisées, créez une sous-classe de ModelChoiceField et surchargez label_from_instance. Cette méthode reçoit un objet de modèle et doit renvoyer une chaîne représentative de l’objet. Par exemple :
from django.forms import ModelChoiceField\n\n\nclass MyModelChoiceField(ModelChoiceField):\n def label_from_instance(self, obj):\n return "My Object #%i" % obj.id\nModelMultipleChoiceFieldLien vers cette rubrique#Composant par défaut : SelectMultiple
Valeur vide : un QuerySet vide (self.queryset.none())
Est normalisé en : un QuerySet d’instances de modèles.
Valide que chaque identifiant dans la liste donnée existe dans le jeu de requête.
Clés de messages d’erreur : required, invalid_list, invalid_choice, invalid_pk_value
Le message d’erreur invalid_choice peut contenir %(value)s et le message invalid_pk_value peut contenir %(pk)s, qui seront substitués par les valeurs appropriées.
Permet la sélection d’un ou de plusieurs objets de modèles, adapté à la représentation de relations plusieurs-à-plusieurs. Comme pour ModelChoiceField, vous pouvez utiliser label_from_instance afin de personnaliser les représentations des objets.
Un seul paramètre est obligatoire :
\nIdentique à ModelChoiceField.queryset.
Accepte un paramètre facultatif :
\nIdentique à ModelChoiceField.to_field_name.
ModelMultipleChoiceField possède également cet attribut :
Identique à ModelChoiceField.iterator.
Par défaut, ModelChoiceField et ModelMultipleChoiceField utilisent ModelChoiceIterator pour générer leur choix de champ choices.
Lors de son itération, ModelChoiceIterator produit des choix de tuples à 2 éléments contenant des instances ModelChoiceIteratorValue comme premier élément value dans chaque choix. ModelChoiceIteratorValue enveloppe la valeur du choix tout en maintenant une référence à l’instance de modèle source pouvant être utilisée par exemple dans des implémentations de composants personnalisés pour ajouter des attributs data-* aux éléments <option>.
Par exemple, considérons les modèles suivants :
\nfrom django.db import models\n\n\nclass Topping(models.Model):\n name = models.CharField(max_length=100)\n price = models.DecimalField(decimal_places=2, max_digits=6)\n\n def __str__(self):\n return self.name\n\n\nclass Pizza(models.Model):\n topping = models.ForeignKey(Topping, on_delete=models.CASCADE)\nVous pouvez utiliser une sous-classe de composant Select pour inclure la valeur de Topping.price sous forme d’attribut HTML data-price pour chaque élément <option>:
from django import forms\n\n\nclass ToppingSelect(forms.Select):\n def create_option(\n self, name, value, label, selected, index, subindex=None, attrs=None\n ):\n option = super().create_option(\n name, value, label, selected, index, subindex, attrs\n )\n if value:\n option["attrs"]["data-price"] = value.instance.price\n return option\n\n\nclass PizzaForm(forms.ModelForm):\n class Meta:\n model = Pizza\n fields = ["topping"]\n widgets = {"topping": ToppingSelect}\nCela produira l’élément select pour Pizza.topping ainsi :
<select id="id_topping" name="topping" required>\n<option value="" selected>---------</option>\n<option value="1" data-price="1.50">mushrooms</option>\n<option value="2" data-price="1.25">onions</option>\n<option value="3" data-price="1.75">peppers</option>\n<option value="4" data-price="2.00">pineapple</option>\n</select>\nPour des usages plus avancés, vous pouvez créer des sous-classes de ModelChoiceIterator afin de personnaliser les choix de tuples à 2 éléments qui sont produits.
ModelChoiceIteratorLien vers cette rubrique#La classes par défaut attribuée à l’attribut iterator des champs ModelChoiceField et ModelMultipleChoiceField. Un objet itérable produisant des choix de tuples à 2 éléments à partir du jeu de requête.
Un seul paramètre est obligatoire :
\nL’instance ModelChoiceField ou ModelMultipleChoiceField sur laquelle itérer et qui produira les choix.
ModelChoiceIterator possède la méthode suivante :
Produit des choix de tuples à 2 éléments, au format (value, label) utilisé par ChoiceField.choices. Le premier élément value est une instance ModelChoiceIteratorValue.
ModelChoiceIteratorValueLien vers cette rubrique#Deux paramètres sont obligatoires :
\nLa valeur du choix. Cette valeur est utilisée pour produire l’attribut value d’un élément HTML <option>.
L’instance de modèle provenant du jeu de requête. On peut accéder à cette instance dans des implémentations personnalisées de ChoiceWidget.create_option() pour ajuster le code HTML produit.
ModelChoiceIteratorValue possède la méthode suivante :
Renvoie value comme chaîne qui sera produite en HTML.
Si les classes Field intégrées ne correspondent pas à vos besoins, vous pouvez créer des classes Field personnalisées. Pour cela, créez une sous-classe de django.forms.Field. Les seules exigences sont que la méthode clean() doit être implémentée et que la méthode __init__() accepte les paramètres de base mentionnés plus haut (required, label, initial, widget, help_text).
Si vous avez besoin de plus de flexibilité lors de la création d’une instance BoundField, il est aussi possible de personnaliser la manière d’accéder à un champ en surchargeant bound_field_class ou Field.get_bound_field().
Accepte une instance de Form et le nom du champ. L’instance BoundField renvoyée sera utilisée pour accéder au champ dans un gabarit.
Voir Personnalisation de BoundField pour des exemples de surcharge de BoundField.