Removed display fallback to str method due to recursion error.

Author: fabiocaccamo

tests/models.py

@@ -21,7 +21,7 @@ class Meta(TreeNodeModel.Meta):
         verbose_name_plural = 'Categories'
 
 
-class CategoryUUID(TreeNodeModel):
+class CategoryWithUUIDPk(TreeNodeModel):
 
     treenode_display_field = 'name'
 
@@ -34,7 +34,7 @@ class Meta(TreeNodeModel.Meta):
         verbose_name_plural = 'Categories'
 
 
-class CategoryStr(TreeNodeModel):
+class CategoryWithoutDisplayField(TreeNodeModel):
 
     name = models.CharField(max_length=50, unique=True)
 
@@ -43,28 +43,3 @@ class Meta(TreeNodeModel.Meta):
         verbose_name = 'Category'
         verbose_name_plural = 'Categories'
 
-    def __str__(self):
-        return self.name
-
-
-class CategoryUUIDStr(TreeNodeModel):
-
-    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
-    name = models.CharField(max_length=50, unique=True)
-
-    class Meta(TreeNodeModel.Meta):
-        app_label = 'tests'
-        verbose_name = 'Category'
-        verbose_name_plural = 'Categories'
-
-    def __str__(self):
-        return f'{self.name}'
-
-class CategoryPk(TreeNodeModel):
-
-    name = models.CharField(max_length=50, unique=True)
-
-    class Meta(TreeNodeModel.Meta):
-        app_label = 'tests'
-        verbose_name = 'Category'
-        verbose_name_plural = 'Categories'

tests/test_models.py

@@ -3,15 +3,19 @@
 from django.conf import settings
 from django.test import TransactionTestCase
 from django.utils.encoding import force_text
+
 from treenode.cache import clear_cache
 from treenode.utils import join_pks
 
-from .models import (Category, CategoryPk, CategoryStr, CategoryUUID,
-                     CategoryUUIDStr)
+from .models import (
+    Category,
+    CategoryWithUUIDPk,
+    CategoryWithoutDisplayField,
+)
 
 
-class TreeNodeModelsTestCaseBase:
-    _category_model: object = None
+class TreeNodeModelTestCaseBase:
+    _category_model = None
 
     def setUp(self):
         pass
@@ -1218,53 +1222,14 @@ def test_deep_cat_tree_ordering(self):
         self.assertEqual(len(cat_level_1_descendants), len(cat_level_1_expected_descendants))
         self.assertEqual(cat_level_1_descendants, cat_level_1_expected_descendants)
 
-class TreeNodeModelsTestCasePk(TreeNodeModelsTestCaseBase):
-    def __create_cat(cls, name, parent=None, priority=0):
-        return cls._category_model.objects.create(
-            name=name,
-            tn_parent=parent,
-            tn_priority=priority)
 
-    def test_get_display(self):
-        a = self.__create_cat(name='à')
-        c = self.__create_cat(name='ç', parent=a)
-        e = self.__create_cat(name='è', parent=c)
-        i = self.__create_cat(name='ì', parent=e)
-        o = self.__create_cat(name='ò', parent=i)
-        u = self.__create_cat(name='ù', parent=o)
-        opts = {'indent': False, 'mark': '- '}
-        self.assertEqual(a.get_display(**opts), force_text(f'{a.pk}'))
-        self.assertEqual(c.get_display(**opts), force_text(f'{c.pk}'))
-        self.assertEqual(e.get_display(**opts), force_text(f'{e.pk}'))
-        self.assertEqual(i.get_display(**opts), force_text(f'{i.pk}'))
-        self.assertEqual(o.get_display(**opts), force_text(f'{o.pk}'))
-        self.assertEqual(u.get_display(**opts), force_text(f'{u.pk}'))
-        opts = {'indent': True, 'mark': '- '}
-        self.assertEqual(a.get_display(**opts), force_text(f'{a.pk}'))
-        self.assertEqual(c.get_display(**opts), force_text(f'- {c.pk}'))
-        self.assertEqual(e.get_display(**opts), force_text(f'- - {e.pk}'))
-        self.assertEqual(i.get_display(**opts), force_text(f'- - - {i.pk}'))
-        self.assertEqual(o.get_display(**opts), force_text(f'- - - - {o.pk}'))
-        self.assertEqual(u.get_display(**opts), force_text(f'- - - - - {u.pk}'))
-
-
-
-
-class TreeNodeModelsIdTestCase(TreeNodeModelsTestCaseBase, TransactionTestCase):
+class ModelTestCase(TreeNodeModelTestCaseBase, TransactionTestCase):
     _category_model = Category
 
 
-class TreeNodeModelsUUIDTestCase(TreeNodeModelsTestCaseBase, TransactionTestCase):
-    _category_model = CategoryUUID
-
-
-class TreeNodeModelsIdStrTestCase(TreeNodeModelsTestCaseBase, TransactionTestCase):
-    _category_model = CategoryStr
-
-
-class TreeNodeModelsUUIDStrTestCase(TreeNodeModelsTestCaseBase, TransactionTestCase):
-    _category_model = CategoryUUIDStr
+class ModelWithUUIDPkTestCase(TreeNodeModelTestCaseBase):
+    _category_model = CategoryWithUUIDPk
 
 
-class TreeNodeModelsPkTestCase(TreeNodeModelsTestCasePk, TransactionTestCase):
-    _category_model = CategoryPk
+class ModelWithoutDisplayFieldTestCase(TreeNodeModelTestCaseBase):
+    _category_model = CategoryWithoutDisplayField

treenode/models.py

@@ -2,13 +2,12 @@
 
 from __future__ import unicode_literals
 
-import uuid
-
 from django.core.validators import MaxValueValidator, MinValueValidator
 from django.db import models, transaction
 from django.utils.encoding import force_text
 from django.utils.text import slugify
 from django.utils.translation import gettext_lazy as _
+
 from six import python_2_unicode_compatible
 
 from . import classproperty
@@ -18,6 +17,8 @@
 from .signals import connect_signals, no_signals
 from .utils import join_pks, split_pks
 
+import uuid
+
 
 @python_2_unicode_compatible
 class TreeNodeModel(models.Model):
@@ -199,24 +200,23 @@ def get_display(self, indent=True, mark='— '):
         indentation = (mark * self.tn_ancestors_count) if indent else ''
         indentation = force_text(indentation)
         text = self.get_display_text()
+        text = force_text(text)
         return indentation + text
 
     def get_display_text(self):
         """
         Gets the text that will be indented in `get_display` method.
         Returns the `treenode_display_field` value if specified,
-        otherwise falls back on the model's __str__().
+        otherwise falls back on the model's pk.
         Override this method to return another field or a computed value. #27
         """
+        text = ''
         if hasattr(self, 'treenode_display_field') and self.treenode_display_field is not None:
             field_name = getattr(self, 'treenode_display_field')
-            text = getattr(self, field_name)
-        elif type(self).__str__  not in [object.__str__, TreeNodeModel.__str__]:
-            text = f'{self}'
-        else:
+            text = getattr(self, field_name, '')
+        if not text and self.pk:
             text = self.pk
-        text = force_text(text)
-        return text
+        return force_text(text)
 
     def get_first_child(self, cache=True):
         return self.get_children(cache=cache)[0] \
@@ -625,7 +625,7 @@ def __get_node_tree(obj):
 
         return objs_tree
 
-    #  Public properties
+    # Public properties
     # All properties map a get_{{property}}() method.
 
     @property