Разное

Html templates: HTML Templates — HTML Website Templates

25.04.2023

шаблонов | Документация Джанго | Django

Будучи веб-фреймворком, Django нуждается в удобном способе создания HTML динамически. Наиболее распространенный подход основан на шаблонах. Шаблон содержит статические части желаемого вывода HTML, а также некоторый специальный синтаксис описание того, как будет вставляться динамический контент. Для практического примера создание HTML-страниц с помощью шаблонов, см. Учебник 3.

Проект Django может быть настроен с одним или несколькими механизмами шаблонов (или даже ноль, если вы не используете шаблоны). Django поставляет встроенные серверные части для своих собственная система шаблонов, творчески названная языком шаблонов Django (DTL), и для популярной альтернативы Jinja2. Бэкенды для других языков шаблонов могут быть доступным от третьих лиц. Вы также можете написать свой собственный бэкэнд, см. Базовую часть пользовательского шаблона

Django определяет стандартный API для загрузки и рендеринга шаблонов независимо от серверной части.

Загрузка состоит из поиска шаблона для заданного идентификатора и его предварительная обработка, обычно компиляция в представление в памяти. Рендеринг означает интерполяцию шаблона с контекстными данными и возврат результирующая строка.

Язык шаблонов Django является собственным языком Django. система шаблонов. До Django 1.8 это была единственная доступная встроенная опция. Это хорошая библиотека шаблонов, несмотря на то, что она довольно самоуверенна и имеет несколько идиосинкразий. Если у вас нет веских причин выбрать другую серверной части, вам следует использовать DTL, особенно если вы пишете подключаемый приложение, и вы собираетесь распространять шаблоны. Вкладные приложения Django, которые включать шаблоны, такие как django.contrib.admin, использовать ДТЛ.

По историческим причинам как общая поддержка механизмов шаблонов, так и реализация языка шаблонов Django в реальном времени в django.template пространство имен.

Предупреждение

Система шаблонов не защищена от ненадежных авторов шаблонов. Для например, сайт не должен позволять пользователям предоставлять свои собственные шаблоны, поскольку авторы шаблонов могут выполнять такие действия, как XSS-атаки и доступ свойства переменных шаблона, которые могут содержать конфиденциальную информацию.

Язык шаблонов Django

Синтаксис

Об этом разделе

Это обзор синтаксиса языка шаблонов Django. Подробнее см. справочник по синтаксису языка.

Шаблон Django — это текстовый документ или строка Python, размеченная с помощью Язык шаблонов Django. Некоторые конструкции распознаются и интерпретируются шаблонный движок. Основными из них являются переменные и теги.

Шаблон отображается с контекстом. Рендеринг заменяет переменные их значения, которые просматриваются в контексте, и выполняет теги. Все остальное выводится как есть.

Синтаксис языка шаблонов Django включает четыре конструкции.

Переменные

Переменная выводит значение из контекста, который является объектом, подобным словарю сопоставление ключей со значениями.

Переменные окружены {{ и }} следующим образом:

 Мое имя {{ first_name }}. Моя фамилия {{ last_name }}.

В контексте {'first_name': 'John', 'last_name': 'Doe'} этот шаблон рендерит на:

 Меня зовут Джон. Моя фамилия Доу.

Поиск по словарю, поиск по атрибуту и ​​поиск по индексу списка реализованы с запись через точку:

 {{ my_dict.key }}
{{ мой_объект.атрибут }}
{{ мой_список.0 }}

Если переменная преобразуется в вызываемую, система шаблонов вызовет ее без аргументы и использовать его результат вместо вызываемого.

Теги

Теги обеспечивают произвольную логику в процессе рендеринга.

Это определение намеренно расплывчато. Например, тег может выводить контент, служить управляющей структурой, т.е. оператор «если» или цикл «для», возьмите контент из базы данных или даже включить доступ к другим тегам шаблона.

Теги окружены {% и %} вот так:

 {% csrf_token %}

Большинство тегов принимают аргументы:

 {% cycle 'odd' 'even' %}

Для некоторых тегов требуются начальный и конечный теги:

 {% if user.
 
 is_authenticated %}Здравствуйте, {{ user.username }}.{% endif %}

Ссылка на встроенные теги доступны, а также инструкции по написанию пользовательских тегов.

Фильтры

Фильтры преобразуют значения переменных и аргументов тегов.

Они выглядят так:

 {{ django|title }}

В контексте {'django': 'веб-фреймворк для перфекционистов с крайние сроки'} , этот шаблон преобразуется в:

 Веб-платформа для перфекционистов с крайними сроками

Некоторые фильтры принимают аргумент:

 {{ my_date|date:"Y-m-d" }}

Артикул встроенных фильтров доступны, а также инструкции по написанию пользовательских фильтров.

Компоненты

Об этом разделе

Это обзор API языка шаблонов Django. Подробнее см. справочник по API.

Engine

django.template.Engine инкапсулирует экземпляр Django система шаблонов. Основная причина создания экземпляра Engine напрямую использует шаблон Django. язык вне проекта Django.

django.template.backends.django.DjangoTemplates — тонкая оболочка адаптация django.template.Engine в бэкэнд API шаблонов Django.

Шаблон

django.template.Template представляет собой скомпилированный шаблон. Шаблоны получено с помощью

Engine.get_template() или Engine.from_string() .

Аналогично django.template.backends.django.Template — тонкая оболочка адаптация django.template.Template к общему API шаблонов.

Контекст

django.template.Context содержит некоторые метаданные в дополнение к контексту данные. Он передан на Template.render() для рендеринга шаблона.

django.template.RequestContext является подклассом Контекст , в котором хранится текущий HttpRequest и запускает обработчики контекста шаблона.

Общий API не имеет эквивалентной концепции.

Контекстные данные передаются в простой dict и текущий HttpRequest передается отдельно, если нужно.

Загрузчики

Загрузчики шаблонов отвечают за поиск шаблонов, их загрузку и возвращение Шаблон объектов.

Django предоставляет несколько встроенных загрузчиков шаблонов и поддерживает пользовательские загрузчики шаблонов.

Контекстные процессоры

Контекстные процессоры — это функции, которые получают текущие HttpRequest в качестве аргумента и вернуть dict из данные, которые будут добавлены в контекст рендеринга.

Их основное назначение — добавить в контекст общие данные, используемые всеми шаблонами. без повторения кода в каждом представлении.

Django предоставляет множество встроенных контекстных процессоров, и вы также можете реализовать свои собственные дополнительные процессоры контекста.

Поддержка механизмов шаблонов

Конфигурация

Механизмы шаблонов настраиваются с помощью параметра ШАБЛОНЫ . Это список конфигураций, по одной для каждого двигателя. Значение по умолчанию пусто. settings.py , сгенерированный командой startproject , определяет более полезное значение:

 ШАБЛОНЫ = [
    {
        'БЭКЭНД': 'django.template.backends.django.DjangoTemplates',
        'КАТАЛОГИ': [],
        'APP_DIRS': правда,
        'ПАРАМЕТРЫ': {
            # ... некоторые варианты здесь ...
        },
    },
]

BACKEND — путь Python к шаблону с точками. класс движка, реализующий бэкэнд API шаблонов Django. Встроенные серверные части django.template.backends.django.DjangoTemplates и django.template.backends.jinja2.Jinja2 .

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

  • DIRS определяет список каталогов, в которых Engine должен искать исходные файлы шаблонов в порядке поиска.
  • APP_DIRS сообщает, должен ли двигатель ищите шаблоны внутри установленных приложений. Каждый сервер определяет обычное имя для подкаталога внутри приложений, где его шаблоны должны быть сохранены.

Хотя это редкость, можно настроить несколько экземпляров одного и того же бэкэнд с различными опциями. В этом случае вы должны определить уникальный НАЗВАНИЕ для каждого двигателя.

ОПЦИИ содержит настройки, специфичные для серверной части.

Использование

Модуль django.template.loader определяет две функции для загрузки шаблонов.

get_template ( имя_шаблона , использование = Нет )

Эта функция загружает шаблон с заданным именем и возвращает Шаблон объекта.

Точный тип возвращаемого значения зависит от серверной части, которая загрузила шаблон. У каждого бэкенда есть свой класс Template .

get_template() пытается использовать каждый механизм шаблонов по порядку, пока не будет достигнут успех. Если шаблон не может быть найден, он поднимает TemplateDoesNotExist . Если шаблон найден, но содержит неверный синтаксис, вызывает TemplateSyntaxError .

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

Если вы хотите ограничить поиск определенной системой шаблонов, передайте двигатель НАЗВАНИЕ в с использованием аргумент.

select_template ( template_name_list , использование = Нет )

select_template() аналогичен get_template() , за исключением того, что он принимает список имен шаблонов. Он пробует каждое имя по порядку и возвращает первое существующий шаблон.

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

исключение TemplateDoesNotExist ( msg , пытался = нет , серверная часть = нет , цепочка = нет )

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

бэкэнд
Экземпляр бэкенда шаблона, из которого возникло исключение.
пытался
Список источников, которые были проверены при поиске шаблона. Это отформатирован как список кортежей, содержащих (происхождение, статус) , где origin — это объект, похожий на origin, и статус — это строка с причиной, по которой шаблон не найден.
цепочка
Список промежуточных звеньев TemplateDoesNotExist исключения, возникающие при попытке загрузить шаблон. Это используется функции, такие как get_template() , что попробуйте загрузить данный шаблон из нескольких движков.
исключение TemplateSyntaxError ( сообщение )

Это исключение возникает, когда шаблон найден, но содержит ошибки.

Шаблон объектов, возвращенных get_template() и select_template() должен предоставить метод render() со следующей подписью:

Шаблон. рендеринг ( контекст = нет , запрос = нет )

Визуализирует этот шаблон с заданным контекстом.

Если предоставлен контекст , это должен быть dict . Если это не так при условии, что движок отобразит шаблон с пустым контекстом.

Если предоставлен запрос , это должен быть HttpRequest . Затем движок должен сделать его, а также токен CSRF, доступным в шаблон. Как это достигается, зависит от каждого бэкэнда.

Вот пример алгоритма поиска. Для этого примера ШАБЛОНЫ настройка:

 ШАБЛОНЫ = [
    {
        'БЭКЭНД': 'django.template.backends.django.DjangoTemplates',
        'КАТАЛОГИ': [
            '/home/html/example.com',
            '/дом/html/по умолчанию',
        ],
    },
    {
        'БЭКЭНД': 'django.template.backends.jinja2.Jinja2',
        'КАТАЛОГИ': [
            '/дом/html/джинджа2',
        ],
    },
]

Если вы позвоните get_template('story_detail.html') , вот файлы Django будем искать по порядку:

  • /home/html/example.com/story_detail.html ( 'django' engine)
  • /home/html/default/story_detail.html ( 'django' двигатель)
  • /home/html/jinja2/story_detail.html ( 'jinja2' двигатель )

При вызове select_template(['story_253_detail. html', 'story_detail.html']) , вот что Django будет искать:

  • /home/html/example.com/story_253_detail.html ( 'django' engine)
  • /home/html/default/story_253_detail.html ( 'django' двигатель)
  • /home/html/jinja2/story_253_detail.html (двигатель 'jinja2' )
  • /home/html/example.com/story_detail.html ( 'django' двигатель )
  • /home/html/default/story_detail.html (двигатель "Джанго" )
  • /home/html/jinja2/story_detail.html ( 'jinja2' двигатель )

Когда Django находит существующий шаблон, он прекращает поиск.

Совет

Вы можете использовать select_template() для гибкого загрузка шаблона. Например, если вы написали новость и хотите некоторые истории, чтобы иметь собственные шаблоны, используйте что-то вроде select_template(['story_%s_detail. html' % story.id, 'story_detail.html']) . Это позволит вам использовать собственный шаблон для отдельной истории с запасным шаблоном для историй, у которых нет пользовательские шаблоны.

Возможно и желательно организовать шаблоны в подкаталогах внутри каждого каталога, содержащего шаблоны. Конвенция состоит в том, чтобы сделать подкаталог для каждого приложения Django с подкаталогами внутри этих подкаталоги по мере необходимости.

Сделай это для собственного рассудка. Хранение всех шаблонов на корневом уровне один каталог становится грязным.

Чтобы загрузить шаблон, находящийся в подкаталоге, используйте косую черту, например:

 get_template('news/story_detail.html')

При использовании той же опции ШАБЛОНЫ , что и выше, это попытается загрузить следующие шаблоны:

  • /home/html/example.com/news/story_detail.html ( 'django' engine)
  • /home/html/default/news/story_detail. html ( 'django' двигатель)
  • /home/html/jinja2/news/story_detail.html (двигатель 'jinja2' )

Кроме того, чтобы сократить повторяющийся характер загрузки и рендеринга шаблоны, Django предоставляет функцию быстрого доступа, которая автоматизирует процесс.

render_to_string ( имя_шаблона , контекст = нет , запрос = нет , использование = нет )

render_to_string() загружает шаблон, например get_template() и вызывает его render() 9Метод 0012 немедленно. Требуется следующее аргументы.

имя_шаблона
Имя шаблона для загрузки и отображения. Если это список шаблонов имена, Django использует select_template() вместо get_template() , чтобы найти шаблон.
context
dict , который будет использоваться в качестве контекста шаблона для рендеринга.
запрос
Необязательный HttpRequest , который будет доступен в процессе рендеринга шаблона.
с использованием
Дополнительный механизм шаблонов ИМЯ . поиск шаблона будет ограничен этим движком.

Пример использования:

 из импорта django.template.loader render_to_string
rendered = render_to_string('my_template.html', {'foo': 'bar'})

См. также ярлык render() , который вызывает render_to_string() и передает результат в HttpResponse подходит для возврата из представления.

Наконец, вы можете использовать настроенные двигатели напрямую:

двигатели

Механизмы шаблонов доступны в django.template.engines :

 из механизмов импорта django.template
django_engine = двигатели['django']
template = django_engine.from_string("Привет, {{имя}}!")

Ключ поиска — 'django' в данном примере — это ключ ИМЯ .

Встроенные серверные части

класс DjangoTemplates

Установите BACKEND на 'django.template.backends.django.DjangoTemplates' для настройки Django шаблонный движок.

Когда APP_DIRS равно True , DjangoTemplates двигатели ищут шаблоны в подкаталоге templates установленных Приложения. Это общее имя было сохранено для обратной совместимости.

Механизмы DjangoTemplates принимают следующие OPTIONS :

  • 'autoescape' : логическое значение, которое определяет, является ли автоматическое экранирование HTML включено.

    По умолчанию True .

    Предупреждение

    Установите значение False только в том случае, если вы рендерите шаблоны, отличные от HTML!

  • 'context_processors' : список точечных путей Python к вызываемым объектам, которые используются для заполнения контекста при отображении шаблона с запросом. Эти вызываемые объекты принимают объект запроса в качестве аргумента и возвращают dict элементов, которые нужно объединить в контекст.

    По умолчанию это пустой список.

    См. RequestContext для получения дополнительной информации.

  • 'debug' : логическое значение, которое включает/выключает режим отладки шаблона. Если это True , причудливая страница ошибок будет отображать подробный отчет для любого исключение, возникающее во время рендеринга шаблона. Этот отчет содержит соответствующий фрагмент шаблона с выделенной соответствующей строкой.

    По умолчанию используется значение параметра DEBUG .

  • 'загрузчики' : список путей Python к классам загрузчиков шаблонов, разделенных точками. Каждый класс Loader знает, как импортировать шаблоны из определенного источник. При желании вместо строки можно использовать кортеж. Первый пункт в кортеже должно быть имя класса Loader , а последующие элементы передается загрузчику во время инициализации.

    Значение по умолчанию зависит от значений ДИРС и APP_DIRS .

    Дополнительные сведения см. в разделе Типы загрузчиков.

  • 'string_if_invalid' : вывод в виде строки, которую система шаблонов следует использовать для недопустимых (например, с ошибками) переменных.

    По умолчанию это пустая строка.

    Дополнительные сведения см. в разделе Как обрабатываются недопустимые переменные.

  • 'file_charset' : кодировка, используемая для чтения файлов шаблонов на диске.

    По умолчанию 'утф-8' .

  • «библиотеки» : словарь меток и точечных путей Python к шаблону пометить модули для регистрации в механизме шаблонов. Это можно использовать для добавления новые библиотеки или предоставить альтернативные метки для существующих. Например:

     ОПЦИИ={
    'библиотеки': {
        'myapp_tags': 'path.to.myapp.tags',
        'admin. urls': 'django.contrib.admin.templatetags.admin_urls',
    },
}

    Библиотеки можно загрузить, передав соответствующий ключ словаря в {% load %} тег.

  • 'встроенные модули' : список точечных путей Python модулей тегов шаблона к добавить во встроенные. Например:

     ОПЦИИ={
    'встроенные': ['myapp.builtins'],
}

    Теги и фильтры из встроенных библиотек можно использовать без предварительного вызова тег {% load %} .

класс Джинджа2

Требуется установка Jinja2:

/

 $ python -m pip установить Jinja2
 
 ...\> py -m pip установить Jinja2

Установить БЭКЭНД на 'django.template.backends.jinja2.Jinja2' для настройки движка Jinja2.

Когда APP_DIRS равно True , Jinja2 двигателей ищите шаблоны в подкаталоге jinja2 установленных приложений.

Самая важная запись в ОПЦИИ 'окружающая среда' . Это пунктирный путь Python к вызываемому объекту, возвращающему Jinja2. среда. По умолчанию 'jinja2.Окружающая среда' . Джанго вызывает это callable и передает другие параметры в качестве аргументов ключевого слова. Кроме того, Джанго добавляет значения по умолчанию, которые отличаются от Jinja2 для нескольких параметров:

  • 'autoescape' : True
  • «загрузчик» : загрузчик, настроенный для DIRS и APP_DIRS
  • 'auto_reload' : настройки. DEBUG
  • 'undefined' : DebugUndefined if settings.DEBUG else Undefined

Механизмы Jinja2 также принимают следующие ОПЦИИ :

  • 'context_processors' : список путей Python к вызываемым объектам, разделенных точками. используются для заполнения контекста при отображении шаблона с запросом. Эти вызываемые объекты принимают объект запроса в качестве аргумента и возвращают dict элементов для объединения в контекст.

    По умолчанию это пустой список.

    Использование процессоров контекста с шаблонами Jinja2 не рекомендуется.

    Контекстные процессоры полезны с шаблонами Django, потому что шаблоны Django не поддерживают вызов функций с аргументами. Поскольку в Jinja2 нет это ограничение, рекомендуется поставить функцию, которую вы будете использовать в качестве обработчик контекста в глобальных переменных, доступных шаблону, используя jinja2.Environment , как описано ниже. Затем вы можете вызвать эту функцию в шаблон:

     {{ функция (запрос) }}

    Некоторые обработчики контекста шаблонов Django возвращают фиксированное значение. Для Джинджа2 шаблоны, этот уровень косвенности не нужен, так как вы можете добавить константы непосредственно в jinja2. Окружающая среда .

    Исходный вариант использования для добавления процессоров контекста для Jinja2 включал:

    • Выполнение дорогостоящих вычислений, зависящих от запроса.
    • Нужен результат в каждом шаблоне.
    • Использование результата несколько раз в каждом шаблоне.

    Если не выполнены все эти условия, передача функции в шаблон невозможна. больше соответствует дизайну Jinja2.

Конфигурация по умолчанию намеренно сведена к минимуму. Если шаблон отображается с запросом (например, при использовании рендер() ), серверная часть Jinja2 добавляет глобальные переменные request , csrf_input и csrf_token в контекст. Кроме того, этот бэкэнд не создает Среда со вкусом Джанго. Он не знает о фильтрах и тегах Django. Чтобы использовать специфичные для Django API, вы должны настроить их в среда.

Например, вы можете создать myproject/jinja2. py с таким содержимым:

 из django.templatetags.static import static
из django.urls импортировать в обратном порядке
из среды импорта jinja2
среда определения (** параметры):
    env = Окружающая среда (** параметры)
    env.globals.update({
        «статический»: статический,
        'адрес': обратный,
    })
    вернуть окружение

и установите для параметра 'environment' значение 'myproject.jinja2.environment' .

Затем вы можете использовать следующие конструкции в шаблонах Jinja2:

 Company Logo
Администрирование

Концепции тегов и фильтров существуют как в языке шаблонов Django, и в Jinja2, но они используются по-разному. Так как Jinja2 поддерживает передачу аргументы для вызываемых объектов в шаблонах, многие функции, требующие тега шаблона или фильтр в шаблонах Django можно получить, вызвав функцию в Jinja2 шаблоны, как показано в примере выше.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *