add support for related_query_name (#610)

Author: berycz

iommi/from_model.py

@@ -169,10 +169,12 @@ def get_field_name(field: DjangoField) -> str:
     if isinstance(field, ManyToManyRel):
         return field.related_name
     elif isinstance(field, ManyToOneRel):
-        if field.related_name:
-            return field.related_name
-        elif field.related_name == '+':
+        if field.related_name == '+':
             return None
+        elif field.related_query_name:
+            return field.related_query_name
+        elif field.related_name:
+            return field.related_name
         elif isinstance(field, OneToOneRel):
             return field.name
         else:

iommi/query__tests.py

@@ -699,6 +699,7 @@ def test_from_model_with_model_class():
         'id',
         'foo',
         'bars',
+        'qux',
         'fieldfrommodelforeignkeytest_set',
         'fieldfrommodelonetoonetest',
         'createoreditobjecttest_set',
@@ -713,6 +714,7 @@ def test_from_model_with_queryset():
         'id',
         'foo',
         'bars',
+        'qux',
         'fieldfrommodelforeignkeytest_set',
         'fieldfrommodelonetoonetest',
         'createoreditobjecttest_set',

iommi/table__tests.py

@@ -94,6 +94,7 @@
     DefaultsInForms,
     FieldFromModelOneToOneTest,
     Foo,
+    Qux,
     FromModelWithInheritanceTest,
     QueryFromIndexesTestModel,
     SortKeyOnForeignKeyB,
@@ -3708,6 +3709,35 @@ def test_auto_model_dunder_path_1to1_reverse():
     assert "fieldfrommodelonetoonetest_f_char" in keys(table.columns)
 
 
+@pytest.mark.django_db
+def test_custom_related_query_name():
+    foo = Foo.objects.create(foo=1)
+    Qux.objects.create(foo=foo, lang='en', name='first english item')
+    Qux.objects.create(foo=foo, lang='cs', name='první česká položka')
+    foo2 = Foo.objects.create(foo=1)
+    Qux.objects.create(foo=foo2, lang='en', name='second english item')
+    Qux.objects.create(foo=foo2, lang='cs', name='druhá česká položka')
+
+    table = Table(
+        auto__model=Foo,
+        auto__include=['qux__name'],
+        rows=Foo.objects.prefetch_related('quxes').filter(qux__lang='en'),
+        columns__qux_name__filter__include=True,
+        columns__qux_name__filter__freetext=True,
+    )
+
+    bound_table1 = table.bind(request=req('get', freetext_search='first'))
+    assert 'qux_name' in keys(bound_table1.columns)
+    assert len(bound_table1.get_visible_rows()) == 1
+    bound_table1.__html__()
+
+    bound_table2 = table.bind(request=req('get', order='-qux_name'))
+    assert 'qux_name' in keys(bound_table2.columns)
+    assert len(bound_table2.get_visible_rows()) == 2
+    assert bound_table2.get_visible_rows().first().qux.name == 'second english item'
+    bound_table2.__html__()
+
+
 @pytest.mark.django_db
 def test_invalid_form_message():
     invalid_form_message = 'Seventh Star'

tests/models.py

@@ -32,6 +32,10 @@ class Foo(Model):
     def __repr__(self):
         return f'Foo pk: {self.pk}'  # pragma: no cover
 
+    @property
+    def qux(self):
+        return self.quxes.first()
+
 
 class Bar(Model):
     foo = ForeignKey(Foo, related_name='bars', on_delete=CASCADE, help_text='bar_help_text')
@@ -41,6 +45,12 @@ class FieldFromModelForeignKeyTest(Model):
     foo_fk = ForeignKey(Foo, on_delete=CASCADE)
 
 
+class Qux(Model):
+    foo = ForeignKey(Foo, related_name='quxes', related_query_name='qux', on_delete=CASCADE)
+    lang = models.CharField(max_length=7)
+    name = CharField(max_length=255, blank=True)
+
+
 class FieldFromModelOneToOneTest(Model):
     foo_one_to_one = OneToOneField(Foo, on_delete=CASCADE)
     f_char = CharField(max_length=255, blank=True)