Spec-Zone.ru › Django 3.2

Переопределение шаблонов

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

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

См. также

Прочитайте Переопределение встроенных шаблонов виджетов, если вы хотите это сделать.

Переопределение из директории templates проекта

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

Предположим, вы пытаетесь переопределить шаблоны стороннего приложения под названием 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 приложения

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

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

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

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

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

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

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

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

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

templates/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 это мощный метод для внесения небольших изменений.

© Django Software Foundation and individual contributors
Licensed under the BSD License.
https://docs.djangoproject.com/en/3.2/howto/overriding-templates/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API