L’API du rendu des formulaires

Les composants de formulaires de Django sont produits en utilisant le système des moteurs de gabarit de Django.

Le processus de production des formulaires peut être personnalisé à plusieurs niveaux :

• Les composants peuvent indiquer des noms de gabarit personnalisés.
• Les formulaires et les composants peuvent indiquer des classes de moteur de rendu personnalisées.
• Un gabarit de composant peut être surchargé par projet (les applications réutilisables ne devraient typiquement pas surcharger les gabarits de base car cela pourrait générer des conflits avec les gabarits personnalisés d’un projet.)

L’API de rendu de bas niveau

Le processus de rendu des gabarits de formulaires est contrôlé par une classe de rendu personnalisable. Cette classe peut être indiquée en définissant le réglage FORM_RENDERER. Par défaut, il contient 'django.forms.renderers.DjangoTemplates'.

En indiquant une classe de rendu de formulaire personnalisée et en surchargeant form_template_name, vous pouvez ajuster le balisage par défaut des formulaires dans tout votre projet depuis un seul endroit.

Il est aussi possible de définir un moteur de rendu personnalisé par formulaire ou par composant en définissant l’attribut Form.default_renderer ou en utilisant le paramètre renderer de Form.render() ou de Widget.render().

Ce principe de personnalisation s’applique aussi au rendu des jeux de formulaire. Voir Using a formset in views and templates pour plus de détails à ce sujet.

Utilisez l’une des moteurs de rendu de gabarits de formulaire intégrés ou implémentez le votre. Les moteurs de rendu personnalisés doivent implémenter une méthode render(nom_gabarit, context, request=None). Elle doit renvoyer un gabarit finalisé (sous forme de chaîne) ou générer TemplateDoesNotExist.

class BaseRenderer

La classe de base pour les moteurs de rendu intégrés.

form_template_name

New in Django 4.1.

Le nom de gabarit par défaut à utiliser pour produire un formulaire.

Vaut par défaut "django/forms/default.html", qui est un pointeur vers "django/forms/table.html".

Obsolète depuis la version 4.1.

Le gabarit "django/forms/default.html" est obsolète et sera supprimé dans Django 5.0. La valeur par défaut deviendra "django/forms/div.html" à partir de ce moment.

formset_template_name

New in Django 4.1.

Le nom de gabarit par défaut à utiliser pour produire un jeu de formulaires.

Vaut par défaut "django/forms/formsets/default.html", qui est un pointeur vers "django/forms/formsets/table.html".

Obsolète depuis la version 4.1.

Le gabarit "django/forms/formset/default.html" est obsolète et sera supprimé dans Django 5.0. La valeur par défaut deviendra "django/forms/formset/div.html" à partir de ce moment.

get_template(template_name)

Les sous-classes doivent implémenter cette méthode avec la logique de recherche de gabarits appropriée.

render(template_name, context, request=None)

Produit le gabarit donné ou génère TemplateDoesNotExist.

Moteurs de rendu de gabarits de formulaire intégrés

DjangoTemplates

class DjangoTemplates

Ce moteur de rendu utilise un moteur indépendant DjangoTemplates (sans rapport avec ce que vous pourriez avoit configuré dans le réglage TEMPLATES). Il charge les gabarits en regardant d’abord dans le répertoire des gabarits de formulaire intégrés dans django/forms/templates, puis dans les répertoires de gabarits des applications installées en utilisant le chargeur app_directories.

Si vous souhaitez produire des gabarits avec des personnalisations provenant de votre réglage TEMPLATES, comme par exemple en exploitant des processeurs de contexte, utilisez le moteur de rendu TemplatesSetting.

class DjangoDivFormRenderer

New in Django 4.1.

Sous-classe de DjangoTemplates définissant les attributs form_template_name et formset_template_name respectivement par "django/forms/div.html" et "django/forms/formset/div.html".

Cette classe de moteur de rendu est provisoire et permet d’opter pour les nouveaux gabarits basés sur la balise <div>, ce qui deviendra le comportement par défaut à partir de Django 5.0.

Vous pouvez l’utiliser en définissant le réglage FORM_RENDERER:

FORM_RENDERER = "django.forms.renderers.DjangoDivFormRenderer"

Dès que les gabarits <div> seront utilisés par défaut, cette classe de transition sera rendue obsolètem, puis supprimée dans Django 6.0. La déclaration FORM_RENDERER pourra alors être supprimée également.

Jinja2

class Jinja2

Ce moteur de rendu est semblable au moteur DjangoTemplates, sauf qu’il utilise le moteur Jinja2. Les gabarits des composants intégrés se trouvent dans django/forms/jinja2 et les applications installées peuvent fournir des gabarits dans un répertoire jinja2.

Pour utiliser ce moteur, tous les formulaires et composants de votre projet et ses applications tierces doivent posséder des gabarits Jinja2. Si vous ne fournissez pas vous-même des gabarits pour les composants qui n’ont en pas, vous ne pouvez pas utiliser ce moteur de rendu. Par exemple, django.contrib.admin ne contient pas de gabarits Jinja2 pour ses composants car ceux-ci font usage des balises de gabarits Django.

class Jinja2DivFormRenderer

New in Django 4.1.

Une classe de moteur de rendu transitoire, comme pour DjangoDivFormRenderer ci-dessus, mais comme sous-classe de Jinja2 pour être utilisée avec le moteur Jinja2.

Vous pouvez l’utiliser en définissant le réglage FORM_RENDERER:

FORM_RENDERER = "django.forms.renderers.Jinja2DivFormRenderer"

TemplatesSetting

class TemplatesSetting

Ce moteur de rendu donne un contrôle complet sur la façon dont les gabarits de formulaires et de composants sont traités. Il utilise get_template() pour trouver les gabarits sur la base de ce qui est configuré dans le réglage TEMPLATES.

L’emploi de ce moteur de rendu en même temps que les gabarits intégrés nécessite l’une des deux conditions suivantes :

• 'django.forms' se trouve dans INSTALLED_APPS et au moins un moteur avec APP_DIRS=True.

• Le répertoire des gabarits intégrés doit figurer dans le réglage DIRS d’au moins un des moteurs de gabarits. Pour générer ce chemin

  import django
  
  django.__path__[0] + "/forms/templates"  # or '/forms/jinja2'
  

L’emploi de ce moteur de rendu nécessite que les gabarits de formulaires dont le projet a besoin puissent être localisés.

Contexte disponible dans les gabarits des jeux de formulaires

Les gabarits des jeux de formulaires reçoivent un contexte de BaseFormSet.get_context(). Par défaut, les jeux de formulaires reçoivent un dictionnaire avec les valeurs suivantes :

• formset: l’instance du jeu de formulaires.

Contexte disponible dans les gabarits des formulaires

Les gabarits des formulaires reçoivent un contexte de Form.get_context(). Par défaut, les formulaires reçoivent un dictionnaire avec les valeurs suivantes :

• form: le formulaire lié.
• fields: tous les champs liés, exceptés les champs cachés.
• hidden_fields: tous les champs liés cachés.
• errors: toutes les erreurs de formulaire non liées aux champs ou liées à des champs cachés.

Contexte disponible dans les gabarits de composants

Les gabarits de composants reçoivent un contexte provenant de Widget.get_context(). Par défaut, les composants reçoivent une seule valeur dans le contexte, widget. Il s’agit d’un dictionnaire qui contient des valeurs comme :

• name
• valeur
• attrs
• is_hidden
• template_name

Certains composants ajoutent d’autres informations dans le contexte. Par exemple, tous les composants héritant de Input définissent widget['type'] et MultiWidget définit widget['subwidgets'] donnant la possibilité de faire des boucles.

Redéfinition des gabarits de jeux de formulaires intégrés

BaseFormSet.template_name

Pour surcharger les gabarits des jeux de formulaires, vous devez utiliser le moteur de rendu TemplatesSetting. Puis, le remplacement des gabarits de jeux de formulaires fonctionne de la même manière que le remplacement de n’importe quel autre gabarit d’un projet.

Redéfinition des gabarits de formulaires intégrés

Form.template_name

Pour surcharger les gabarits des formulaires, vous devez utiliser le moteur de rendu TemplatesSetting. Puis, le remplacement des gabarits de formulaires fonctionne de la même manière que le remplacement de n’importe quel autre gabarit d’un projet.

Redéfinition des gabarits des composants intégrés

Chaque composant possède un attribut template_name avec une valeur telle que input.html. Les gabarits des composants livrés avec Django sont stockés dans le chemin django/forms/widgets. Par exemple, vous pouvez fournir un gabarit personnalisé pour input.html en créant django/forms/widgets/input.html. Voir Composants intégrés pour connaître le nom du gabarit de chaque composant.

Pour surcharger les gabarits de composants, vous devez utiliser le moteur de rendu TemplatesSetting. Puis, le remplacement des gabarits de composants fonctionne de la même manière que le remplacement de n’importe quel autre gabarit d’un projet.