From 108ef6dd18c32860b2bce4d8e559fa75ace35dd3 Mon Sep 17 00:00:00 2001 From: Tai Lee Date: Tue, 13 Mar 2018 23:05:35 +1100 Subject: [PATCH] Improve performance of sort view for moods and elements. * Use `{% include "..." with ... %}` instead of template tags that do nothing but pass through or rename context variables and render a template. This appears to yield a 2x increase in performance. As a side effect, this change also appears to fix some glitches with the rendering of `fa-sort`, `fa-sort-asc` and `fa-sort-desc` icons. * Move queryset filtering from `sort_view()` to new `get_sort_view_queryset()` method, so subclasses can override to apply different or additional filtering (based on `request` and `sortable_by_expression`) to reduce the number of objects being reordered. `django-admin-sortable` already provides a mechanism to reorder a subset of objects via `sorting_filters`, but this is restricted to a small number of hard coded filters, and we found it not very useful. We have tens of thousands of nested objects grouped under hundreds or thousands of parent objects, and we needed a way to reorder child objects just within their own group. We also needed a way to reorder a subset of flat (not grouped by parent) sortable objects with much more flexibility. Here's an example of additional filtering that allows us to reorder a contiguous sequence of objects (nested or flat) that bounded by the min and max (by ordering) selected objects: ```python class MyBaseSortableAdmin(SortableAdmin): def get_sort_view_queryset(self, request, sortable_by_expression): """ Filter the sort view queryset to include only a contiguous sequence of objects between the first and last of given parent objects, according to the current ordering. This should avoid inconsistent or ambiguous behaviour that might occur when re-ordering a non-contiguous sequence. """ sortable_by_expression = sortable_by_expression or 'pk' queryset = super(MyBaseSortableAdmin, self) \ .get_sort_view_queryset(request, sortable_by_expression) pks = [ int(pk) for pk in request.GET.get('pks', '').split(',') if pk ] if pks: queryset = queryset.filter(**{ '%s__in' % sortable_by_expression: pks, }) return queryset def reorder_children(self, qs, child): # Get the min and max order field value for the selected objects, then # get contiguous PKs for objects between the min and max and pass to # the sort view, to avoid inconsistent or ambiguous behaviour. field = self.opts.ordering[0].replace('-', '') qs = qs.model.objects.filter(**qs.aggregate(**{ '%s__gte' % field: Min(field), '%s__lte' % field: Max(field), })) ct = ContentType.objects.get_for_model(child) url = '%ssort/?pks=%s' % ( reverse('admin:%s_%s_changelist' % (ct.app_label, ct.model)), ','.join([str(pk) for pk in qs.values_list('pk', flat=True)]), ) return http.HttpResponseRedirect(url) class MyModelAdmin(MyBaseSortableAdmin): actions = ( "reorder_mymodel", "reorder_childmodel", ) def reorder_mymodel(self, request, qs): return self.reorder_children(qs, MyModel) reorder_chapters.short_description = 'Reorder selected MyModels' def reorder_childmodel(self, request, qs): return self.reorder_children(qs, ChildModel) reorder_elements.short_description = 'Reorder ChildModels for the selected MyModels' ``` This could be made generic enough for inclusion by default with a few tweaks, so that `Reorder selected {{ parent.verbose_name_plural }}` and `Reorder {{ child.verbose_name_plural }} for selected {{ parent.verbose_name_plural }}` admin actions could be included in sortable change lists. --- adminsortable/admin.py | 33 +++++++++++-------- .../templates/adminsortable/change_list.html | 6 ++-- .../adminsortable/shared/list_items.html | 3 +- .../adminsortable/shared/nested_objects.html | 6 ++-- .../adminsortable/shared/object_rep.html | 2 +- .../adminsortable/shared/objects.html | 4 +-- .../templatetags/adminsortable_tags.py | 32 ------------------ 7 files changed, 29 insertions(+), 57 deletions(-) delete mode 100644 adminsortable/templatetags/adminsortable_tags.py diff --git a/adminsortable/admin.py b/adminsortable/admin.py index 539d2b1..648c466 100644 --- a/adminsortable/admin.py +++ b/adminsortable/admin.py @@ -102,6 +102,24 @@ class SortableAdmin(SortableAdminBase, ModelAdmin): ] + urls return urls + def get_sort_view_queryset(self, request, sortable_by_expression): + """ + Return a queryset, optionally filtered based on request and + `sortable_by_expression` to be used in the sort view. + """ + # get sort group index from querystring if present + sort_filter_index = request.GET.get('sort_filter') + + filters = {} + if sort_filter_index: + try: + filters = self.model.sorting_filters[int(sort_filter_index)][1] + except (IndexError, ValueError): + pass + + # Apply any sort filters to create a subset of sortable objects + return self.get_queryset(request).filter(**filters) + def sort_view(self, request): """ Custom admin view that displays the objects as a list whose sort @@ -115,19 +133,6 @@ class SortableAdmin(SortableAdminBase, ModelAdmin): jquery_lib_path = 'admin/js/jquery.js' if VERSION < (1, 9) \ else 'admin/js/vendor/jquery/jquery.js' - # get sort group index from querystring if present - sort_filter_index = request.GET.get('sort_filter') - - filters = {} - if sort_filter_index: - try: - filters = self.model.sorting_filters[int(sort_filter_index)][1] - except (IndexError, ValueError): - pass - - # Apply any sort filters to create a subset of sortable objects - objects = self.get_queryset(request).filter(**filters) - # Determine if we need to regroup objects relative to a # foreign key specified on the model class that is extending Sortable. # Legacy support for 'sortable_by' defined as a model property @@ -175,6 +180,8 @@ class SortableAdmin(SortableAdminBase, ModelAdmin): sortable_by_class_display_name = \ sortable_by_class_is_sortable = None + objects = self.get_sort_view_queryset(request, sortable_by_expression) + if sortable_by_property or sortable_by_fk: # Order the objects by the property they are sortable by, # then by the order, otherwise the regroup diff --git a/adminsortable/templates/adminsortable/change_list.html b/adminsortable/templates/adminsortable/change_list.html index 749d830..0dcbbf2 100644 --- a/adminsortable/templates/adminsortable/change_list.html +++ b/adminsortable/templates/adminsortable/change_list.html @@ -1,5 +1,5 @@ {% extends "admin/base_site.html" %} -{% load i18n admin_urls static admin_list adminsortable_tags %} +{% load i18n admin_urls static admin_list %} {% block extrastyle %} {{ block.super }} @@ -86,9 +86,9 @@ {% if objects %}
{% if group_expression %} - {% render_nested_sortable_objects objects group_expression %} + {% include "adminsortable/shared/nested_objects.html" %} {% else %} - {% render_sortable_objects objects %} + {% include "adminsortable/shared/objects.html" %} {% endif %} {% csrf_token %}
diff --git a/adminsortable/templates/adminsortable/shared/list_items.html b/adminsortable/templates/adminsortable/shared/list_items.html index 29df030..21f9005 100644 --- a/adminsortable/templates/adminsortable/shared/list_items.html +++ b/adminsortable/templates/adminsortable/shared/list_items.html @@ -1,9 +1,8 @@ -{% load adminsortable_tags %} {% with list_objects_length=list_objects|length %} {% for object in list_objects %}
  • {% if list_objects_length > 1 %} - {% render_object_rep object forloop %} + {% include "adminsortable/shared/object_rep.html" %} {% else %} {{ object }} {% endif %} diff --git a/adminsortable/templates/adminsortable/shared/nested_objects.html b/adminsortable/templates/adminsortable/shared/nested_objects.html index 8ef74d9..cf0483b 100644 --- a/adminsortable/templates/adminsortable/shared/nested_objects.html +++ b/adminsortable/templates/adminsortable/shared/nested_objects.html @@ -1,4 +1,4 @@ -{% load django_template_additions adminsortable_tags %} +{% load django_template_additions %} {% dynamic_regroup objects by group_expression as regrouped_objects %} {% if regrouped_objects %}