bernar92
bernar92Dec. 25, 2018, 10:35 p.m.

One possible side menu implementation for Django

Hello. Not long ago there was a task to implement a side menu with a list of directories; so that it can be inserted anywhere and on any page!
The problem was that the list is large and so that it would not load the server, I cached it, but here I will not indicate how I cached it, since it will take a long time to write ...
In general, I will describe everything in order!


Let's start by creating a template tag! in order to implement it! i created a package folder:

you can name it whatever you want, but I named it: context_processors
further created a file: right_menu.py
in which all the logic of the template tag will be implemented.

from products.models import Category
from django.core.cache import cache
from django.db.models.aggregates import Count
from django import template #нужен для регистрации шаблонного тега

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

def get_right_school_menu(request):
    context = {}
    сategory_menu = cache.get('left_сategory_menu_' + request.LANGUAGE_CODE) #так как у меня мультиязычность стоит я сделал так. Оставлю для примера
    context['categorys'] = Category.objects.all()
    return context


further in settings.py we connect the template tag

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.template.context_processors.i18n',
                'django.contrib.messages.context_processors.messages',
                'context_processors.right_menu.get_right_school_menu', # как видете тут я его подключил
            ],
        },
    },
]

in the right_menu.html template itself

{% load static %}
{% load i18n %}
<ul>
    {% for i in categorys %}
    <li>{{ i.name }}</li>
    {% endfor %}
</ul>
We recommend hosting TIMEWEB
We recommend hosting TIMEWEB
Stable hosting, on which the social network EVILEG is located. For projects on Django we recommend VDS hosting.

Do you like it? Share on social networks!

Evgenii Legotckoi
  • Dec. 26, 2018, 3:53 a.m.

Добрый день!

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

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

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

bernar92
  • Dec. 26, 2018, 3:59 a.m.

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

Evgenii Legotckoi
  • Dec. 26, 2018, 4:15 a.m.
  • (edited)

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

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

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

Так?

{% get_right_school_menu %}

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

@register.inclusion_tag('ecore/breadcrumb_home.html')
def breadcrumb_home(url='/', title=''):
    return {
        'url': url,
        'title': title
    }

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

{% breadcrumb_home '/' 'EVILEG' %}

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

bernar92
  • Dec. 26, 2018, 11:16 p.m.
  • (edited)

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

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

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

Evgenii Legotckoi
  • Dec. 27, 2018, 12:17 a.m.

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

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

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

или нет

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

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

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

bernar92
  • Dec. 27, 2018, 12:36 a.m.

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

return render(request, 'includes/header.html', context)
Evgenii Legotckoi
  • Dec. 27, 2018, 12:46 a.m.
  • (edited)

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

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

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

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

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

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

{% load myapp %}
{% right_menu %}

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

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

bernar92
  • Dec. 27, 2018, 1:03 a.m.

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

Evgenii Legotckoi
  • Dec. 27, 2018, 1:09 a.m.

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

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

register = template.Library() 

@register.inclusion_tag('includes/right_menu.html', takes_context=True) 
def right_menu(context):
    context['categorys'] = Category.objects.all()
    return context

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

bernar92
  • Dec. 27, 2018, 1:14 a.m.

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

Evgenii Legotckoi
  • Dec. 27, 2018, 1:17 a.m.

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

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

bernar92
  • Dec. 27, 2018, 2:39 a.m.
  • (edited)

Django 2.1

'schools' is not a registered tag library. Must be one of:
{% load schools %}
{% r_schools %}
bernar92
  • Dec. 27, 2018, 3:37 a.m.

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

'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.template.context_processors.i18n',
                'django.contrib.messages.context_processors.messages',
                'context_processors.right_menu.get_top_string',
                'context_processors.right_menu.right_school'
            ],
            'libraries': {
                'schools': 'schools.templatetags.schools'
            }
        },
Evgenii Legotckoi
  • Dec. 27, 2018, 5:42 a.m.
  • (edited)

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

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

  • schools
    • templatetags
      • __init__.py
      • schools.py
bernar92
  • Dec. 27, 2018, 6:24 a.m.

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

Evgenii Legotckoi
  • Dec. 27, 2018, 7:18 a.m.

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

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

ПК
  • Dec. 28, 2018, 4:02 a.m.

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

Comments

Only authorized users can post comments.
Please, Log in or Sign up
Last comments
k
kmssrFeb. 9, 2024, 5:43 a.m.
Qt Linux - Lesson 001. Autorun Qt application under Linux как сделать автозапуск для флэтпака, который не даёт создавать файлы в ~/.config - вот это вопрос ))
Qt WinAPI - Lesson 007. Working with ICMP Ping in Qt Без строки #include <QRegularExpressionValidator> в заголовочном файле не работает валидатор.
EVA
EVADec. 25, 2023, 9:30 p.m.
Boost - static linking in CMake project under Windows Ошибка LNK1104 часто возникает, когда компоновщик не может найти или открыть файл библиотеки. В вашем случае, это файл libboost_locale-vc142-mt-gd-x64-1_74.lib из библиотеки Boost для C+…
J
JonnyJoDec. 25, 2023, 7:38 p.m.
Boost - static linking in CMake project under Windows Сделал всё по-как у вас, но выдаёт ошибку [build] LINK : fatal error LNK1104: не удается открыть файл "libboost_locale-vc142-mt-gd-x64-1_74.lib" Хоть убей, не могу понять в чём дел…
G
GvozdikDec. 19, 2023, 8:01 a.m.
Qt/C++ - Lesson 056. Connecting the Boost library in Qt for MinGW and MSVC compilers Для решения твой проблемы добавь в файл .pro строчку "LIBS += -lws2_32" она решит проблему , лично мне помогло.
Now discuss on the forum
AC
Alexandru CodreanuJan. 19, 2024, 10:57 p.m.
QML Обнулить значения SpinBox Доброго времени суток, не могу разобраться с обнулением значение SpinBox находящего в делегате. import QtQuickimport QtQuick.ControlsWindow { width: 640 height: 480 visible: tr…
BlinCT
BlinCTDec. 27, 2023, 7:57 p.m.
Растягивать Image на парент по высоте Ну и само собою дял включения scrollbar надо чтобы был Flickable. Так что выходит как то так Flickable{ id: root anchors.fill: parent clip: true property url linkFile p…
Дмитрий
ДмитрийJan. 10, 2024, 3:18 p.m.
Qt Creator загружает всю оперативную память Проблема решена. Удалось разобраться с помощью утилиты strace. Запустил ее: strace ./qtcreator Начал выводиться весь лог работы креатора. В один момент он начал считывать фай…
Evgenii Legotckoi
Evgenii LegotckoiDec. 12, 2023, 5:48 p.m.
Побуквенное сравнение двух строк Добрый день. Там случайно не высылается этот сигнал textChanged ещё и при форматировани текста? Если решиать в лоб, то можно просто отключать сигнал/слотовое соединение внутри слота и …

Follow us in social networks