Как переопределить шаблоны

В вашем проекте вы можете захотеть переопределить шаблон в другом приложении Django, будь то стороннее приложение или приложение contrib, например django.contrib.admin. Вы можете разместить переопределения шаблонов в каталоге шаблонов вашего проекта или в каталоге шаблонов приложения.

Если у вас есть каталоги шаблонов приложения и проекта, оба содержащие переопределения, по умолчанию загрузчик шаблонов Django сначала попытается загрузить шаблон из каталога уровня проекта. Другими словами, DIRS ищется до APP_DIRS.

Переопределение из каталога шаблонов проекта

Сначала рассмотрим переопределение шаблонов путем создания замещающих шаблонов в каталоге шаблонов вашего проекта.

Допустим, вы пытаетесь переопределить шаблоны для стороннего приложения под названием blog, которое предоставляет шаблоны blog/post.html и blog/list.html. Соответствующие настройки вашего проекта будут выглядеть следующим образом:

from pathlib import Path

BASE_DIR = Path(__file__).resolve().parent.parent

INSTALLED_APPS = [
    ...,
    'blog',
    ...,
]

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates'],
        'APP_DIRS': True,
        ...
    },
]

Настройка TEMPLATES и BASE_DIR уже существуют, если вы создали свой проект с помощью шаблона проекта по умолчанию. Необходимо изменить настройку DIRS.

Эти настройки предполагают, что у вас есть каталог templates в корне вашего проекта. Чтобы переопределить шаблоны для приложения blog, создайте папку в каталоге templates и добавьте в неё файлы шаблонов:

templates/
    blog/
        list.html
        post.html

Загрузчик шаблонов сначала ищет шаблоны в каталоге DIRS. Когда представления в приложении blog запрашивают шаблоны blog/post.html и blog/list.html, загрузчик вернёт только что созданные файлы.

Переопределение из каталога шаблонов приложения

Поскольку вы переопределяете шаблоны, расположенные вне одного из ваших приложений проекта, более распространено использование первого метода и размещение переопределений шаблонов в папке шаблонов проекта. Однако, по желанию, переопределения также можно поместить в каталог шаблонов приложения.

Сначала убедитесь, что ваши настройки шаблонов проверяют каталоги приложений:

TEMPLATES = [
    {
        ...,
        'APP_DIRS': True,
        ...
    },
]

Если вы хотите поместить переопределения шаблонов в приложение под названием myapp и шаблоны для переопределения называются blog/list.html и blog/post.html, структура каталогов будет выглядеть так:

myapp/
    templates/
        blog/
            list.html
            post.html

С APP_DIRS, установленным в True, загрузчик шаблонов будет искать шаблоны в каталоге шаблонов приложения и найдёт их.

Расширение переопределённого шаблона

После настройки загрузчиков шаблонов вы можете расширить шаблон, используя тег шаблона {% extends %}, одновременно переопределяя его. Это может позволить внести небольшие изменения без необходимости повторной реализации всего шаблона.

Например, вы можете использовать эту технику, чтобы добавить пользовательский логотип в шаблон admin/base_site.html:

 {% extends "admin/base_site.html" %}

 {% block branding %}
     <img src="link/to/logo.png" alt="logo">
     {{ block.super }}
 {% endblock %}

Ключевые моменты:

• В примере создается файл в templates/admin/base_site.html, который использует настроенный каталог templates уровня проекта для переопределения admin/base_site.html.
• Новый шаблон расширяет admin/base_site.html, который является тем же самым шаблоном, что и переопределяется.
• Шаблон заменяет только блок branding, добавляя пользовательский логотип и используя block.super, чтобы сохранить предыдущее содержимое.
• Остальная часть шаблона унаследована без изменений от admin/base_site.html.

Эта техника работает, потому что загрузчик шаблонов не учитывает уже загруженный шаблон-переопределение (в templates/admin/base_site.html) при разрешении тега extends. В сочетании с block.super это мощная техника для внесения небольших изменений.