{"title":"Implémentation d’un moteur de gabarits personnalisé","version":"5.0","locale":"fr","docname":"howto/custom-template-backend","url":"/fr/5.0/howto/custom-template-backend/","canonical":"https://djangodocs.dev/fr/5.0/howto/custom-template-backend/","summary":"Voici comment implémenter un moteur de gabarit personnalisé afin d’utiliser un autre système de gabarits.","html":"

Implémentation d’un moteur de gabarits personnaliséLien vers cette rubrique#

\n
\n

Moteurs personnalisésLien vers cette rubrique#

\n

Voici comment implémenter un moteur de gabarit personnalisé afin d’utiliser un autre système de gabarits. Un moteur de gabarit est une classe qui hérite de django.template.backends.base.BaseEngine. Elle doit implémenter get_template()` et, facultativement, from_string(). Voici un exemple d’une bibliothèque de gabarit fictive foobar:

\n
Code
from django.template import TemplateDoesNotExist, TemplateSyntaxError\nfrom django.template.backends.base import BaseEngine\nfrom django.template.backends.utils import csrf_input_lazy, csrf_token_lazy\n\nimport foobar\n\n\nclass FooBar(BaseEngine):\n    # Name of the subdirectory containing the templates for this engine\n    # inside an installed application.\n    app_dirname = "foobar"\n\n    def __init__(self, params):\n        params = params.copy()\n        options = params.pop("OPTIONS").copy()\n        super().__init__(params)\n\n        self.engine = foobar.Engine(**options)\n\n    def from_string(self, template_code):\n        try:\n            return Template(self.engine.from_string(template_code))\n        except foobar.TemplateCompilationFailed as exc:\n            raise TemplateSyntaxError(exc.args)\n\n    def get_template(self, template_name):\n        try:\n            return Template(self.engine.get_template(template_name))\n        except foobar.TemplateNotFound as exc:\n            raise TemplateDoesNotExist(exc.args, backend=self)\n        except foobar.TemplateCompilationFailed as exc:\n            raise TemplateSyntaxError(exc.args)\n\n\nclass Template:\n    def __init__(self, template):\n        self.template = template\n\n    def render(self, context=None, request=None):\n        if context is None:\n            context = {}\n        if request is not None:\n            context["request"] = request\n            context["csrf_input"] = csrf_input_lazy(request)\n            context["csrf_token"] = csrf_token_lazy(request)\n        return self.template.render(context)\n
\n

Voir DEP 182 pour plus d’informations.

\n
\n
\n

Intégration du débogage pour les moteurs personnalisésLien vers cette rubrique#

\n

La page de débogage de Django présente des points d’entrée pour fournir des informations détaillées lorsqu’une erreur de gabarit se produit. Les moteurs de gabarit personnalisés peuvent utiliser ces points d’entrée pour améliorer les informations d’erreur qui sont présentées aux utilisateurs. Les points d’entrée suivants sont disponibles :

\n
\n

Gabarit postmortemLien vers cette rubrique#

\n

Le gabarit postmortem apparaît lorsque TemplateDoesNotExist est générée. Il présente la liste des moteurs et chargeurs de gabarit utilisés lors de la recherche du gabarit concerné. Par exemple, si deux moteurs Django sont configurés, le gabarit postmortem ressemble à ceci :

\n\"/fr/5.0/_images/postmortem.png\"\n

Les moteurs personnalisés peuvent remplir le gabarit postmortem en passant les paramètres backend et tried lors de la génération de TemplateDoesNotExist. Les moteurs qui utilisent le gabarit postmortem doivent indiquer une origine sur l’objet de gabarit.

\n
\n
\n

Information de ligne contextuelleLien vers cette rubrique#

\n

Si une erreur se produit pendant l’analyse et le rendu d’un gabarit, Django peut afficher la ligne à laquelle s’est produite l’erreur. Par exemple :

\n\"/fr/5.0/_images/template-lines.png\"\n

Les moteurs personnalisés peuvent fournir cette information en définissant un attribut template_debug sur les exceptions générées pendant l’analyse et le rendu. Cet attribut est un dict possédant les valeurs suivantes :

\n\n

Étant donné l’erreur de gabarit ci-dessus, template_debug ressemblerait à ceci :

\n
Code
{\n    "name": "/path/to/template.html",\n    "message": "Invalid block tag: 'syntax'",\n    "source_lines": [\n        (1, "some\\n"),\n        (2, "lines\\n"),\n        (3, "before\\n"),\n        (4, "Hello {% syntax error %} {{ world }}\\n"),\n        (5, "some\\n"),\n        (6, "lines\\n"),\n        (7, "after\\n"),\n        (8, ""),\n    ],\n    "line": 4,\n    "before": "Hello ",\n    "during": "{% syntax error %}",\n    "after": " {{ world }}\\n",\n    "total": 9,\n    "bottom": 9,\n    "top": 1,\n}\n
\n
\n
\n

API d’origine et intégration tierceLien vers cette rubrique#

\n

Les gabarits Django possèdent un objet Origin accessible par leur attribut template.origin. Ceci permet aux informations de débogage d’apparaître dans le gabarit postmortem, de même que dans des bibliothèques tierces, telle que Django Debug Toolbar.

\n

Les moteurs personnalisés peuvent fournir leurs propres informations template.origin en créant un objet qui définit les attributs suivants :

\n\n
\n
","rootId":"how-to-implement-a-custom-template-backend","toc":[{"title":"Moteurs personnalisés","anchor":"custom-backends","children":[]},{"title":"Intégration du débogage pour les moteurs personnalisés","anchor":"debug-integration-for-custom-engines","children":[{"title":"Gabarit postmortem","anchor":"template-postmortem","children":[]},{"title":"Information de ligne contextuelle","anchor":"contextual-line-information","children":[]},{"title":"API d’origine et intégration tierce","anchor":"origin-api-and-3rd-party-integration","children":[]}]}],"breadcrumbs":[{"docname":"howto/index","title":"Guides pratiques","url":"/fr/5.0/howto/"}],"prev":{"docname":"howto/custom-lookups","title":"Écriture d’expressions de requêtes personnalisées","url":"/fr/5.0/howto/custom-lookups/"},"next":{"docname":"howto/custom-template-tags","title":"Création de balises et filtres de gabarit personnalisés","url":"/fr/5.0/howto/custom-template-tags/"},"formats":{"html":"/fr/5.0/howto/custom-template-backend/","markdown":"/fr/5.0/howto/custom-template-backend.md","json":"/fr/5.0/howto/custom-template-backend.json"},"source":"https://github.com/django/django/blob/stable/5.0.x/docs/howto/custom-template-backend.txt","official":"https://docs.djangoproject.com/fr/5.0/howto/custom-template-backend/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}