Как отобразить в шаблоне рекурсивность древовидной структуру?

Question

[nurzhannogerbek]

Здравствуйте! Помогите пожалуйста разобраться.

Есть две модели данных: Document, DocumentClosure. В БД создаются две таблицы с архитектурой «Closure Table».

ВОПРОС: Как отобразить в шаблоне древовидную структуру на основе этих моделей данных? Нужно ведь создать некую рекурсивность в шаблоне я так полагаю и для этого вроде нужно создать кастомный тег? Можете ли помочь разобраться, не могу все в голове уложить.

models.py:

class Document(models.Model):
    name = models.TextField(verbose_name='Название', blank=True, null=True)

class DocumentClosure(models.Model):
    parent = models.ForeignKey(
        Document,
        on_delete=models.CASCADE,
        related_name="parents",
        related_query_name="parent",
        db_column='parent_id',
        blank=True,
        null=True
    )

    child = models.ForeignKey(
        Document,
        on_delete=models.CASCADE,
        related_name="childs",
        related_query_name="child",
        db_column='child_id',
        blank=True,
        null=True
    )

    level = models.IntegerField(
        verbose_name='Уровень вложенности',
        default=0,
        blank=True,
        null=True
    )

P.S. Знаю, что есть временем проверенное приложение django-mptt, но в этом приложении используется «Nested Sets». Не буду вдаваться во все подробности, но для моих конкретных нужд меня интересует именно архитектура «Closure Table». Поэтому прощу django-mptt не предлагать.

Answer 1

[Roman K]

nested set — это частный случай mptt. Можно было бы и разобраться. У тебя же тут просто ссылка на родителя.

Да, пиши кастомный тэг, как у mptt. Благословляю.

Comments

[nurzhannogerbek]

Здравствуйте! :) Спасибо вам за замечания, не судите пожалуйста строго. Вроде изучал разные архитектуры хранения иерархических данных, видимо что-то упустил. Просто django-mptt создает одну таблицу, в которой все хранится. Нужно было уйти от подхода с полем parent_id c одной табличкой (хоть и django-mptt сохраняет ссылочную целостность вроде для поля parent_id), поэтому пытаюсь реализовать Closure Table. Уже несколько дней ломаю голову. Подумал, что опытные программисты как вы смогут помочь обрисовать логику подобного кастомного тэга.

Я правильно понимаю нужно в тег передать queryset, далее данный queryset преобразовать в json в формате грубо говоря:

[{"id":1},{"id":2},{"id":3,"children":[{"id":4},{"id":5}]}]

Далее с помощью этого json встравлять ul li к примеру...
Я вижу вы хорошо ознакомлены с django-mptt. Какой механизм в их тэге?

[Roman K]

NogerbekNurzhan, https://github.com/django-mptt/django-mptt/blob/ma...
Вот такой)

Но я всё равно не понимаю, какой смысл в реализации своего велосипеда (кроме самого факта реализации этого велосипеда)?

[Артем Советников]

Там всё просто реализовывается. Берёте сам тег для механики отрисовки и надо реализовать метод get_children для Document по аналогии с mptt, в mptt он реализован через глобальный метод, который распихивает потомков по Model объектам, чтобы в базу десять раз не обращаться https://github.com/django-mptt/django-mptt/blob/85...

[nurzhannogerbek]

Артем Советников, Здравствуйте! Я так понял это тег для механики отрисовки в django-mptt:

@register.tag
def recursetree(parser, token):
    bits = token.contents.split()
    if len(bits) != 2:
        raise template.TemplateSyntaxError(_('%s tag requires a queryset') % bits[0])
    queryset_var = template.Variable(bits[1])
    template_nodes = parser.parse(('endrecursetree',))
    parser.delete_first_token()
    return RecurseTreeNode(template_nodes, queryset_var)

Взял его за основу. Далее я так понимаю вы предлогаете переделать RecurseTreeNode, в частности метод get_children(), который в нем используется. Можете пожалуйста поподробней расказать или показать? Малось запутался...

[Артем Советников]

get_children() это для Document (класса модели).
RecurseTreeNode._render_node вызывает сам себя рекурсивно для всех узлов начиная с переданных в RecurseTreeNode корневых (queryset_var) и для всех которые он получит в get_children(). Начинает отрисовку он кажется с листьев, но это не так важно сейчас.
А get_children() просто возвращает всех непосредственных потомков.

Сделайте простой вариант без кеширования, когда он заработает просто добавите кэширование (зачитаете все узлы дерева одним запросом к БД и распихаете по Document._children_cache (например), и будете возвращаеть _children_cache в своём get_children().
Поставьте себе django-mptt и поковыряйтесь в исходниках, там всё просто, всего 2-3 функции задействовано.

[nurzhannogerbek]

Артем Советников, Артем здравствуйте! :) Как раз копаюсь, разбираюсь. C методом recursetree полностью разобрался. В классе RecurseTreeNode есть два метода (render и _render_node). Как вы и советовали в методе render убрал кэширование (если не ошибаюсь за него отвечает cache_tree_children), а метод _render_node оставил без изменений. Теперь в файле models.py приступил к get_children, но здесь есть проблемки. Ведь в django-mptt есть поле parent в главной модели данных. В моем случаи я его вынес в отдельную модель DocumentClosure. При попытки запуска страницы c текущем кодом выдает ошибку. Видимо я куда-то не туда свернул или что-то упустил? Как бы вы переписали get_children? Если честно очень много взаимосвязей и малось мудрено. Нужен ли мне учитывать в get_children то что находится в блоке else. Нужно ли зарегистрировать self._tree_manager заранее где-то зарегистрировать, инициализировать?

custom_tags.py:

from django import template

register = template.Library()

@register.tag
def recursetree(parser, token):
    bits = token.contents.split()
    if len(bits) != 2:
        raise template.TemplateSyntaxError(_('%s tag requires a queryset') % bits[0])
    queryset_var = template.Variable(bits[1])
    template_nodes = parser.parse(('endrecursetree',))
    parser.delete_first_token()
    return RecurseTreeNode(template_nodes, queryset_var)


class RecurseTreeNode(template.Node):
    def __init__(self, template_nodes, queryset_var):
        self.template_nodes = template_nodes
        self.queryset_var = queryset_var

    def _render_node(self, context, node):
        bits = []
        context.push()
        for child in node.get_children():
            bits.append(self._render_node(context, child))
        context['node'] = node
        context['children'] = mark_safe(''.join(bits))
        rendered = self.template_nodes.render(context)
        context.pop()
        return rendered

    def render(self, context):
        queryset = self.queryset_var.resolve(context)
        roots = queryset  # Убрал cache_tree_children()
        bits = [self._render_node(context, node) for node in roots]
        return ''.join(bits)

models.py:

from functools import wraps

def raise_if_unsaved(func):
    @wraps(func)
    def _fn(self, *args, **kwargs):
        if not self.pk:
            raise ValueError(
                'Cannot call %(function)s on unsaved %(class)s instances'
                % {'function': func.__name__, 'class': self.__class__.__name__}
            )
        return func(self, *args, **kwargs)
    return _fn


class Document(models.Model):
    ***

    @raise_if_unsaved
    def get_children(self):
        if hasattr(self, '_cached_children'):
            qs = self._tree_manager.filter(pk__in=[n.pk for n in self._cached_children])
            qs._result_cache = self._cached_children
            return qs

Ошибка: TypeError: 'NoneType' object is not iterable

Полный Traceback:

Traceback (most recent call last):
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/core/handlers/exception.py", line 41, in inner
    response = get_response(request)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/core/handlers/base.py", line 217, in _get_response
    response = self.process_exception_by_middleware(e, request)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/core/handlers/base.py", line 215, in _get_response
    response = response.render()
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/response.py", line 107, in render
    self.content = self.rendered_content
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/response.py", line 84, in rendered_content
    content = template.render(context, self._request)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/backends/django.py", line 66, in render
    return self.template.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 207, in render
    return self._render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 199, in _render
    return self.nodelist.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/loader_tags.py", line 177, in render
    return compiled_parent._render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 199, in _render
    return self.nodelist.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/loader_tags.py", line 177, in render
    return compiled_parent._render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 199, in _render
    return self.nodelist.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/loader_tags.py", line 72, in render
    result = block.nodelist.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/loader_tags.py", line 72, in render
    result = block.nodelist.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/loader_tags.py", line 216, in render
    return template.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 209, in render
    return self._render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 199, in _render
    return self.nodelist.render(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 990, in render
    bit = node.render_annotated(context)
  File "/Users/nurzhan_nogerbek/Virtualenvs/py2714/lib/python2.7/site-packages/django/template/base.py", line 957, in render_annotated
    return self.render(context)
  File "/Applications/Projects/web/dashboard.kase.kz/documents/templatetags/documents_tags.py", line 40, in render
    bits = [self._render_node(context, node) for node in roots]
  File "/Applications/Projects/web/dashboard.kase.kz/documents/templatetags/documents_tags.py", line 29, in _render_node
    for child in node.get_children():
TypeError: 'NoneType' object is not iterable

[Артем Советников]

У вас вообще _tree_manager никакого нет.
_cached_children это как раз кеш дочерних элементов.
Уж как получить дочерние документы сами разберитесь, модель данных вы сами однако придумали.
А ваша ошибка сообщает о том, что в "for child in node.get_children():" node.get_children() возвращает None.
Подебужьте пожалуйста сами.

[nurzhannogerbek]

Артем Советников, ok. Удачного вам дня, Артем. Пошел дальше страдать c get_children() :D