diff --git a/django/contrib/admin/filterspecs.py b/django/contrib/admin/filterspecs.py index 908fb8fe09..31a6ba37c9 100644 --- a/django/contrib/admin/filterspecs.py +++ b/django/contrib/admin/filterspecs.py @@ -1,3 +1,11 @@ +""" +FilterSpec encapsulates the logic for displaying filters in the Django admin. +Filters are specified in models with the "list_filter" option. + +Each filter subclass knows how to display a filter for a field that passes a +certain test -- e.g. being a DateField or ForeignKey. +""" + from django.core import meta import datetime @@ -6,42 +14,42 @@ class FilterSpec(object): def __init__(self, f, request, params): self.field = f self.params = params - + def register(cls, test, factory): cls.filter_specs.append( (test, factory) ) register = classmethod(register) - + def create(cls, f, request, params): for test, factory in cls.filter_specs: if test(f): - return factory(f, request, params) + return factory(f, request, params) create = classmethod(create) - + def has_output(self): return True - + def choices(self, cl): raise NotImplementedError() - + def title(self): return self.field.verbose_name - + def output(self, cl): t = [] if self.has_output(): t.append(_('

By %s:

\n\n\n') return "".join(t) - + class RelatedFilterSpec(FilterSpec): def __init__(self, f, request, params): - super(RelatedFilterSpec, self).__init__(f, request, params) + super(RelatedFilterSpec, self).__init__(f, request, params) if isinstance(f, meta.ManyToManyField): self.lookup_title = f.rel.to.verbose_name else: @@ -49,22 +57,23 @@ class RelatedFilterSpec(FilterSpec): self.lookup_kwarg = '%s__%s__exact' % (f.name, f.rel.to.pk.name) self.lookup_val = request.GET.get(self.lookup_kwarg, None) self.lookup_choices = f.rel.to.get_model_module().get_list() - + def has_output(self): return len(self.lookup_choices) > 1 - + def title(self): - return self.lookup_title - + return self.lookup_title + def choices(self, cl): yield {'selected': self.lookup_val is None, - 'query_string': cl.get_query_string({}, [self.lookup_kwarg]), - 'display': _('All') } + 'query_string': cl.get_query_string({}, [self.lookup_kwarg]), + 'display': _('All')} for val in self.lookup_choices: pk_val = getattr(val, self.field.rel.to.pk.attname) - yield { 'selected': self.lookup_val == str(pk_val), - 'query_string': cl.get_query_string( {self.lookup_kwarg: pk_val}), - 'display' : val } + yield {'selected': self.lookup_val == str(pk_val), + 'query_string': cl.get_query_string( {self.lookup_kwarg: pk_val}), + 'display': val} + FilterSpec.register(lambda f: bool(f.rel), RelatedFilterSpec) class ChoicesFilterSpec(FilterSpec): @@ -72,51 +81,51 @@ class ChoicesFilterSpec(FilterSpec): super(ChoicesFilterSpec, self).__init__(f, request, params) self.lookup_kwarg = '%s__exact' % f.name self.lookup_val = request.GET.get(self.lookup_kwarg, None) - + def choices(self, cl): - yield {'selected' : self.lookup_val is None, - 'query_string': cl.get_query_string( {}, [self.lookup_kwarg]), - 'display': _('All') } + yield {'selected': self.lookup_val is None, + 'query_string': cl.get_query_string( {}, [self.lookup_kwarg]), + 'display': _('All')} for k, v in self.field.choices: - yield {'selected': str(k) == self.lookup_val, - 'query_string' : cl.get_query_string( {self.lookup_kwarg: k}), - 'display' : v } + yield {'selected': str(k) == self.lookup_val, + 'query_string': cl.get_query_string( {self.lookup_kwarg: k}), + 'display': v} + FilterSpec.register(lambda f: bool(f.choices), ChoicesFilterSpec) class DateFieldFilterSpec(FilterSpec): - def __init__(self, f, request, params): super(DateFieldFilterSpec, self).__init__(f, request, params) - + self.field_generic = '%s__' % self.field.name - + self.date_params = dict([(k, v) for k, v in params.items() if k.startswith(self.field_generic)]) - + today = datetime.date.today() one_week_ago = today - datetime.timedelta(days=7) today_str = isinstance(self.field, meta.DateTimeField) and today.strftime('%Y-%m-%d 23:59:59') or today.strftime('%Y-%m-%d') - + self.links = ( (_('Any date'), {}), - (_('Today'), {'%s__year' % self.field.name: str(today.year), - '%s__month' % self.field.name: str(today.month), + (_('Today'), {'%s__year' % self.field.name: str(today.year), + '%s__month' % self.field.name: str(today.month), '%s__day' % self.field.name: str(today.day)}), - (_('Past 7 days'), {'%s__gte' % self.field.name: one_week_ago.strftime('%Y-%m-%d'), + (_('Past 7 days'), {'%s__gte' % self.field.name: one_week_ago.strftime('%Y-%m-%d'), '%s__lte' % f.name: today_str}), - (_('This month'), {'%s__year' % self.field.name: str(today.year), + (_('This month'), {'%s__year' % self.field.name: str(today.year), '%s__month' % f.name: str(today.month)}), (_('This year'), {'%s__year' % self.field.name: str(today.year)}) - ) - + ) + def title(self): return self.field.verbose_name - + def choices(self, cl): for title, param_dict in self.links: - yield { 'selected' : self.date_params == param_dict, - 'query_string' : cl.get_query_string( param_dict, self.field_generic), - 'display' : title } - + yield {'selected': self.date_params == param_dict, + 'query_string': cl.get_query_string( param_dict, self.field_generic), + 'display': title} + FilterSpec.register(lambda f: isinstance(f, meta.DateField), DateFieldFilterSpec) class BooleanFieldFilterSpec(FilterSpec): @@ -126,20 +135,18 @@ class BooleanFieldFilterSpec(FilterSpec): self.lookup_kwarg2 = '%s__isnull' % f.name self.lookup_val = request.GET.get(self.lookup_kwarg, None) self.lookup_val2 = request.GET.get(self.lookup_kwarg2, None) - + def title(self): return self.field.verbose_name - + def choices(self, cl): for k, v in ((_('All'), None), (_('Yes'), '1'), (_('No'), '0')): - yield { 'selected' : self.lookup_val == v and not self.lookup_val2, - 'query_string' : cl.get_query_string( {self.lookup_kwarg: v}, [self.lookup_kwarg2]), - 'display': k - } + yield {'selected': self.lookup_val == v and not self.lookup_val2, + 'query_string': cl.get_query_string( {self.lookup_kwarg: v}, [self.lookup_kwarg2]), + 'display': k} if isinstance(self.field, meta.NullBooleanField): - yield { 'selected' : self.lookup_val2 == 'True', - 'query_string' : cl.get_query_string( {self.lookup_kwarg2: 'True'}, [self.lookup_kwarg]), - 'display': _('Unknown') - } -FilterSpec.register(lambda f: isinstance(f, meta.BooleanField) or - isinstance(f, meta.NullBooleanField), BooleanFieldFilterSpec) + yield {'selected': self.lookup_val2 == 'True', + 'query_string': cl.get_query_string( {self.lookup_kwarg2: 'True'}, [self.lookup_kwarg]), + 'display': _('Unknown')} + +FilterSpec.register(lambda f: isinstance(f, meta.BooleanField) or isinstance(f, meta.NullBooleanField), BooleanFieldFilterSpec)