django-fast-treenode 1.1.0__tar.gz → 1.1.2__tar.gz

{django-fast-treenode-1.1.0/django_fast_treenode.egg-info → django-fast-treenode-1.1.2}/PKG-INFO

@@ -1,12 +1,11 @@
 Metadata-Version: 2.1
 Name: django-fast-treenode
-Version: 1.1.0
+Version: 1.1.2
 Summary: Application for supporting tree (hierarchical) data structure in Django projects
 Home-page: https://github.com/TimurKady/fast-treenode
 Author: Timur Kady
 Author-email: timurkady@yandex.com
 License: MIT
-Platform: UNKNOWN
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 3.0
@@ -21,13 +20,15 @@ Classifier: Programming Language :: Python :: 3.9
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: Django>=3.0
 
 # Django-fast-treenode 
 __Combination of Adjacency List and Closure Table__
 
 ## Functions
 Application for supporting tree (hierarchical) data structure in Django projects
-* Faster: resource-intensive operations are cached; bulk operations are used for inserts and changes,
+* fast: the fastest of the two methods is used to process requests, combining the advantages of an **Adjacency Table** and a **Closure Table**,
+* even faster: the main resource-intensive operations are **cached**; **bulk operations** are used for inserts and changes,
 * synchronized: model instances in memory are automatically updated,
 * compatibility: you can easily add a tree node to existing projects using TreeNode without changing the code,
 * no dependencies,
@@ -572,9 +573,9 @@ cls.update_tree()
 Released under [MIT License](https://github.com/TimurKady/django-fast-treenode/blob/main/LICENSE).
 
 ## Cautions
-The code provided is intended for testing by developers and is not recommended for use in production projects. Only general tests were carried out. The risk of using the code lies entirely with you.
+The provided code is already being used in production projects, even though I have only done general testing. That is why the risk of using the code lies entirely with you.
 
-Don't access treenode fields directly! Most of them have been removed as unnecessary. Use functions documented in the [source application](https://github.com/fabiocaccamo/django-treenode).
+**Warning**: don't access the tree node fields directly! Most of them have been removed as unnecessary. In the future, only `tn_parent` and `tn_priority` will be kept. Use the functions described in the documentation above or the documentation for the [original application](https://github.com/fabiocaccamo/django-treenode). 
 
 ## Credits
 This software contains, uses, including in a modified form:
@@ -591,5 +592,3 @@ Future plans:
 
 
 Your wishes, objections, comments are welcome.
-
-

{django-fast-treenode-1.1.0 → django-fast-treenode-1.1.2}/README.md

@@ -3,7 +3,8 @@ __Combination of Adjacency List and Closure Table__
 
 ## Functions
 Application for supporting tree (hierarchical) data structure in Django projects
-* Faster: resource-intensive operations are cached; bulk operations are used for inserts and changes,
+* fast: the fastest of the two methods is used to process requests, combining the advantages of an **Adjacency Table** and a **Closure Table**,
+* even faster: the main resource-intensive operations are **cached**; **bulk operations** are used for inserts and changes,
 * synchronized: model instances in memory are automatically updated,
 * compatibility: you can easily add a tree node to existing projects using TreeNode without changing the code,
 * no dependencies,
@@ -548,9 +549,9 @@ cls.update_tree()
 Released under [MIT License](https://github.com/TimurKady/django-fast-treenode/blob/main/LICENSE).
 
 ## Cautions
-The code provided is intended for testing by developers and is not recommended for use in production projects. Only general tests were carried out. The risk of using the code lies entirely with you.
+The provided code is already being used in production projects, even though I have only done general testing. That is why the risk of using the code lies entirely with you.
 
-Don't access treenode fields directly! Most of them have been removed as unnecessary. Use functions documented in the [source application](https://github.com/fabiocaccamo/django-treenode).
+**Warning**: don't access the tree node fields directly! Most of them have been removed as unnecessary. In the future, only `tn_parent` and `tn_priority` will be kept. Use the functions described in the documentation above or the documentation for the [original application](https://github.com/fabiocaccamo/django-treenode). 
 
 ## Credits
 This software contains, uses, including in a modified form:

{django-fast-treenode-1.1.0 → django-fast-treenode-1.1.2/django_fast_treenode.egg-info}/PKG-INFO

@@ -1,12 +1,11 @@
 Metadata-Version: 2.1
 Name: django-fast-treenode
-Version: 1.1.0
+Version: 1.1.2
 Summary: Application for supporting tree (hierarchical) data structure in Django projects
 Home-page: https://github.com/TimurKady/fast-treenode
 Author: Timur Kady
 Author-email: timurkady@yandex.com
 License: MIT
-Platform: UNKNOWN
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 3.0
@@ -21,13 +20,15 @@ Classifier: Programming Language :: Python :: 3.9
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: Django>=3.0
 
 # Django-fast-treenode 
 __Combination of Adjacency List and Closure Table__
 
 ## Functions
 Application for supporting tree (hierarchical) data structure in Django projects
-* Faster: resource-intensive operations are cached; bulk operations are used for inserts and changes,
+* fast: the fastest of the two methods is used to process requests, combining the advantages of an **Adjacency Table** and a **Closure Table**,
+* even faster: the main resource-intensive operations are **cached**; **bulk operations** are used for inserts and changes,
 * synchronized: model instances in memory are automatically updated,
 * compatibility: you can easily add a tree node to existing projects using TreeNode without changing the code,
 * no dependencies,
@@ -572,9 +573,9 @@ cls.update_tree()
 Released under [MIT License](https://github.com/TimurKady/django-fast-treenode/blob/main/LICENSE).
 
 ## Cautions
-The code provided is intended for testing by developers and is not recommended for use in production projects. Only general tests were carried out. The risk of using the code lies entirely with you.
+The provided code is already being used in production projects, even though I have only done general testing. That is why the risk of using the code lies entirely with you.
 
-Don't access treenode fields directly! Most of them have been removed as unnecessary. Use functions documented in the [source application](https://github.com/fabiocaccamo/django-treenode).
+**Warning**: don't access the tree node fields directly! Most of them have been removed as unnecessary. In the future, only `tn_parent` and `tn_priority` will be kept. Use the functions described in the documentation above or the documentation for the [original application](https://github.com/fabiocaccamo/django-treenode). 
 
 ## Credits
 This software contains, uses, including in a modified form:
@@ -591,5 +592,3 @@ Future plans:
 
 
 Your wishes, objections, comments are welcome.
-
-

{django-fast-treenode-1.1.0 → django-fast-treenode-1.1.2}/setup.cfg

@@ -4,7 +4,7 @@ tag_date = 0
 
 [metadata]
 name = django-fast-treenode
-version = 1.1.0
+version = 1.1.2
 description = Application for supporting tree (hierarchical) data structure in Django projects
 long_description_content_type = text/markdown
 long_description = file: README.md

{django-fast-treenode-1.1.0 → django-fast-treenode-1.1.2}/treenode/admin.py

@@ -1,136 +1,136 @@
-# -*- coding: utf-8 -*-
-"""
-TreeNode Admin Module
-
-"""
-
-from django.contrib import admin
-from django.utils.safestring import mark_safe
-from django.contrib.admin.views.main import ChangeList
-from .forms import TreeNodeForm
-
-
-class NoPkDescOrderedChangeList(ChangeList):
-    def get_ordering(self, request, queryset):
-        rv = super().get_ordering(request, queryset)
-        rv = list(rv)
-        rv.remove('-pk') if '-pk' in rv else None
-        return tuple()
-
-    def get_queryset(self, request):
-        qs = self.model.objects.all()
-        return qs.select_related('tn_parent')
-
-
-class TreeNodeModelAdmin(admin.ModelAdmin):
-
-    TREENODE_DISPLAY_MODE_ACCORDION = 'accordion'
-    TREENODE_DISPLAY_MODE_BREADCRUMBS = 'breadcrumbs'
-    TREENODE_DISPLAY_MODE_INDENTATION = 'indentation'
-
-    treenode_display_mode = TREENODE_DISPLAY_MODE_INDENTATION
-
-    form = TreeNodeForm
-    list_per_page = 1000
-
-    def get_list_display(self, request):
-        base_list_display = super(
-            TreeNodeModelAdmin, self).get_list_display(request)
-        base_list_display = list(base_list_display)
-
-        def treenode_field_display(obj):
-            return self._get_treenode_field_display(request, obj)
-
-        treenode_field_display.short_description = self.model._meta.verbose_name
-        treenode_field_display.allow_tags = True
-
-        if len(base_list_display) == 1 and base_list_display[0] == '__str__':
-            return (treenode_field_display, )
-        else:
-            treenode_display_field = getattr(
-                self.model, 'treenode_display_field')
-            if len(base_list_display) >= 1 and base_list_display[0] == treenode_display_field:
-                base_list_display.pop(0)
-            return (treenode_field_display, ) + tuple(base_list_display)
-
-        return base_list_display
-
-    def get_changelist(self, request):
-        return NoPkDescOrderedChangeList
-
-    def get_ordering(self, request):
-        return None
-
-    def list_to_queryset(self, model, data):
-        from django.db.models.base import ModelBase
-
-        if not isinstance(model, ModelBase):
-            raise ValueError(
-                "%s must be Model" % model
-            )
-        if not isinstance(data, list):
-            raise ValueError(
-                "%s must be List Object" % data
-            )
-
-        pk_list = [obj.pk for obj in data]
-        return model.objects.filter(pk__in=pk_list)
-
-    def _use_treenode_display_mode(self, request, obj):
-        querystring = (request.GET.urlencode() or '')
-        return len(querystring) <= 2
-
-    def _get_treenode_display_mode(self, request, obj):
-        return self.treenode_display_mode
-
-    def _get_treenode_field_default_display(self, obj):
-        return self._get_treenode_field_display_with_breadcrumbs(obj)
-
-    def _get_treenode_field_display(self, request, obj):
-        if not self._use_treenode_display_mode(request, obj):
-            return self._get_treenode_field_default_display(obj)
-        display_mode = self._get_treenode_display_mode(request, obj)
-        if display_mode == TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_ACCORDION:
-            return self._get_treenode_field_display_with_accordion(obj)
-        elif display_mode == TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_BREADCRUMBS:
-            return self._get_treenode_field_display_with_breadcrumbs(obj)
-        elif display_mode == TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_INDENTATION:
-            return self._get_treenode_field_display_with_indentation(obj)
-        else:
-            return self._get_treenode_field_default_display(obj)
-
-    def _get_treenode_field_display_with_accordion(self, obj):
-        tn_namespace = '%s.%s' % (obj.__module__, obj.__class__.__name__, )
-        tn_namespace_key = tn_namespace.lower().replace('.', '_')
-        return mark_safe(''
-                         '<span class="treenode"'
-                         ' data-treenode-type="%s"'
-                         ' data-treenode-pk="%s"'
-                         ' data-treenode-accordion="1"'
-                         ' data-treenode-depth="%s"'
-                         ' data-treenode-level="%s"'
-                         ' data-treenode-parent="%s">%s</span>' % (
-                             tn_namespace_key,
-                             str(obj.pk),
-                             str(obj.depth),
-                             str(obj.level),
-                             str(obj.tn_parent_id or ''),
-                             obj.get_display(indent=False), ))
-
-    def _get_treenode_field_display_with_breadcrumbs(self, obj):
-        obj_display = ''
-        for obj_ancestor in obj.get_ancestors():
-            obj_ancestor_display = obj_ancestor.get_display(indent=False)
-            obj_display += '<span class="treenode-breadcrumbs">%s</span>' % (
-                obj_ancestor_display, )
-        obj_display += obj.get_display(indent=False)
-        return mark_safe('<span class="treenode">%s</span>' % (obj_display, ))
-
-    def _get_treenode_field_display_with_indentation(self, obj):
-        obj_display = '<span class="treenode-indentation">&mdash;</span>' * obj.ancestors_count
-        obj_display += obj.get_display(indent=False)
-        return mark_safe('<span class="treenode">%s</span>' % (obj_display, ))
-
-    class Media:
-        css = {'all': ('treenode/css/treenode.css',)}
-        js = ['treenode/js/treenode.js']
+# -*- coding: utf-8 -*-
+"""
+TreeNode Admin Module
+
+"""
+
+from django.contrib import admin
+from django.utils.safestring import mark_safe
+from django.contrib.admin.views.main import ChangeList
+from .forms import TreeNodeForm
+
+
+class NoPkDescOrderedChangeList(ChangeList):
+    def get_ordering(self, request, queryset):
+        rv = super().get_ordering(request, queryset)
+        rv = list(rv)
+        rv.remove('-pk') if '-pk' in rv else None
+        return tuple()
+
+    def get_queryset(self, request):
+        qs = self.model.objects.all()
+        return qs.select_related('tn_parent')
+
+
+class TreeNodeModelAdmin(admin.ModelAdmin):
+
+    TREENODE_DISPLAY_MODE_ACCORDION = 'accordion'
+    TREENODE_DISPLAY_MODE_BREADCRUMBS = 'breadcrumbs'
+    TREENODE_DISPLAY_MODE_INDENTATION = 'indentation'
+
+    treenode_display_mode = TREENODE_DISPLAY_MODE_INDENTATION
+
+    form = TreeNodeForm
+    list_per_page = 1000
+
+    def get_list_display(self, request):
+        base_list_display = super(
+            TreeNodeModelAdmin, self).get_list_display(request)
+        base_list_display = list(base_list_display)
+
+        def treenode_field_display(obj):
+            return self._get_treenode_field_display(request, obj)
+
+        treenode_field_display.short_description = self.model._meta.verbose_name
+        treenode_field_display.allow_tags = True
+
+        if len(base_list_display) == 1 and base_list_display[0] == '__str__':
+            return (treenode_field_display, )
+        else:
+            treenode_display_field = getattr(
+                self.model, 'treenode_display_field')
+            if len(base_list_display) >= 1 and base_list_display[0] == treenode_display_field:
+                base_list_display.pop(0)
+            return (treenode_field_display, ) + tuple(base_list_display)
+
+        return base_list_display
+
+    def get_changelist(self, request):
+        return NoPkDescOrderedChangeList
+
+    def get_ordering(self, request):
+        return None
+
+    def list_to_queryset(self, model, data):
+        from django.db.models.base import ModelBase
+
+        if not isinstance(model, ModelBase):
+            raise ValueError(
+                "%s must be Model" % model
+            )
+        if not isinstance(data, list):
+            raise ValueError(
+                "%s must be List Object" % data
+            )
+
+        pk_list = [obj.pk for obj in data]
+        return model.objects.filter(pk__in=pk_list)
+
+    def _use_treenode_display_mode(self, request, obj):
+        querystring = (request.GET.urlencode() or '')
+        return len(querystring) <= 2
+
+    def _get_treenode_display_mode(self, request, obj):
+        return self.treenode_display_mode
+
+    def _get_treenode_field_default_display(self, obj):
+        return self._get_treenode_field_display_with_breadcrumbs(obj)
+
+    def _get_treenode_field_display(self, request, obj):
+        if not self._use_treenode_display_mode(request, obj):
+            return self._get_treenode_field_default_display(obj)
+        display_mode = self._get_treenode_display_mode(request, obj)
+        if display_mode == TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_ACCORDION:
+            return self._get_treenode_field_display_with_accordion(obj)
+        elif display_mode == TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_BREADCRUMBS:
+            return self._get_treenode_field_display_with_breadcrumbs(obj)
+        elif display_mode == TreeNodeModelAdmin.TREENODE_DISPLAY_MODE_INDENTATION:
+            return self._get_treenode_field_display_with_indentation(obj)
+        else:
+            return self._get_treenode_field_default_display(obj)
+
+    def _get_treenode_field_display_with_accordion(self, obj):
+        tn_namespace = '%s.%s' % (obj.__module__, obj.__class__.__name__, )
+        tn_namespace_key = tn_namespace.lower().replace('.', '_')
+        return mark_safe(''
+                         '<span class="treenode"'
+                         ' data-treenode-type="%s"'
+                         ' data-treenode-pk="%s"'
+                         ' data-treenode-accordion="1"'
+                         ' data-treenode-depth="%s"'
+                         ' data-treenode-level="%s"'
+                         ' data-treenode-parent="%s">%s</span>' % (
+                             tn_namespace_key,
+                             str(obj.pk),
+                             str(obj.depth),
+                             str(obj.level),
+                             str(obj.tn_parent_id or ''),
+                             obj.get_display(indent=False), ))
+
+    def _get_treenode_field_display_with_breadcrumbs(self, obj):
+        obj_display = ''
+        for obj_ancestor in obj.get_ancestors():
+            obj_ancestor_display = obj_ancestor.get_display(indent=False)
+            obj_display += '<span class="treenode-breadcrumbs">%s</span>' % (
+                obj_ancestor_display, )
+        obj_display += obj.get_display(indent=False)
+        return mark_safe('<span class="treenode">%s</span>' % (obj_display, ))
+
+    def _get_treenode_field_display_with_indentation(self, obj):
+        obj_display = '<span class="treenode-indentation">&mdash;</span>' * obj.ancestors_count
+        obj_display += obj.get_display(indent=False)
+        return mark_safe('<span class="treenode">%s</span>' % (obj_display, ))
+
+    class Media:
+        css = {'all': ('treenode/css/treenode.css',)}
+        js = ['treenode/js/treenode.js']

{django-fast-treenode-1.1.0 → django-fast-treenode-1.1.2}/treenode/compat.py

@@ -1,8 +1,8 @@
-# -*- coding: utf-8 -*-
-
-import django
-
-if django.VERSION >= (3, 0):
-    from django.utils.encoding import force_str
-else:
-    from django.utils.encoding import force_text as force_str
+# -*- coding: utf-8 -*-
+
+import django
+
+if django.VERSION >= (3, 0):
+    from django.utils.encoding import force_str
+else:
+    from django.utils.encoding import force_text as force_str

{django-fast-treenode-1.1.0/treenode/static/treenode/css → django-fast-treenode-1.1.2/treenode/docs}/.gitkeep

@@ -1 +1 @@
-
+

{django-fast-treenode-1.1.0 → django-fast-treenode-1.1.2}/treenode/docs/Documentation

@@ -1,15 +1,15 @@
 # Django-fast-treenode 
 __Combination of Adjacency List and Closure Table__
 
-## Functions
+## Features
 Application for supporting tree (hierarchical) data structure in Django projects
-* Faster: resource-intensive operations are cached; bulk operations are used for inserts and changes,
-* synchronized: model instances in memory are automatically updated,
-* compatibility: you can easily add a tree node to existing projects using TreeNode without changing the code,
+* faster,
+* synced: in-memory model instances are automatically updated,
+* compatibility: you can easily add treenode to existing projects,
 * no dependencies,
-* easy setup: just extend the abstract model/model-admin,
-* admin integration: visualization options (accordion, breadcrumbs or padding),
-* widget: Built-in Select2-to-Tree extends Select2 to support arbitrary nesting levels.
+* easy configuration: just extend the abstract model / model-admin,
+* admin integration: visualization options (accordion, breadcrumbs or indentation),
+* widget: build-in Select2-to-Tree extends Select2 to support arbitrary level of nesting.
 
 ## Debut idea
 This is a modification of the reusable [django-treenode](https://github.com/fabiocaccamo/django-treenode) application developed by [Fabio Caccamo](https://github.com/fabiocaccamo).
@@ -44,7 +44,7 @@ You can easily find additional information on your own on the Internet.
 
 ## Quick start
 1. Run ```pip install django-fast-treenode```
-2. Add ```treenode``` to ```settings.INSTALLED_APPS```
+2. Add ```django-fast-treenode``` to ```settings.INSTALLED_APPS```
 3. Make your model inherit from ```treenode.models.TreeNodeModel``` (described below)
 4. Make your model-admin inherit from ```treenode.admin.TreeNodeModelAdmin``` (described below)
 5. Run python manage.py makemigrations and ```python manage.py migrate```
@@ -157,6 +157,7 @@ class YoursForm(TreeNodeForm):
 -   [`get_last_child`](#get_last_child)
 -   [`get_level`](#get_level)
 -   [`get_order`](#get_order)
+-   [`get_ordered_queryset`](#get_ordered_queryset)
 -   [`get_parent`](#get_parent)
 -   [`get_parent_pk`](#get_parent_pk)
 -   [`set_parent`](#set_parent)
@@ -360,6 +361,23 @@ obj.get_order()
 obj.order
 ```
 
+#### `get_ordered_queryset`
+Returns a queryset of nodes ordered by tn_priority each node. 
+```python
+cls.get_ordered_queryset()
+```
+For example:
+- A.1
+- A.1.1
+- A.1.1.1
+- A.1.1.2
+- A.2
+- A.2.1
+- ...
+
+This method uses a lot of memory, ```RawSQL()``` and ```.extra()``` QuerySet method. Use of this method is deprecated due to concerns that Django's ```.extra()``` method **will be deprecated in the future**. 
+Use it only if you cannot otherwise assemble an ordered tree from an Adjacency Table and a Closure Table. In most cases, the data in one Adjacency Table is sufficient for such an assembly. You can easily find the corresponding algorithms (two-pass and one-pass) on the Internet.
+
 #### `get_parent`
 Get the **parent node**:
 ```python
@@ -561,8 +579,9 @@ Special thanks to [Mathieu Leplatre](https://blog.mathieu-leplatre.info/pages/ab
 
 ## To do
 Future plans:
-* may be will add the ability to determine the priority of the parent by any field, for example, by creation date or alphabetical order;
 * drug-and-drop support;
+* may be will restore caching;
+* may be will add the ability to determine the priority of the parent by any field, for example, by creation date or alphabetical order;
 * to be happy, to don't worry, until die.
 
 

{django-fast-treenode-1.1.0 → django-fast-treenode-1.1.2}/treenode/forms.py

@@ -1,32 +1,32 @@
-# -*- coding: utf-8 -*-
-
-from django import forms
-from .widgets import TreeWidget
-
-
-class TreeNodeForm(forms.ModelForm):
-
-    def __init__(self, *args, **kwargs):
-
-        super(TreeNodeForm, self).__init__(*args, **kwargs)
-
-        if 'tn_parent' not in self.fields:
-            return
-        exclude_pks = []
-        obj = self.instance
-        if obj.pk:
-            exclude_pks += [obj.pk]
-            # tn_get_descendants_pks changed to get_descendants_pks()
-            # exclude_pks += split_pks(obj.get_descendants_pks())
-            exclude_pks += obj.get_descendants_pks()
-
-        # Cheaged to "legal" call
-        manager = obj._meta.model.objects
-
-        self.fields['tn_parent'].queryset = manager.prefetch_related(
-            'tn_children').exclude(pk__in=exclude_pks)
-
-    class Meta:
-        widgets = {
-            'tn_parent': TreeWidget(attrs={'style': 'min-width:400px'}),
-        }
+# -*- coding: utf-8 -*-
+
+from django import forms
+from .widgets import TreeWidget
+
+
+class TreeNodeForm(forms.ModelForm):
+
+    def __init__(self, *args, **kwargs):
+
+        super(TreeNodeForm, self).__init__(*args, **kwargs)
+
+        if 'tn_parent' not in self.fields:
+            return
+        exclude_pks = []
+        obj = self.instance
+        if obj.pk:
+            exclude_pks += [obj.pk]
+            # tn_get_descendants_pks changed to get_descendants_pks()
+            # exclude_pks += split_pks(obj.get_descendants_pks())
+            exclude_pks += obj.get_descendants_pks()
+
+        # Cheaged to "legal" call
+        manager = obj._meta.model.objects
+
+        self.fields['tn_parent'].queryset = manager.prefetch_related(
+            'tn_children').exclude(pk__in=exclude_pks)
+
+    class Meta:
+        widgets = {
+            'tn_parent': TreeWidget(attrs={'style': 'min-width:400px'}),
+        }