Ticket #14396: 14396_list_select_related2.patch

docs/ref/contrib/admin/index.txt

@@ -657 +657 @@
 .. attribute:: ModelAdmin.list_select_related
 
     Set ``list_select_related`` to tell Django to use
-    :meth:`~django.db.models.QuerySet.select_related` in retrieving the list of
-    objects on the admin change list page. This can save you a bunch of
+    :meth:`~django.db.models.query.QuerySet.select_related` in retrieving the 
+    list of objects on the admin change list page. This can save you a bunch of
     database queries.
 
-    The value should be either ``True`` or ``False``. Default is ``False``.
+    The value should be one of:
 
-    Note that Django will use :meth:`~django.db.models.QuerySet.select_related`,
-    regardless of this setting if one of the ``list_display`` fields is a
-    ``ForeignKey``.
+    * ``True`` or ``False``. If ``True``, the standard 
+      :meth:`~django.db.models.query.QuerySet.select_related` call will be used. 
 
+    * A list or tuple of field names. In this case, the value is used as the 
+      argument to :meth:`~django.db.models.query.QuerySet.select_related` which
+      determines which relations should be followed.
+
+    The default is ``False``.
+
+    Note that Django will use 
+    :meth:`~django.db.models.query.QuerySet.select_related`, regardless of this 
+    setting, if one of the :attr:`~ModelAdmin.list_display` fields is a 
+    :class:`~django.db.models.ForeignKey` or 
+    :class:`~django.db.models.OneToOneField`.
+
 .. attribute:: ModelAdmin.ordering
 
     Set ``ordering`` to specify how lists of objects should be ordered in the

django/contrib/admin/validation.py

@@ -160 +160 @@
     if hasattr(cls, "readonly_fields"):
         check_readonly_fields(cls, model, opts)
 
-    # list_select_related = False
     # save_as = False
     # save_on_top = False
-    for attr in ('list_select_related', 'save_as', 'save_on_top'):
+    for attr in ('save_as', 'save_on_top'):
         if not isinstance(getattr(cls, attr), bool):
             raise ImproperlyConfigured("'%s.%s' should be a boolean."
                     % (cls.__name__, attr))
 
+    # list_select_related = False
+    if not isinstance(cls.list_select_related, (bool, list, tuple)):
+        raise ImproperlyConfigured("'%s.list_select_related' should be a boolean, a list or a tuple."
+                                   % cls.__name__)
 
     # inlines = []
     if hasattr(cls, 'inlines'):
@@ -197 +200 @@
     fk = _get_foreign_key(parent_model, cls.model, fk_name=cls.fk_name, can_fail=True)
 
     # extra = 3
-    if not isinstance(cls.extra, int):
+    if not isinstance(getattr(cls, 'extra'), int):
         raise ImproperlyConfigured("'%s.extra' should be a integer."
                 % cls.__name__)
 

django/contrib/admin/views/main.py

@@ -3 +3 @@
 from django.core.exceptions import SuspiciousOperation
 from django.core.paginator import InvalidPage
 from django.db import models
+from django.db.models.query import QuerySet
 from django.utils.encoding import force_unicode, smart_str
 from django.utils.translation import ugettext, ugettext_lazy
 from django.utils.http import urlencode
@@ -276 +277 @@
         # with a relationship and the provided queryset doesn't already have
         # select_related defined.
         if not qs.query.select_related:
-            if self.list_select_related:
+            if isinstance(self.list_select_related, (list, tuple)):
+                qs = qs.select_related(*self.list_select_related)
+            elif self.list_select_related:
                 qs = qs.select_related()
             else:
                 for field_name in self.list_display:
@@ -285 +288 @@
                     except models.FieldDoesNotExist:
                         pass
                     else:
-                        if isinstance(field.rel, models.ManyToOneRel):
+                        if isinstance(field.rel, (models.ManyToOneRel, models.OneToOneRel)):
                             qs = qs.select_related()
                             break
 

tests/regressiontests/admin_changelist/tests.py

@@ -41 +41 @@
             'Failed to find expected row element: %s' % table_output)
 
 
+    def test_select_related_nullable(self):
+        """
+        Regression test for #14396: allow list_select_related to explicitly 
+        specify relations to follow.
+        """
+        m = NullableChildAdmin(Child, admin.site)
+        cl = ChangeList(MockRequest(), Child, m.list_display, 
+                        m.list_display_links, m.list_filter, m.date_hierarchy, 
+                        m.search_fields, m.list_select_related, m.list_per_page, 
+                        m.list_editable, m)
+        self.assertEqual(cl.query_set.query.select_related, {'parent': {}})
+
     def test_result_list_html(self):
         """
         Verifies that inclusion tag result_list generates a table when with
@@ -321 +333 @@
         return super(FilteredChildAdmin, self).queryset(request).filter(
             name__contains='filtered')
 
+class NullableChildAdmin(admin.ModelAdmin):
+    list_select_related = ('parent',)
+
 class MockRequest(object):
     GET = {}
 

tests/regressiontests/modeladmin/tests.py

@@ -1032 +1032 @@
 
         self.assertRaisesRegexp(
             ImproperlyConfigured,
-            "'ValidationTestModelAdmin.list_select_related' should be a boolean.",
+            "'ValidationTestModelAdmin.list_select_related' should be a boolean, a list or a tuple.",
             validate,
             ValidationTestModelAdmin,
             ValidationTestModel,
@@ -1043 +1043 @@
 
         validate(ValidationTestModelAdmin, ValidationTestModel)
 
+        class ValidationTestModelAdmin(ModelAdmin):
+            list_select_related = ('field1', 'field2')
+
+        validate(ValidationTestModelAdmin, ValidationTestModel)
+
     def test_save_as_validation(self):
 
         class ValidationTestModelAdmin(ModelAdmin):