{"title":"Como implementar um backend de template personalizado","version":"5.1","locale":"pt-br","docname":"howto/custom-template-backend","url":"/pt-br/5.1/howto/custom-template-backend/","canonical":"https://djangodocs.dev/pt-br/5.1/howto/custom-template-backend/","summary":"Aqui está como implementar um backend de template personalizado para utilizar um sistema de template.","html":"

Como implementar um backend de template personalizadoLink para este cabeçalho#

\n
\n

Backends personalizadosLink para este cabeçalho#

\n

Aqui está como implementar um backend de template personalizado para utilizar um sistema de template. Um backend de template precisa herdar de django.template.backends.base.BaseEngine. Precisa implementar get_template() e opcionalmente from_string(). Aqui está um exemplo para a biblioteca de template fícticia 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

Veja a DEP 182 para mais informações.

\n
\n
\n

Debugar a integração para motores personalizadosLink para este cabeçalho#

\n

A página de debug do Django tem hooks para prover informações detalhadas quando um erro de template é levantado. Motores de template customizados podem utilizar estes hooks para melhoras as informações de traceback que aparecem aos usuários. Os seguintes hooks estão disponíveis:

\n
\n

Template postmortemLink para este cabeçalho#

\n

O postmortem aparece quando TemplateDoesNotExist é levantado. Ele lista os motores de template e loaders que foram utilizados ao tentar encontrar o template informado. Por exemplo, se dois motores Django estão configurados, o postmortem será parecido com:

\n\"/pt-br/5.1/_images/postmortem.png\"\n

Motores personalizados podem popular o postmortem por passar o backend e os argumentos tried ao levantar TemplateDoesNotExist. Backends que utilizam o postmortem devem especificar uma origem 1 ao objeto template.

\n
\n
\n

Linha de informações contextuaisLink para este cabeçalho#

\n

Se um erro acontece durante o tratamento ou renderização do template, o Django pode mostrar a linha em que o erro ocorreu. Por exemplo:

\n\"/pt-br/5.1/_images/template-lines.png\"\n

Motores personalizados podem popular esta informação por definir um atributo template_debug nas exceções levantadas durante o tratamento e renderização. Esse atributo é um dict com os seguintes valores:

\n\n

Dado o seguinte erro de template, template_debug se parecerá com:

\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 de Origem e integração com terceirosLink para este cabeçalho#

\n

Django templates have an Origin object available\nthrough the template.origin attribute. This enables debug information to be\ndisplayed in the template postmortem, as well as\nin 3rd-party libraries, like the Django Debug Toolbar.

\n

Motores personalizados podem prover suas próprias informações de template.origin por criar um objeto que especifique os seguintes atributos:

\n\n
\n
","rootId":"how-to-implement-a-custom-template-backend","toc":[{"title":"Backends personalizados","anchor":"custom-backends","children":[]},{"title":"Debugar a integração para motores personalizados","anchor":"debug-integration-for-custom-engines","children":[{"title":"Template postmortem","anchor":"template-postmortem","children":[]},{"title":"Linha de informações contextuais","anchor":"contextual-line-information","children":[]},{"title":"API de Origem e integração com terceiros","anchor":"origin-api-and-3rd-party-integration","children":[]}]}],"breadcrumbs":[{"docname":"howto/index","title":"How-to guides","url":"/pt-br/5.1/howto/"}],"prev":{"docname":"howto/overriding-templates","title":"How to override templates","url":"/pt-br/5.1/howto/overriding-templates/"},"next":{"docname":"howto/custom-template-tags","title":"Como criar tags e filtros de template customizados","url":"/pt-br/5.1/howto/custom-template-tags/"},"formats":{"html":"/pt-br/5.1/howto/custom-template-backend/","markdown":"/pt-br/5.1/howto/custom-template-backend.md","json":"/pt-br/5.1/howto/custom-template-backend.json"},"source":"https://github.com/django/django/blob/stable/5.1.x/docs/howto/custom-template-backend.txt","official":"https://docs.djangoproject.com/pt-br/5.1/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"]}