dump_bulk alternative for django-treenode

[baseplate-admin]

Hi,

Thanks for creating django-treenode. I was thinking if it was possible to have the dump_bulk api or something like that in django-treenode

So essentially i can convert this model ( image ) :

To

data = [
    {"data": {"desc": "1"}},
    {
        "data": {"desc": "2"},
        "children": [
            {"data": {"desc": "21"}},
            {"data": {"desc": "22"}},
            {
                "data": {"desc": "23"},
                "children": [
                    {"data": {"desc": "231"}},
                ],
            },
            {"data": {"desc": "24"}},
        ],
    },
    {"data": {"desc": "3"}},
    {
        "data": {"desc": "4"},
        "children": [
            {"data": {"desc": "41"}},
        ],
    },
]

[fabiocaccamo]

Hi @baseplate-admin
you can try to use the model class method to obtain a n-dimensional dict representing the model tree:

YourModelClass.get_tree()

Alternatively, if you need to have more control on the desired output, you could:

1. Use Django dumpdata command to output a flat json of all nodes
2. Use python-benedict for loading the .json and building the dict tree with two lines of code (using the nest method)

I hope to have been helpful.

[fabiocaccamo]

Let me know!

[baseplate-admin]

Use python-benedict for loading the .json and building the dict tree with two lines of code (using the nest method)

Would you mind adding this to the README.md ?

[fabiocaccamo]

Use python-benedict for loading the .json and building the dict tree with two lines of code (using the nest method)

Would you mind adding this to the README.md ?

That was your solution? Have you tried the get_tree static method?

[baseplate-admin]

That was your solution? Have you tried the get_tree static method?

get_descendants_tree did also work for me.. But i needed a custom data structure. Thats why i followed the custom approach documented below.

All in all thanks my man for helping me out here... You rock :D

[fabiocaccamo]

I added a link to this discussion in a new FAQ section of the README:
https://github.com/fabiocaccamo/django-treenode#custom-tree-serialization

[baseplate-admin]

Hi,

so i am making reddit style tree comment system for django-ninja.

The way i achieved this is with this code :

# models.py
from apps.user.models import CustomUser

from django.db import models

from treenode.models import TreeNodeModel

# Create your models here.


class EpisodeCommentModel(TreeNodeModel):
    user = models.ForeignKey(CustomUser, on_delete=models.CASCADE)
    text = models.TextField()

    comment_added = models.DateTimeField(auto_now=True)

    def __str__(self) -> str:
        return f"{self.user} | {self.text}"

    class Meta(TreeNodeModel.Meta):
        verbose_name = "Episode Comment"
        verbose_name_plural = "Episode Comments"

# views.py

@router.get(
    "/{int:anime_id}/episodes/{str:episode_number}/comments",
    response=list[EpisodeCommentTreeSchema],
)
def get_individual_anime_episode_comments(
    request: HttpRequest,
    anime_id: int,
    episode_number: str,
):
    query: list[EpisodeCommentModel] = get_list_or_404(
        get_object_or_404(
            AnimeModel,
            pk=anime_id,
        )
        .episodes.get(episode_number__in=[episode_number])
        .episode_comments.all()
    )

    return_list = []

    def get_nested_children(item: EpisodeCommentModel):
        __list__ = []
        __list__.append(
            {
                "user": str(item.user),
                "text": item.text,
                "comment_added": item.comment_added,
                "children": [get_nested_children(i)[0] for i in item.get_children()],
            }
        )
        return __list__

    for i in query:
        return_list.append(get_nested_children(i)[0])

    return return_list

# schema.py
class EpisodeCommentTreeSchema(Schema):
    user: str
    text: str
    comment_added: datetime.datetime
    children: list["EpisodeCommentTreeSchema"] = []

Which returns

[
  {
    "user": "baseplate-admin#0001",
    "text": "1",
    "comment_added": "2023-04-04T15:37:17.350Z",
    "children": [
      {
        "user": "baseplate-admin#0001",
        "text": "2",
        "comment_added": "2023-04-03T16:17:53.050Z",
        "children": [
          {
            "user": "baseplate-admin#0001",
            "text": "3",
            "comment_added": "2023-04-03T16:18:13.588Z",
            "children": []
          }
        ]
      },
      {
        "user": "baseplate-admin#0001",
        "text": "2",
        "comment_added": "2023-04-04T15:51:39.823Z",
        "children": []
      }
    ]
  },
  {
    "user": "baseplate-admin#0001",
    "text": "2",
    "comment_added": "2023-04-03T16:24:58.779Z",
    "children": []
  }
]

---

Source