Opened 11 years ago

Closed 7 years ago

#2583 closed defect (worksforme)

can't use ForeignKey in list view (class Admin: list_display)

Reported by: 235 Owned by: nobody
Component: contrib.admin Version: master
Severity: normal Keywords:
Cc: jos@… Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


If we'll use next code:

class Articles(models.Model):
    author = models.ForeignKey(Authors, blank=True, null=True, verbose_name='Автор статьи') #models.CharField('Автор статьи', maxlength=100, blank=True)
    class Admin:
        list_display = ('pub_date', ... 'author')

The list view of objects will be broken in header - there would be no header for this ForeignKey. In django/contrib/admin/templates/admin/change_list_result.html defined:

   <th{{ header.class_attrib }}>

and actualy it renders into (with TEMPLATE_STRING_IF_INVALID = "TEMPLATE_STRING_IF_INVALID" in


ForeignKey field lacks this attribute

Change History (15)

comment:1 Changed 11 years ago by anonymous

Version: SVN

comment:2 Changed 11 years ago by Adrian Holovaty

Resolution: wontfix
Status: newclosed

I can't reproduce this error. Including the name of a ForeignKey field in list_display works just fine for me.

comment:3 Changed 11 years ago by Adrian Holovaty

Resolution: wontfix
Status: closedreopened

Whoop, should be marked as a "worksforme," not "wontfix."

comment:4 Changed 11 years ago by Adrian Holovaty

Resolution: worksforme
Status: reopenedclosed

comment:5 Changed 10 years ago by Rob

Resolution: worksforme
Status: closedreopened

Same problem here, an exmaple

class Content(models.Model):
    body        = models.CharField(maxlength=1024)

class Rating(models.Model):
    body        = models.CharField(maxlength=1024)
    severity    = models.IntegerField()
    type        = models.CharField(maxlength=128)
    application = models.CharField(maxlength=128)
    class Admin:
        list_display = ('type', 'severity', 'body', 'application')

    def __str__(self):
        return "%s" % (self.type)
    class Meta:
        verbose_name_plural = "Ratings"

class Message(models.Model):
    content     = models.ForeignKey(Content)
    rating      = models.ForeignKey(Rating)
    body        = models.CharField(maxlength=1024)
    date        = models.DateTimeField(auto_now=True)
    errclass    = models.CharField(maxlength=128)
    class Admin:
        list_display = ('errclass', 'body')

    def __str__(self):
        return "%s" % (self.body)
    class Meta:
        verbose_name_plural = "Messages"

When adding 'content' or 'rating' to the list_display of Messages, the admin view is empty, i.e. no list is generated. Maybe something to do with the fact that the Message model contains TWO foreign keys?

comment:6 Changed 10 years ago by Russell Keith-Magee

Resolution: worksforme
Status: reopenedclosed

I've loaded this exact model, tried it with and without TEMPLATE_STRING_IF_INVALID set, and the list of Messages on the admin site renders fine. If I add content and rating to list_display, I get two extra columns in the table as expected.

comment:7 Changed 10 years ago by Bram.Dejong+django@…

Resolution: worksforme
Status: closedreopened

I've just started a clean django project + app (django SVN trunk) and I can reproduce this bug on both windows and linux. The code to reproduce is as follows:

from django.db import models
from django.contrib.contenttypes.models import ContentType

class Tag(models.Model):
    name = models.SlugField(unique=True, maxlength=80)
    class Admin:

    def __str__(self):

class DaoTag(models.Model):
    tag = models.ForeignKey(Tag)
    content_type = models.ForeignKey(ContentType)
    object_id = models.PositiveIntegerField()
    content_object = models.GenericForeignKey()
    class Admin:
        list_display = ('tagged_on', 'content_type', 'tag')
    def tagged_on(self):
        return str(self.content_type.model_class().objects.get(id=self.object_id))

Relevant parts of



Resulting HTML code:

<table cellspacing="0">
<thXXX MISSING VARIABLE XXX> <-----------------------!

Tagged on
<a href="?ot=asc&amp;o=1">
Content type

<a href="?ot=asc&amp;o=2">

Screenshot of admin:

As the original poster mentioned, it's header.class_attrib which is missing...

comment:8 Changed 10 years ago by Bram.Dejong+django@…

( I just saw that it's even easier to reproduce this bug: it happens in the flatpages admin. )

comment:9 Changed 10 years ago by James Bennett

Am I missing something here, or is this just an instance of the (documented) fact that TEMPLATE_STRING_IF_INVALID breaks various parts of the admin? So long as TEMPLATE_STRING_IF_INVALID is an empty string, everything works fine. If you set it to anything else you start seeing weird stuff in places that rely on the silent failure of non-existent variables (and the docs recommend using TEMPLATE_STRING_IF_INVALID only as a temporary debugging measure for this very reason).

comment:10 Changed 10 years ago by jos@…

Cc: jos@… added

I have this same problem, the admin page remains blank when using a foreignkey in list_display AND there are multiple foreignkey's.

My problem can be triggered with the following model.

class Function(models.Model):
    description = models.CharField(maxlength=255)
    subdescription = models.CharField(maxlength=255, blank=True)
    version = models.CharField(maxlength=20)
    functionclass = models.ForeignKey(Functionclass, db_column='servermanagmentApp_functionclass_id')
#    loadbalanceIpAddress = models.ForeignKey(Loadbalanceipaddress, db_column='servermanagmentApp_loadbalanceipaddress_id')
#    logicalvolume = models.ForeignKey(Logicalvolume, db_column='servermanagmentApp_logicalvolume_id')

    def __str__(self):
#        if hasattr(self, "loadbalanceIpAddress") and str(self.loadbalanceIpAddress) != "":
#          return "%s %s (%s)" % (self.description, self.subdescription, self.loadbalanceIpAddress)
#        else:
          return "%s %s" % (self.description, self.subdescription)

    class Meta:
        ordering = ('description', )

    class Admin:
        list_display = ('description', 'subdescription', 'version', 'functionclass')
        list_filter = ('functionclass', )

class Functionclass(models.Model):
    description = models.CharField(maxlength=255, core=True)

    def __str__(self):
        return self.description

    class Admin:

class Loadbalanceipaddress(models.Model):
    ipaddress = models.IPAddressField()
    port = models.PositiveSmallIntegerField()

    class Meta:
        ordering = ('ipaddress', 'port', )

    class Admin:

As long as i keep either loadbalanceIpAddress or logicalvolume commented everything works.
But when either of those are uncommented (creating multiple foreignkeys) a blank list is generated by the admin.

As can be seen in the provided screenshots, the header and contents of the list fall away, the footer is still there.

Following is the html source of the page with the empty list.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "">
<html xmlns="" lang="en-us" xml:lang="en-us" >
<title>Select function to change | Django site admin</title>
<link rel="stylesheet" type="text/css" href="/media/css/changelists.css" />


<body class="change-list">

<!-- Container -->
<div id="container">

    <!-- Header -->
    <div id="header">
        <div id="branding">
<h1 id="site-name">Django administration</h1>

        <div id="user-tools">Welcome, <strong>root</strong>. <a href="../../doc/">Documentation</a> / <a href="../../password_change/">Change password</a> / <a href="../../logout/">Log out</a></div>

    <!-- END Header -->
    <div class="breadcrumbs"><a href="../../">Home</a> &rsaquo; Functions</div>


    <!-- Content -->
    <div id="content" class="flex">
        <h1>Select function to change</h1>

<div id="content-main">

<ul class="object-tools"><li><a href="add/" class="addlink">Add function</a></li></ul>

<div class="module filtered" id="changelist">

<div id="changelist-filter">

<h3> By functionclass </h3>

    <li class="selected">
    <a href="?">All</a></li>

    <a href="?functionclass__id__exact=1">MySql</a></li>

    <a href="?functionclass__id__exact=2">www</a></li>

    <a href="?functionclass__id__exact=3">daemons</a></li>

    <a href="?functionclass__id__exact=4">squid</a></li>

    <a href="?functionclass__id__exact=5">chat</a></li>

    <a href="?functionclass__id__exact=6">loadbalancer</a></li>

    <a href="?functionclass__id__exact=7">storage</a></li>

    <a href="?functionclass__id__exact=8">sysadmin</a></li>

    <a href="?functionclass__id__exact=9">ip-telephony</a></li>

    <a href="?functionclass__id__exact=10">brick</a></li>

    <a href="?functionclass__id__exact=11">mail</a></li>

    <a href="?functionclass__id__exact=12">bricksbackuphead</a></li>



<p class="paginator">

    <span class="this-page">1</span> 

    <a href="?p=1" class="end">2</a> 

182 functions
&nbsp;&nbsp;<a href="?all=" class="showall">Show all</a>


        <br class="clear" />
    <!-- END Content -->

    <div id="footer"></div>
<!-- END Container -->


comment:11 Changed 10 years ago by jos@…

Above problem as described by me was the result of errors in the consistency of the loaded dataset.
The database query therefor generated an empty result set when the loadbalancerip table was included in the join.

Still i think this should have generated a message, informing that there where no results to display.

Iam sorry for the false report

comment:12 Changed 9 years ago by Jacob

Resolution: worksforme
Status: reopenedclosed

worksforme -- all the reported cases are either TEMPLATE_STRING_IF_INVALID or messed up data.

comment:13 Changed 9 years ago by James Bennett

This is definitely fixed in trunk now, but for anyone stumbling across it on older Django: another way to trigger this is to have two foreign keys to the same table, one of them with null=True and the other set in list_display (older versions of Django will not do the proper join to make this work).

comment:14 Changed 7 years ago by attila_forgacs

Resolution: worksforme
Status: closedreopened

Reproducible in Django 1.1.1.
Just to be sure :
Model works perfect.
If I refer a FK in list_display
the whole row is gone !
Nothing is displayed. Screen sais i should see 15 records,
there ain't any not even in the HTML.
So i had to reopen ticket.

comment:15 in reply to:  14 Changed 7 years ago by Karen Tracey

Resolution: worksforme
Status: reopenedclosed

Replying to attila_forgacs:

The original problem here was apparently due to having TEMPLATE_STRING_IF_INVALID set to something other than an empty string, and it involved incorrect display, not all of the entries that should be there not being displayed. Thus, you seem to be having a different problem, not this one.

Plenty of people use ForeignKeys in list_display; this feature is not fundamentally broken. There is something particular to your models, your configuration, or possibly even the data in your database that is causing the problem you are seeing. Since you have provided no information about any of that, it's rather difficult to help diagnose. Also, this is not the right place for it. I suggest posting more information on django-users and someone may be able to help. At this point a ticket is premature because we have no idea whether the problem is in your setup or in Django itself.

Note: See TracTickets for help on using tickets.
Back to Top