Changeset 8352

Timestamp:

08/14/08 15:12:19 (11 months ago)

Author:

brosner

Message:

Fixed #7503 -- Allow callables in list_display. This also does a lookup on the ModelAdmin? for the method if the value is a string before looking on the model. Refs #8054. Thanks qmanic and Daniel Pope for tickets and patches.

Files:

• django/trunk/django/contrib/admin/templatetags/admin_list.py (modified) (2 diffs)
• django/trunk/django/contrib/admin/validation.py (modified) (1 diff)
• django/trunk/docs/admin.txt (modified) (3 diffs)

django/trunk/django/contrib/admin/templatetags/admin_list.py

@@ -85 +85 @@
-                header = smart_str(lookup_opts.verbose_name)
-            else:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-                try:
-                    header = attr.short_description
-                except AttributeError:
-
+
+
+
+
+
-
-            # It is a non-field, but perhaps one that is sortable
-getattr(cl.model, field_name)
+attr
-            if not admin_order_field:
-                yield {"text": header}
@@ -129 +145 @@
-            f = cl.lookup_opts.get_field(field_name)
-        except models.FieldDoesNotExist:
-
-or a property
+,
+property or returned via a callable
-            try:
-
+
+
+
+
+
+
+
+
+
+
+
+
-                allow_tags = getattr(attr, 'allow_tags', False)
-                boolean = getattr(attr, 'boolean', False)
-                if callable(attr):
-                    attr = attr()
-                if boolean:
-                    allow_tags = True
-attr
-
-attr
+value
+
+value
-            except (AttributeError, ObjectDoesNotExist):
-                result_repr = EMPTY_CHANGELIST_VALUE

django/trunk/django/contrib/admin/validation.py

@@ -36 +36 @@
-        _check_istuplew('list_display', cls.list_display)
-        for idx, field in enumerate(cls.list_display):
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    # list_display_links

django/trunk/docs/admin.txt

@@ -202 +202 @@
-that displays the ``__unicode__()`` representation of each object.
-
+You have four possible values that can be used in ``list_display``:
+
+    * A field of the model. For example::
+    
+          class PersonAdmin(admin.ModelAdmin):
+              list_display = ('first_name', 'last_name')
+    
+    * A callable that accepts one parameter for the model instance. For
+      example::
+    
+          def upper_case_name(obj):
+              return "%s %s" % (obj.first_name, obj.last_name).upper()
+          upper_case_name.short_description = 'Name'
+        
+          class PersonAdmin(admin.ModelAdmin):
+              list_display = (upper_case_name,)
+    
+    * A string representating an attribute on the ``ModelAdmin``. This behaves
+      the same as the callable. For example::
+      
+          class PersonAdmin(admin.ModelAdmin):
+              list_display = ('upper_case_name',)
+              
+              def upper_case_name(self, obj):
+                return "%s %s" % (obj.first_name, obj.last_name).upper()
+              upper_case_name.short_description = 'Name'
+    
+    * A string representating an attribute on the model. This behaves almost
+      the same as the callable, but ``self`` in this context is the model
+      instance. Here's a full model example::
+
+          class Person(models.Model):
+              name = models.CharField(max_length=50)
+              birthday = models.DateField()
+
+              def decade_born_in(self):
+                  return self.birthday.strftime('%Y')[:3] + "0's"
+              decade_born_in.short_description = 'Birth decade'
+
+          class PersonAdmin(admin.ModelAdmin):
+              list_display = ('name', 'decade_born_in')
+
-A few special cases to note about ``list_display``:
-
@@ -216 +258 @@
-      display a pretty "on" or "off" icon instead of ``True`` or ``False``.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-      Here's a full example model::
-
@@ -251 +277 @@
-              list_display = ('first_name', 'last_name', 'colored_name')
-
-
-
-
+
+
+
+
-
-      Here's a full example model::