Ticket #17515: 17515.admin-filter-custom-templates.diff

django/contrib/admin/filters.py

@@ -17 +17 @@
 
 class ListFilter(object):
     title = None  # Human-readable title to appear in the right sidebar.
+    template = 'admin/filter.html'
 
     def __init__(self, request, params, model, model_admin):
         # This dictionary will eventually contain the request's query string

django/contrib/admin/templatetags/admin_list.py

@@ -13 +13 @@
 from django.utils.translation import ugettext as _
 from django.utils.encoding import smart_unicode, force_unicode
 from django.template import Library
-
+from django.template.loader import get_template
+from django.template.context import Context
 
 register = Library()
 
@@ -360 +361 @@
         'search_var': SEARCH_VAR
     }
 
-@register.inclusion_tag('admin/filter.html')
+@register.simple_tag()
 def admin_list_filter(cl, spec):
-    return {'title': spec.title, 'choices' : list(spec.choices(cl))}
+    t = get_template(spec.template)
+    ctx = Context({'title': spec.title, 'choices' : list(spec.choices(cl)), 'spec': spec})
+    return t.render(ctx)
 
 @register.inclusion_tag('admin/actions.html', takes_context=True)
 def admin_actions(context):

docs/ref/contrib/admin/index.txt

@@ -697 +697 @@
 
       .. note::
 
-          The ``FieldListFilter`` API is currently considered internal
-          and prone to refactoring.
+        The ``FieldListFilter`` API is currently considered internal and prone
+        to refactoring.
+
+    .. versionadded:: 1.4
+
+    It is possible to specify a custom template for rendering a list filter::
+
+        class FilterWithCustomTemplate(SimpleListFilter):
+            template = "custom_template.html"
+
+    See the default template provided by django (``admin/filter.html``) for
+    a concrete example.
 
 .. attribute:: ModelAdmin.list_max_show_all
 

tests/regressiontests/admin_views/admin.py

@@ -13 +13 @@
 from django.db import models
 from django.forms.models import BaseModelFormSet
 from django.http import HttpResponse
+from django.contrib.admin import BooleanFieldListFilter
 
 from .models import (Article, Chapter, Account, Media, Child, Parent, Picture,
     Widget, DooHickey, Grommet, Whatsit, FancyDoodad, Category, Link,
@@ -25 +26 @@
     CoverLetter, Story, OtherStory, Book, Promo, ChapterXtra1, Pizza, Topping,
     Album, Question, Answer, ComplexSortedPerson, PrePopulatedPostLargeSlug,
     AdminOrderedField, AdminOrderedModelMethod, AdminOrderedAdminMethod,
-    AdminOrderedCallable, Report)
+    AdminOrderedCallable, Report, Color2)
 
 
 def callable_year(dt_value):
@@ -512 +513 @@
                 name='cable_extra'),
         )
 
+class CustomTemplateBooleanFieldListFilter(BooleanFieldListFilter):
+    template = 'custom_filter_template.html'
+
+class CustomTemplateFilterColorAdmin(admin.ModelAdmin):
+    list_filter = (('warm', CustomTemplateBooleanFieldListFilter),)
+
 site = admin.AdminSite(name="admin")
 site.register(Article, ArticleAdmin)
 site.register(CustomArticle, CustomArticleAdmin)
@@ -581 +588 @@
 site.register(AdminOrderedModelMethod, AdminOrderedModelMethodAdmin)
 site.register(AdminOrderedAdminMethod, AdminOrderedAdminMethodAdmin)
 site.register(AdminOrderedCallable, AdminOrderedCallableAdmin)
+site.register(Color2, CustomTemplateFilterColorAdmin)
 
 # Register core models we need in our tests
 from django.contrib.auth.models import User, Group

tests/regressiontests/admin_views/models.py

@@ -106 +106 @@
     def __unicode__(self):
         return self.value
 
+# we replicate Color to register with another ModelAdmin
+class Color2(Color):
+    class Meta:
+        proxy = True
 
 class Thing(models.Model):
     title = models.CharField(max_length=20)

new file tests/regressiontests/admin_views/templates/custom_filter_template.html

@@ +1 @@
+<h3>By {{ filter_title }} (custom)</h3>
+<ul>
+{% for choice in choices %}
+    <li{% if choice.selected %} class="selected"{% endif %}>
+    <a href="{{ choice.query_string|iriencode }}">{{ choice.display }}</a></li>
+{% endfor %}
+</ul>

tests/regressiontests/admin_views/tests.py

@@ -1 +1 @@
 # coding: utf-8
 from __future__ import with_statement, absolute_import
 
+import os
 import re
 import datetime
 import urlparse
@@ -573 +574 @@
         except SuspiciousOperation:
             self.fail("Filters should be allowed if they are defined on a ForeignKey pointing to this model")
 
+    def test_filter_with_custom_template(self):
+        """
+        Ensure that one can use a custom template to render an admin filter.
+        Refs #17515.
+        """
+        template_dirs = settings.TEMPLATE_DIRS + (
+            os.path.join(os.path.dirname(__file__), 'templates'),)
+        with self.settings(TEMPLATE_DIRS=template_dirs):
+            response = self.client.get("/test_admin/admin/admin_views/color2/")
+            self.assertTrue('custom_filter_template.html' in [t.name for t in response.templates])
+
+
 class AdminJavaScriptTest(AdminViewBasicTest):
     urls = "regressiontests.admin_views.urls"