Allow Column.sortable=True override. This allows you to turn on sorting for annotated columns. (iommirocks#702)

Author: boxed

iommi/table.py

@@ -324,6 +324,10 @@ def default_cell__value(column, row, **kwargs):
             return None
 
 
+def default_sortable(column, **_):
+    return column.attr is not None
+
+
 class DataRetrievalMethods(Enum):
     attribute_access = auto()
     prefetch = auto()
@@ -405,7 +409,7 @@ class Meta:
     @with_defaults(
         attr=MISSING,
         sort_default_desc=False,
-        sortable=lambda column, **_: column.attr is not None,
+        sortable=default_sortable,
         auto_rowspan=False,
         bulk__include=False,
         data_retrieval_method=DataRetrievalMethods.attribute_access,
@@ -510,7 +514,7 @@ def on_bind(self) -> None:
         # Not strict evaluate on purpose
         self.model = evaluate(self.model, **self.iommi_evaluate_parameters())
 
-        if self.table.model and self.attr is not None and self.sortable:
+        if self.table.model and self.attr is not None and (self.iommi_namespace['sortable'] is MISSING or self.iommi_namespace['sortable'] is default_sortable):
             if '__' not in self.attr:
                 # Only validate one level of the path for now
                 try:

iommi/table__tests.py

@@ -12,6 +12,7 @@
 from django.db.models import (
     F,
     QuerySet,
+    Sum,
 )
 from django.http import HttpResponse
 from django.test import override_settings
@@ -4736,6 +4737,23 @@ def preprocess_rows(rows, **_):
     assert not t.columns.synthetic.sortable
 
 
+@pytest.mark.django_db
+def test_allow_sorting_on_annotated_column():
+    T1.objects.create(pk=1, foo='a', bar='b')
+
+    t = Table(
+        auto__rows=T1.objects.all().annotate(annotated=Sum('pk')),
+        columns__annotated=Column(
+            sortable=True,
+        ),
+    )
+
+    # This should not crash
+    t = t.bind(request=req('get', **{'order': 'annotated'}))
+
+    assert t.columns.annotated.sortable
+
+
 @pytest.mark.skip('Validation is only done on the first level, not on nested levels for now')
 @pytest.mark.django_db
 def test_disallow_sorting_on_non_sortable_columns_that_have_valid_attr__nested():