bernar92
26 декабря 2018 г. 10:35

Одна из возможных реализаций бокового меню для Django

Привет. Не давно была задача реализовать боковое меню со списком каталогов; что бы его можно было вставить в любое место и в любую страницу!
Проблема заключалась в том что список большой и для того что бы он не нагружал сервак я его закэшировал, но тут не буду указывать как закэшировал так как писать придется долго...
В общем буду описывать все по порядку!


Начнем с создания шаблонного тега! для того что бы его реализовать! я создал папку пакета:

назвать его можно как хотите но я его назвал его: context_processors
далее создал файл : right_menu.py
в котором будет реализована вся логика шаблонного тега.

  1. from products.models import Category
  2. from django.core.cache import cache
  3. from django.db.models.aggregates import Count
  4. from django import template #нужен для регистрации шаблонного тега
  5.  
  6. register = template.Library() #тут мы присваем значение
  7. @register.inclusion_tag('includes/right_menu.html') #декоратор для регистрации шаблона для подключения (я его указал в папке templates где находится base.html
  8.  
  9. def get_right_school_menu(request):
  10. context = {}
  11. сategory_menu = cache.get('left_сategory_menu_' + request.LANGUAGE_CODE) #так как у меня мультиязычность стоит я сделал так. Оставлю для примера
  12. context['categorys'] = Category.objects.all()
  13. return context
  14.  
  15.  

далее в settings.py подключаем шаблонный тег

  1. TEMPLATES = [
  2. {
  3. 'BACKEND': 'django.template.backends.django.DjangoTemplates',
  4. 'DIRS': [os.path.join(BASE_DIR, 'templates')],
  5. 'APP_DIRS': True,
  6. 'OPTIONS': {
  7. 'context_processors': [
  8. 'django.template.context_processors.debug',
  9. 'django.template.context_processors.request',
  10. 'django.contrib.auth.context_processors.auth',
  11. 'django.template.context_processors.i18n',
  12. 'django.contrib.messages.context_processors.messages',
  13. 'context_processors.right_menu.get_right_school_menu', # как видете тут я его подключил
  14. ],
  15. },
  16. },
  17. ]

в самом шаблоне right_menu.html

  1. {% load static %}
  2. {% load i18n %}
  3. <ul>
  4. {% for i in categorys %}
  5. <li>{{ i.name }}</li>
  6. {% endfor %}
  7. </ul>

По статье задано0вопрос(ов)

4

Вам это нравится? Поделитесь в социальных сетях!

Evgenii Legotckoi
  • 26 декабря 2018 г. 15:53

Добрый день!

Я добавил разделитель контента в статье, чтобы скрыть под катом основной содержание статьи. Спасибо за материал.

У меня есть вопрос, а почему не использовали просто папку templatetags для этого, например как здесь ?
Вы же здесь по сути написали middleware. Если таких inclusion tag будет очень много, то придётся каждый записывать в context processors.

Впрочем вы ответили на один из моих вопросов, как избавиться от подключения модуля, которым я задавался. Но минус по-моему в том, что потом придётся всё записывать в context_processors ....

bernar92
  • 26 декабря 2018 г. 15:59

так ты там тоже используешь теги! только симпл упращенный тег! только в твоем случает ты не подгружаешь шаблон! а так суть одна! но в моем случае я просто вывожу через инклуде ) он хорош для менюшек! Я так считаю ))

Evgenii Legotckoi
  • 26 декабря 2018 г. 16:15
  • (ред.)

Согласен, что для менюшек хороши, я много чего на них сделал уже

Кстати, самого примере применения get_right_school_menu нет.

Как именно он выглядит в шаблоне?

Так?

  1. {% get_right_school_menu %}

inclusion tag делается точно так же в templatetags, вот например

  1. @register.inclusion_tag('ecore/breadcrumb_home.html')
  2. def breadcrumb_home(url='/', title=''):
  3. return {
  4. 'url': url,
  5. 'title': title
  6. }

применение в шаблоне будет таким

  1. {% breadcrumb_home '/' 'EVILEG' %}

Просто у меня на сайте сейчас используется более 35-ти inclusion_tag, я бы свихнулся каждый прописывать в context_processros. Да и минус такого подхода в том, что каждый запрос обрабатывается всеми middleware вне зависимости, используется он или нет. То есть всё равно будет искаться тот метод, который ты используешь в шаблонах, даже если он не был там задействован. То есть, если тег не используется, то middleware работает вхолостую, тогда как templatetags будет подгружаться тогда, когда он действительно нужен.

bernar92
  • 27 декабря 2018 г. 11:16
  • (ред.)

нет!
будет так:

  1. {% include 'ecore/breadcrumb_home.html' %}

просто инклудишь шаблон где тебе он нужен и все!

Evgenii Legotckoi
  • 27 декабря 2018 г. 12:17

Понятно, тогда это статья не о применении тега, а о написании context processor.

Видишь ли, тег include работает независимо от того, напишешь ли ты это

  1. register = template.Library() #тут мы присваем значение
  2. @register.inclusion_tag('includes/right_menu.html') #декоратор для регистрации шаблона для подключения (я его указал в папке templates где находится base.html

или нет

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

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

А context proccessor я понимаю почему там написан, как раз, чтобы генерить все эти категории вне зависимости от страницы, на которой находится пользователь. Но реально, отвечаю, те две строки лишние и работают вхолостую, их можно удалить и ровным счётом ничего не изменится.

bernar92
  • 27 декабря 2018 г. 12:36

то есть ты предлагаешь рендерить на прямую?

  1. return render(request, 'includes/header.html', context)
Evgenii Legotckoi
  • 27 декабря 2018 г. 12:46
  • (ред.)

нет, я предлагаю сделать так. В каталоге приложения добавляешь каталог templatetags , а внутри него два файла, init .py и файл с названием приложения. Будет выглядеть так

то есть структура app будет такая

  • myapp
    • templatetags
      • __init__.py
      • myapp.py

А далее добавляешь в файл с названием приложения свой inclusion_tag следующим образом

  1. register = template.Library()
  2. @register.inclusion_tag('includes/right_menu.html', takes_context=True)
  3. def right_menu(context):
  4. return context

А потом в шаблоне вызываешь

  1. {% load myapp %}
  2. {% right_menu %}

Твой context processor добавит в контекст всё необходимое, а настройка takes_context=True позволит тегу его захватить.

Преимущество в данном случае будет в том, что шаблон будет реально закеширован и django не будет искать его при каждом рендеринге

bernar92
  • 27 декабря 2018 г. 13:03

а в settings тогда его нужно убрать! верно я понимаю?!

Evgenii Legotckoi
  • 27 декабря 2018 г. 13:09

нет, в твоём случае он остается, это штука добавляет в контекст category при каждой обработке запроса.

Впрочем, если переписать так

  1. register = template.Library()
  2.  
  3. @register.inclusion_tag('includes/right_menu.html', takes_context=True)
  4. def right_menu(context):
  5. context['categorys'] = Category.objects.all()
  6. return context

То тогда да, можно и удалить из settings, тогда context processor тебе и вовсе не нужен

bernar92
  • 27 декабря 2018 г. 13:14

is not a registered tag library. Must be one of:

Evgenii Legotckoi
  • 27 декабря 2018 г. 13:17

какая версия django?

Ну и структура каталогов и файлов, как написал выше, а также перезапустить инстанс джанги, если Debug=False, то автоматически не подхватывается без перезапуска

bernar92
  • 27 декабря 2018 г. 14:39
  • (ред.)

Django 2.1

  1. 'schools' is not a registered tag library. Must be one of:
  2. {% load schools %}
  3. {% r_schools %}
bernar92
  • 27 декабря 2018 г. 15:37

пришлось зарегать его в

  1. 'OPTIONS': {
  2. 'context_processors': [
  3. 'django.template.context_processors.debug',
  4. 'django.template.context_processors.request',
  5. 'django.contrib.auth.context_processors.auth',
  6. 'django.template.context_processors.i18n',
  7. 'django.contrib.messages.context_processors.messages',
  8. 'context_processors.right_menu.get_top_string',
  9. 'context_processors.right_menu.right_school'
  10. ],
  11. 'libraries': {
  12. 'schools': 'schools.templatetags.schools'
  13. }
  14. },
Evgenii Legotckoi
  • 27 декабря 2018 г. 17:42
  • (ред.)

Странно конечно, что потребовалось добавлять каталог в libraries.

Ты добавил файл __init__.py в каталог templatetags? Чтобы получилась следующая структура

  • schools
    • templatetags
      • __init__.py
      • schools.py
bernar92
  • 27 декабря 2018 г. 18:24

да. не помогло. наверное изза того что джанго 2

Evgenii Legotckoi
  • 27 декабря 2018 г. 19:18

у меня тоже Django 2, не в этом дело, скорее всего в настройках ещё что-то пропущено, не знаю, мне всегда хватало того, что я указал уже выше.

Видимо я не обращал внимание на это

ПК
  • 28 декабря 2018 г. 16:02

Шаблонные теги здесь совсем не причём. Уберите строки с template.Library, измените название на что то типа "одна из возможных реализаций бокового меню" и будет статья о контекстных процессорах в django для самых начинающих.

Комментарии

Только авторизованные пользователи могут публиковать комментарии.
Пожалуйста, авторизуйтесь или зарегистрируйтесь