Ticket #17252: r17104-admin-order-field.diff

django/contrib/admin/views/main.py

@@ -169 +169 @@
             ordering = self.lookup_opts.ordering
         return ordering
 
+    def _get_admin_order_field(self, field_name):
+        """
+        Get the name of the admin order field defined for the given
+        element of 'list_display'. The given object can either be the
+        name of a proper field, the name of a method (on the admin or
+        model) with the 'admin_order_field' attribute, or a callable
+        with that attribute. If no admin order is defined for the
+        given object, the method returns None.
+        """
+        try:
+            f = self.lookup_opts.get_field(field_name)
+        except models.FieldDoesNotExist:
+            # See whether field_name is a name of a non-field
+            # that allows sorting.
+            try:
+                if callable(field_name):
+                    attr = field_name
+                elif hasattr(self.model_admin, field_name):
+                    attr = getattr(self.model_admin, field_name)
+                else:
+                    attr = getattr(self.model, field_name)
+                return attr.admin_order_field
+            except AttributeError:
+                return None
+        else:
+            return f.name
+
     def get_ordering(self, request):
         params = self.params
         # For ordering, first check the if exists the "get_ordering" method
@@ -185 +212 @@
                 try:
                     none, pfx, idx = p.rpartition('-')
                     field_name = self.list_display[int(idx)]
-                    try:
-                        f = self.lookup_opts.get_field(field_name)
-                    except models.FieldDoesNotExist:
-                        # See whether field_name is a name of a non-field
-                        # that allows sorting.
-                        try:
-                            if callable(field_name):
-                                attr = field_name
-                            elif hasattr(self.model_admin, field_name):
-                                attr = getattr(self.model_admin, field_name)
-                            else:
-                                attr = getattr(self.model, field_name)
-                            field_name = attr.admin_order_field
-                        except AttributeError:
-                            continue # No 'admin_order_field', skip it
-                    else:
-                        field_name = f.name
+                    order_field = self._get_admin_order_field(field_name)
+                    if not order_field:
+                        continue # No 'admin_order_field', skip it
 
-                    ordering.append(pfx + field_name)
+                    ordering.append(pfx + order_field)
 
                 except (IndexError, ValueError):
                     continue # Invalid ordering specified, skip it.
@@ -235 +248 @@
                     # No match, but there might be a match if we take into
                     # account 'admin_order_field'
                     for _index, attr in enumerate(self.list_display):
-                        if getattr(attr, 'admin_order_field', '') == field:
+                        if self._get_admin_order_field(attr) == field:
                             index = _index
                             break
                 if index is not None: