{"title":"テンプレートのバックエンドをカスタマイズする","version":"5.0","locale":"ja","docname":"howto/custom-template-backend","url":"/ja/5.0/howto/custom-template-backend/","canonical":"https://djangodocs.dev/ja/5.0/howto/custom-template-backend/","summary":"カスタムのバックエンド Link to this heading # ここでは、他のテンプレートシステムを使用するために、カスタムテンプレートバックエンドを実装する方法を説明します。テンプレートバックエンドは django.template.backends.base.BaseEngine を継承したクラスです。このクラスは…","html":"

テンプレートのバックエンドをカスタマイズするLink to this heading#

\n
\n

カスタムのバックエンドLink to this heading#

\n

ここでは、他のテンプレートシステムを使用するために、カスタムテンプレートバックエンドを実装する方法を説明します。テンプレートバックエンドは django.template.backends.base.BaseEngine を継承したクラスです。このクラスは get_template() と、オプションで from_string() を実装する必要があります。以下は架空の 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

詳しい情報は DEP 182 を参照してください。

\n
\n
\n

カスタムエンジンに対するデバッグの統合Link to this heading#

\n

Django のデバッグページには、テンプレートエラーが発生したときに詳細な情報を提供するフックがあります。カスタムのテンプレートエンジンは、これらのフックを使うことで、ユーザに表示されるトレースバック情報を強化できます。以下のフックが利用できます:

\n
\n

テンプレートの postmortem (事後分析)Link to this heading#

\n

postmortemは TemplateDoesNotExist が発生したときに表示されます。これは、指定されたテンプレートを見つけようとしたときに使われたテンプレートエンジンとローダの一覧を表示します。例えば、2つの Django エンジンが設定されている場合、 postmortem は以下のように表示されます:

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

カスタムエンジンは TemplateDoesNotExist を発生させるときに backend と tried 引数を渡すことで postmortem に値を入れることができます。postmortem を使用するバックエンドはテンプレートオブジェクトの origin を指定する 必要があります。

\n
\n
\n

コンテキストの行情報Link to this heading#

\n

もしテンプレートをパースもしくはレンダリングしてる最中にエラーが発生したら、Djangoはエラーが発生した行を表示することができます。たとえば:

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

カスタムエンジンはパースやレンダリング中に発生した例外に template_debug 属性を指定することで、この情報を入力できます。この属性は以下の値を持つ dict です:

\n\n

上記のテンプレートエラーが発生した場合、 template_debug は次のようになります:

\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

Origin API と サードパーティとの統合Link to this heading#

\n

Django テンプレートには Origin オブジェクトがあり、 template.origin 属性で利用できます。これにより、デバッグ情報を テンプレートの postmortem (事後分析) や、 Django Debug Toolbar のようなサードパーティライブラリに表示できます。

\n

カスタムエンジンは、以下の属性を指定するオブジェクトを作成することで、独自の template.origin 情報を提供できます:

\n\n
\n
","rootId":"how-to-implement-a-custom-template-backend","toc":[{"title":"カスタムのバックエンド","anchor":"custom-backends","children":[]},{"title":"カスタムエンジンに対するデバッグの統合","anchor":"debug-integration-for-custom-engines","children":[{"title":"テンプレートの postmortem (事後分析)","anchor":"template-postmortem","children":[]},{"title":"コンテキストの行情報","anchor":"contextual-line-information","children":[]},{"title":"Origin API と サードパーティとの統合","anchor":"origin-api-and-3rd-party-integration","children":[]}]}],"breadcrumbs":[{"docname":"howto/index","title":"「How-to」ガイド","url":"/ja/5.0/howto/"}],"prev":{"docname":"howto/custom-lookups","title":"カスタムのルックアップを書く","url":"/ja/5.0/howto/custom-lookups/"},"next":{"docname":"howto/custom-template-tags","title":"独自のテンプレートタグとフィルタを作る","url":"/ja/5.0/howto/custom-template-tags/"},"formats":{"html":"/ja/5.0/howto/custom-template-backend/","markdown":"/ja/5.0/howto/custom-template-backend.md","json":"/ja/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/ja/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"]}