[Django] #23055: Filters don't use ModelAdmin get

Django

unread,

Jul 17, 2014, 4:15:42 PM7/17/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner: nobody
Type: Bug | Status: new
Component: | Version: master
contrib.admin | Keywords: admin filters
Severity: Normal | list_filter multi-db get_queryset
Triage Stage: | modeladmin
Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
If one is using a ModelAdmin with a custom `get_queryset()` method e.g as
described in https://docs.djangoproject.com/en/1.7/topics/db/multi-db
/#exposing-multiple-databases-in-django-s-admin-interface to handle
routing of models hosted in a multi-DB setup, displaying the change list
works as expected.

But when usage of the `list_filter` feature is added, a DB error is
generated reporting that no table object for the model a hand is found in
the default Django DB.

This is because the filter machinery doesn't use the custom ModelAdmin-
dictated !QuerySet but the model's default manager `all()` method:

(https://github.com/django/django/blob/011abb7d96c75f6154c15a8a0f997d8c27698679/django/contrib/admin/filters.py#L364)

{{{
queryset = parent_model._default_manager.all()
}}}

Replacing it with:

{{{
diff --git a/django/contrib/admin/filters.py
b/django/contrib/admin/filters.py
index d5f31ab..d04d5cc 100644
--- a/django/contrib/admin/filters.py
+++ b/django/contrib/admin/filters.py
@@ -361,7 +361,7 @@ class AllValuesFieldListFilter(FieldListFilter):
self.lookup_val_isnull =
request.GET.get(self.lookup_kwarg_isnull,
None)
parent_model, reverse_path = reverse_field_path(model,
field_path)
- queryset = parent_model._default_manager.all()
+ queryset = model_admin.get_queryset(request)
# optional feature: limit choices base on existing relationships
# queryset = queryset.complex_filter(
# {'%s__isnull' % reverse_path: False})
}}}

solves the problem.

--
Ticket URL: <https://code.djangoproject.com/ticket/23055>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,

Jul 17, 2014, 4:52:59 PM7/17/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner: nobody
Type: Bug | Status: new

Old description:

New description:

If one is using a ModelAdmin with a custom `get_queryset()` method (e.g.

as described in https://docs.djangoproject.com/en/1.7/topics/db/multi-db
/#exposing-multiple-databases-in-django-s-admin-interface to handle

routing of models hosted in a multi-DB setup), displaying the change list
works as expected.

But when usage of the `list_filter` feature is added, a DB error is

generated reporting that no table object for the model at hand is found in
the default Django DB.

This is because the filter machinery doesn't use the custom ModelAdmin-
dictated !QuerySet but the model's default manager `all()` method:

(https://github.com/django/django/blob/011abb7d96c75f6154c15a8a0f997d8c27698679/django/contrib/admin/filters.py#L364)

{{{
queryset = parent_model._default_manager.all()
}}}

Replacing it with:

{{{
diff --git a/django/contrib/admin/filters.py
b/django/contrib/admin/filters.py
index d5f31ab..d04d5cc 100644
--- a/django/contrib/admin/filters.py
+++ b/django/contrib/admin/filters.py
@@ -361,7 +361,7 @@ class AllValuesFieldListFilter(FieldListFilter):
self.lookup_val_isnull =
request.GET.get(self.lookup_kwarg_isnull,
None)
parent_model, reverse_path = reverse_field_path(model,
field_path)
- queryset = parent_model._default_manager.all()
+ queryset = model_admin.get_queryset(request)
# optional feature: limit choices base on existing relationships
# queryset = queryset.complex_filter(
# {'%s__isnull' % reverse_path: False})
}}}

solves the problem.

--

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:1>

Django

unread,

Jul 21, 2014, 3:16:09 PM7/21/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner: nobody
Type: Bug | Status: new

Component: contrib.admin | Version: master
Severity: Normal | Resolution:

* stage: Unreviewed => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:2>

Django

unread,

Jul 26, 2014, 11:55:47 AM7/26/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner: nobody
Type: Bug | Status: new

Comment (by synasius):

Hi ramiro,

I'm trying to reproduce the issue but I can't. Can you help me?

This is my current setup: I have a `foo` application with just one `Stuff`
model

{{{
#!python
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
},
'other': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'other.sqlite3'),
},
}

DATABASE_ROUTERS = ['help.routers.FooRouter']
}}}

and that's my ModelAdmin

{{{
#!python
class MultiDBModelAdmin(admin.ModelAdmin):
# A handy constant for the name of the alternate database.
using = 'other'

def get_queryset(self, request):
# Tell Django to look for objects on the 'other' database.
return super(MultiDBModelAdmin,
self).get_queryset(request).using(self.using)

# Register your models here.
class StuffAdmin(MultiDBModelAdmin):
list_filter = ("empty",)
}}}

The router is used to create the `foo_stuff` table only in the `other` db.

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:3>

Django

unread,

Jul 27, 2014, 4:34:59 PM7/27/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner: nobody
Type: Bug | Status: new

Comment (by ramiro):

Replying to [comment:3 synasius]:

> Hi ramiro,
>
> I'm trying to reproduce the issue but I can't. Can you help me?

No router should be used (or rather, no custom DB routing scheme should be
in place, just use the default setup). That's why I didn't mention them in
the report.

This setup could well be a corner case but in practice there is no need
to use multi-DB to experiece the bug:

Imagine you use just one database, and you limit the set of available
objects that can be handled in the admin by returning a filtered queryset
in the relevant !ModelAdmin `get_queryset()` method and so the changelist
will list only the model instances resulting from such filtering. But
because of this bug, the right-side filters will be created based on the
full unfiltered queryset of the model's default manager.

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:4>

Django

unread,

Aug 5, 2014, 12:02:17 PM8/5/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------

Reporter: ramiro | Owner: anonymous
Type: Bug | Status: assigned

Changes (by Ola Sitarska <ola@…>):

* status: new => assigned
* owner: nobody => anonymous

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:5>

Django

unread,

Aug 5, 2014, 12:02:51 PM8/5/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner:

* owner: anonymous => olasitarska

Comment:

Sorry, I didn't login :)

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:6>

Django

unread,

Aug 5, 2014, 12:50:08 PM8/5/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner:

Comment (by olasitarska):

Ok, so I wrote a test for that:
https://github.com/olasitarska/django/commit/b36252346b78f5a387133bba2b889ed9e253edfe

And when I tried implementing solution proposed here by ramiro, it is
breaking another test.

{{{
ERROR: test_fieldlistfilter_underscorelookup_tuple
(admin_filters.tests.ListFiltersTests)
----------------------------------------------------------------------
FieldError: Cannot resolve keyword 'email' into field. Choices are:
author, author_id, contributors, date_registered, id, is_best_seller, no,
title, year
}}}

It happens because in scenario when we are filtering by `author__email`,
this line:
{{{
queryset = parent_model._default_manager.all()
}}}
would return a User Queryset, while this line:
{{{
queryset = model_admin.get_queryset(request)
}}}
still returns a Book Queryset.

I am totally not an expert (it's actually my first contribution). We can
probably check if model connected to `modeladmin` is the same as `model`
and act accordingly, but how can we pass along those filters from custom
modeladmin queryset?

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:7>

Django

unread,

Aug 5, 2014, 1:36:15 PM8/5/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner:

Comment (by olasitarska):

I dug some more into the code and I think that issue ramiro is referring
to in his last comment is actually somewhere else - filters like that are
rendered by class RelatedFieldListFilter which returns choices directly
from Model field.

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:8>

Django

unread,

Aug 7, 2014, 4:32:12 PM8/7/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------
Reporter: ramiro | Owner:

Type: Bug | Status: new

Needs tests: 0 |
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Changes (by olasitarska):

* status: assigned => new
* owner: olasitarska =>

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:9>

Django

unread,

Aug 28, 2014, 4:31:45 PM8/28/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------

Reporter: ramiro | Owner: ramiro
Type: Bug | Status: assigned

Has patch: 1 | UI/UX: 0

Needs tests: 0 |
Easy pickings: 0 |
-------------------------------------+-------------------------------------

Changes (by ramiro):

* owner: => ramiro

* status: new => assigned

* has_patch: 0 => 1

Comment:

PR is at https://github.com/django/django/pull/3136

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:10>

Django

unread,

Aug 29, 2014, 8:48:56 AM8/29/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------

Reporter: ramiro | Owner: ramiro
Type: Bug | Status: assigned
Component: contrib.admin | Version: master
Severity: Normal | Resolution:

Keywords: admin filters | Triage Stage: Ready for
list_filter multi-db get_queryset | checkin
modeladmin | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Changes (by timgraham):

* stage: Accepted => Ready for checkin

Comment:

Minor test failure on non-sqlite; looks good otherwise.

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:11>

Django

unread,

Aug 30, 2014, 9:17:13 AM8/30/14

to django-...@googlegroups.com

#23055: Filters don't use ModelAdmin get_queryset()
-------------------------------------+-------------------------------------

Reporter: ramiro | Owner: ramiro
Type: Bug | Status: closed
Component: contrib.admin | Version: master
Severity: Normal | Resolution: fixed

Changes (by Ramiro Morales <cramm0@…>):

* status: assigned => closed
* resolution: => fixed

Comment:

In [changeset:"3a297d78169b7d3c6d688cf0e349f4663acc6bad"]:
{{{
#!CommitTicketReference repository=""
revision="3a297d78169b7d3c6d688cf0e349f4663acc6bad"
Fixed #23055 -- Made generic admin filter obey ModelAdmin queryset.

Thanks to Trac user synasius and to Ola Sitarska for helping in
identifying the issue and helping with the test case.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/23055#comment:12>

Reply all

Reply to author

Forward

[Django] #23055: Filters don't use ModelAdmin get_queryset()

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django