Add sort field names to various models to expand the ability to sort in list views

Author: michel4j

apps/notifier/models.py

@@ -115,6 +115,9 @@ def __str__(self):
         subject = note_type.description
         return "{}: {}".format(subject, self.user if self.user else "; ".join(self.emails))
 
+    note_type.sort_field = 'kind'
+    to.sort_field = 'user__first_name'
+
 
 class MessageTemplateQueryset(models.QuerySet):
     def active(self):

apps/proposals/models.py

@@ -195,7 +195,7 @@ class TYPES(models.TextChoices):
     comments = models.TextField(blank=True)
     objects = SubmissionManager()
 
-    @property
+    #@property
     def code(self):
         return f'{self.track.acronym}{self.proposal.pk:0>6}'
 
@@ -206,21 +206,27 @@ def reviewer(self):
 
     def __str__(self):
         return '{}~{}'.format(
-            self.code, self.proposal.spokesperson.last_name, )
+            self.code(), self.proposal.spokesperson.last_name, )
 
     def get_absolute_url(self):
         return reverse('submission-detail', kwargs={'pk': self.pk})
 
     def title(self):
         return self.proposal.title
 
+    def spokesperson(self):
+        return self.proposal.spokesperson
+
     def siblings(self):
         return self.proposal.submissions.exclude(pk=self.pk)
 
     def facilities(self):
         return Facility.objects.filter(pk__in=self.techniques.values_list('config__facility', flat=True)).distinct()
 
+    code.sort_field = 'id'
+    title.sort_field = 'proposal__title'
     facilities.sort_field = 'techniques__config__facility__acronym'
+    spokesperson.sort_field = 'proposal__spokesperson__first_name'
 
     def close(self):
         comments = ""

apps/proposals/utils.py

@@ -549,3 +549,8 @@ def get_techniques_matrix(cycle=None, sel_techs=(), sel_fac=None):
         ]
     }
     return matrix
+
+
+def user_format(value, obj):
+    return str(obj.proposal.spokesperson)
+

apps/proposals/views.py

@@ -1071,7 +1071,7 @@ def form_valid(self, form):
 class SubmissionList(RolePermsViewMixin, ItemListView):
     model = models.Submission
     template_name = "item-list.html"
-    list_columns = ['title', 'code', 'proposal__spokesperson__last_name', 'cycle', 'kind', 'facilities', 'state']
+    list_columns = ['title', 'code', 'spokesperson', 'cycle', 'kind', 'facilities', 'state']
     list_filters = ['created', 'state', 'track', 'kind', 'cycle']
     list_search = ['proposal__title', 'proposal__id', 'proposal__spokesperson__last_name', 'proposal__keywords']
     link_url = "submission-detail"
@@ -1092,13 +1092,19 @@ def get_queryset(self, *args, **kwargs):
 class BeamlineSubmissionList(RolePermsViewMixin, ItemListView):
     model = models.Submission
     template_name = "item-list.html"
-    list_columns = ['code', 'title', 'proposal__spokesperson__last_name', 'cycle', 'kind', 'facilities', 'state']
+    list_columns = ['code', 'title', 'spokesperson', 'cycle', 'kind', 'facilities', 'state']
     list_filters = ['created', 'state', 'track', 'kind', 'cycle']
     list_search = ['proposal__title', 'proposal__id', 'proposal__spokesperson__last_name', 'proposal__keywords']
     link_url = "submission-detail"
     order_by = ['-cycle_id']
     list_title = 'Proposal Submissions'
-    list_transforms = {'facilities': _fmt_beamlines, 'title': utils.truncated_title}
+    list_transforms = {
+        'facilities': _fmt_beamlines,
+        'title': utils.truncated_title,
+        'proposal__spokesperson': utils.user_format
+
+    }
+
     list_styles = {'title': 'col-xs-2'}
     admin_roles = USO_ADMIN_ROLES
     allowed_roles = USO_ADMIN_ROLES
@@ -1113,7 +1119,9 @@ def check_allowed(self):
         return allowed
 
     def get_queryset(self, *args, **kwargs):
-        self.queryset = models.Submission.objects.filter(techniques__config__facility=self.kwargs['pk'])
+        self.queryset = models.Submission.objects.filter(
+            techniques__config__facility=self.kwargs['pk']
+        ).order_by().distinct()
         return super().get_queryset(*args, **kwargs)
 
 

apps/users/models.py

@@ -9,7 +9,7 @@
 from django.conf import settings
 from django.contrib.auth.models import AbstractBaseUser, BaseUserManager
 from django.db import models
-from django.db.models import Q
+from django.db.models import Q, Count
 from django.dispatch.dispatcher import receiver
 from django.utils import timezone
 from django.utils.translation import gettext as _
@@ -221,7 +221,6 @@ def get_full_name(self):
         last = '' if not self.last_name else f'{self.last_name}'
         first = '' if not first_name else f'{first_name} '
         return f'{first} {last}'
-    get_full_name.short_description = "Full Name"
 
     def get_name_variants(self):
         first_initials = name_initials(self.first_name)
@@ -248,6 +247,9 @@ def get_all_permissions(self):
     def get_all_roles(self):
         return set(self.roles)
 
+    get_full_name.short_description = "Full Name"
+    get_full_name.sort_field = 'first_name'
+
 
 class Institution(DateSpanMixin, TimeStampedModel):
     SECTORS = Choices(
@@ -282,6 +284,7 @@ def num_users(self):
         return self.users.count()
 
     num_users.short_description = 'Users'
+    num_users.sort_field = 'users__id'
 
     def email_users(self):
         if self.domains: