Show field's verbose name instead of related model name for M2M filterspecs

[Julien Phalip]

Consider the following example:

Model:

from django.db import models
from django.contrib.auth.models import User

class Book(models.Model):
    title = models.CharField(max_length=25)
    year = models.PositiveIntegerField(null=True, blank=True)
    author = models.ForeignKey(User, related_name='books_authored', blank=True, null=True)
    contributors = models.ManyToManyField(User, related_name='books_contributed', blank=True, null=True)

Admin:

from django.contrib import admin

from .models import Book

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'year', 'author')
    list_filter = ('year', 'author', 'contributors')
    
admin.site.register(Book, BookAdmin)

Presumably since #3400 was fixed, M2M filterspecs are using the related model's name as title. This leads the example above to display "By user" instead of "By contributors". This is a bit silly in itself but it could be even more problematic if multiple M2M filters to User were specified at the same time.

I've discussed this with DrMeers (who wrote the patch for #3400). The patch I'm attaching seems to fix the issue but we might have to investigate a bit more to see if there are cases where it wouldn't make sense to show the field's verbose name for a M2M.

The patch doesn't contain tests yet. I'm waiting to get feedback on the latest patch I've posted in #8528 which introduces a new module for filterspecs' tests. If #8529 gets checked in then writing tests for this patch will be trivial.

[anonymous]

Yes, this problem exists, but no, it isn't related (directly) #3400 specific -- the same problem exists in 1.2.X.

[Russell Keith-Magee]

Oops - that was me.

[Julien Phalip]

Patch + tests

[Julien Phalip]

Here's to hoping it makes the 1.3 cut :-)

[patchhammer]

15221_m2m_filterspec_title.2.diff fails to apply cleanly on to trunk

[dmclain]

updated patch to match up against trunk

[Julien Phalip]

Oh, you beat me to it. Thanks for updating the patch! ;-)

So yeah, this is related to #15971.

[Julien Phalip]

#16711 is a dupe.

[anonymous]

Here is a workaround to this problem:

​http://stackoverflow.com/questions/7199922/django-admin-filter-verbose-name-on-listing-page/

I hope that can be useful to someone.

[Jacob]

Milestone 1.3 deleted

[Julien Phalip]

In [16991]:

Fixed #15221 -- Made the admin filters on foreign key and m2m relationships display the related field's verbose name instead of that of the related model.