Ticket #11058: ticket-11058-list_display_links-1.3.patch

django/contrib/admin/validation.py

@@ -23 +23 @@
     opts = model._meta
     validate_base(cls, model)
 
+    # To handle values other than pure strings, we'll maintain a list of
+    # possible values allowing the possibility of using ModelAdmin fields
+    # or arbitrary callables in list_display_links.
+    list_display_fields = set()
+
     # list_display
     if hasattr(cls, 'list_display'):
         check_isseq(cls, 'list_display', cls.list_display)
         for idx, field in enumerate(cls.list_display):
+            list_display_fields.add(field)
+
             if not callable(field):
                 if not hasattr(cls, field):
                     if not hasattr(model, field):
                         try:
-                            opts.get_field(field)
+                            f = opts.get_field(field)
                         except models.FieldDoesNotExist:
                             raise ImproperlyConfigured("%s.list_display[%d], %r is not a callable or an attribute of %r or found in the model %r."
                                 % (cls.__name__, idx, field, cls.__name__, model._meta.object_name))
                     else:
                         # getattr(model, field) could be an X_RelatedObjectsDescriptor
                         f = fetch_attr(cls, model, opts, "list_display[%d]" % idx, field)
+
                         if isinstance(f, models.ManyToManyField):
                             raise ImproperlyConfigured("'%s.list_display[%d]', '%s' is a ManyToManyField which is not supported."
                                 % (cls.__name__, idx, field))
 
+                    list_display_fields.add(f)
+
     # list_display_links
     if hasattr(cls, 'list_display_links'):
         check_isseq(cls, 'list_display_links', cls.list_display_links)
+
         for idx, field in enumerate(cls.list_display_links):
-            fetch_attr(cls, model, opts, 'list_display_links[%d]' % idx, field)
-            if field not in cls.list_display:
+            if field not in list_display_fields:
                 raise ImproperlyConfigured("'%s.list_display_links[%d]'"
-                        "refers to '%s' which is not defined in 'list_display'."
+                        " refers to '%s' which is not defined in 'list_display'."
                         % (cls.__name__, idx, field))
 
+    del list_display_fields
+
     # list_filter
     if hasattr(cls, 'list_filter'):
         check_isseq(cls, 'list_filter', cls.list_filter)

docs/ref/contrib/admin/index.txt

@@ -479 +479 @@
     By default, the change list page will link the first column -- the first
     field specified in ``list_display`` -- to the change page for each item.
     But ``list_display_links`` lets you change which columns are linked. Set
-    ``list_display_links`` to a list or tuple of field names (in the same
+    ``list_display_links`` to a list or tuple of field (in the same
     format as ``list_display``) to link.
 
-    ``list_display_links`` can specify one or many field names. As long as the
-    field names appear in ``list_display``, Django doesn't care how many (or
+    ``list_display_links`` can specify one or many field. As long as the
+    fields appear in ``list_display``, Django doesn't care how many (or
     how few) fields are linked. The only requirement is: If you want to use
     ``list_display_links``, you must define ``list_display``.
 

tests/regressiontests/admin_validation/tests.py

@@ -242 +242 @@
 
         validate(FieldsOnFormOnlyAdmin, Song)
 
+    def test_list_display_links(self):
+        """
+        Confirm that list_display_links supports model fields, model admin
+        methods and arbitrary callables
+        """
+
+        def fancy_formatter(obj):
+            return "Custom display of %s" % obj
 
+        class SongAdmin(admin.ModelAdmin):
+            foo_date = fancy_formatter
+
+            list_display = ("title", "album", "original_release",
+                            "readonly_method_on_model", "short_title",
+                            foo_date)
+            list_display_links = ("title", "album", "original_release",
+                                    "readonly_method_on_model", "short_title",
+                                    foo_date)
 
+            def short_title(self, obj):
+                # In real code this would use truncatewords/chars:
+                return obj.title[:20]
+            short_title.short_description = "Short Title"
 
+        validate(SongAdmin, Song)

tests/regressiontests/modeladmin/tests.py

@@ -794 +794 @@
 
         self.assertRaisesRegexp(
             ImproperlyConfigured,
-            "'ValidationTestModelAdmin.list_display_links\[0\]' refers to 'non_existent_field' that is neither a field, method or property of model 'ValidationTestModel'.",
+            "'ValidationTestModelAdmin.list_display_links\[0\]' refers to 'non_existent_field' which is not defined in 'list_display'.",
             validate,
             ValidationTestModelAdmin,
             ValidationTestModel,
@@ -805 +805 @@
 
         self.assertRaisesRegexp(
             ImproperlyConfigured,
-            "'ValidationTestModelAdmin.list_display_links\[0\]'refers to 'name' which is not defined in 'list_display'.",
+            "'ValidationTestModelAdmin.list_display_links\[0\]' refers to 'name' which is not defined in 'list_display'.",
             validate,
             ValidationTestModelAdmin,
             ValidationTestModel,