1
0
mirror of https://github.com/django/django.git synced 2025-07-04 09:49:12 +00:00

new-admin: Added docstring to contrib.admin.filterspecs and cleaned up spacing

git-svn-id: http://code.djangoproject.com/svn/django/branches/new-admin@1427 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2005-11-25 03:18:11 +00:00
parent 5edaf7838e
commit 8be7d7e544

View File

@ -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 from django.core import meta
import datetime import datetime
@ -59,12 +67,13 @@ class RelatedFilterSpec(FilterSpec):
def choices(self, cl): def choices(self, cl):
yield {'selected': self.lookup_val is None, yield {'selected': self.lookup_val is None,
'query_string': cl.get_query_string({}, [self.lookup_kwarg]), 'query_string': cl.get_query_string({}, [self.lookup_kwarg]),
'display': _('All') } 'display': _('All')}
for val in self.lookup_choices: for val in self.lookup_choices:
pk_val = getattr(val, self.field.rel.to.pk.attname) pk_val = getattr(val, self.field.rel.to.pk.attname)
yield { 'selected': self.lookup_val == str(pk_val), yield {'selected': self.lookup_val == str(pk_val),
'query_string': cl.get_query_string( {self.lookup_kwarg: pk_val}), 'query_string': cl.get_query_string( {self.lookup_kwarg: pk_val}),
'display' : val } 'display': val}
FilterSpec.register(lambda f: bool(f.rel), RelatedFilterSpec) FilterSpec.register(lambda f: bool(f.rel), RelatedFilterSpec)
class ChoicesFilterSpec(FilterSpec): class ChoicesFilterSpec(FilterSpec):
@ -74,17 +83,17 @@ class ChoicesFilterSpec(FilterSpec):
self.lookup_val = request.GET.get(self.lookup_kwarg, None) self.lookup_val = request.GET.get(self.lookup_kwarg, None)
def choices(self, cl): def choices(self, cl):
yield {'selected' : self.lookup_val is None, yield {'selected': self.lookup_val is None,
'query_string': cl.get_query_string( {}, [self.lookup_kwarg]), 'query_string': cl.get_query_string( {}, [self.lookup_kwarg]),
'display': _('All') } 'display': _('All')}
for k, v in self.field.choices: for k, v in self.field.choices:
yield {'selected': str(k) == self.lookup_val, yield {'selected': str(k) == self.lookup_val,
'query_string' : cl.get_query_string( {self.lookup_kwarg: k}), 'query_string': cl.get_query_string( {self.lookup_kwarg: k}),
'display' : v } 'display': v}
FilterSpec.register(lambda f: bool(f.choices), ChoicesFilterSpec) FilterSpec.register(lambda f: bool(f.choices), ChoicesFilterSpec)
class DateFieldFilterSpec(FilterSpec): class DateFieldFilterSpec(FilterSpec):
def __init__(self, f, request, params): def __init__(self, f, request, params):
super(DateFieldFilterSpec, self).__init__(f, request, params) super(DateFieldFilterSpec, self).__init__(f, request, params)
@ -113,9 +122,9 @@ class DateFieldFilterSpec(FilterSpec):
def choices(self, cl): def choices(self, cl):
for title, param_dict in self.links: for title, param_dict in self.links:
yield { 'selected' : self.date_params == param_dict, yield {'selected': self.date_params == param_dict,
'query_string' : cl.get_query_string( param_dict, self.field_generic), 'query_string': cl.get_query_string( param_dict, self.field_generic),
'display' : title } 'display': title}
FilterSpec.register(lambda f: isinstance(f, meta.DateField), DateFieldFilterSpec) FilterSpec.register(lambda f: isinstance(f, meta.DateField), DateFieldFilterSpec)
@ -132,14 +141,12 @@ class BooleanFieldFilterSpec(FilterSpec):
def choices(self, cl): def choices(self, cl):
for k, v in ((_('All'), None), (_('Yes'), '1'), (_('No'), '0')): for k, v in ((_('All'), None), (_('Yes'), '1'), (_('No'), '0')):
yield { 'selected' : self.lookup_val == v and not self.lookup_val2, yield {'selected': self.lookup_val == v and not self.lookup_val2,
'query_string' : cl.get_query_string( {self.lookup_kwarg: v}, [self.lookup_kwarg2]), 'query_string': cl.get_query_string( {self.lookup_kwarg: v}, [self.lookup_kwarg2]),
'display': k 'display': k}
}
if isinstance(self.field, meta.NullBooleanField): if isinstance(self.field, meta.NullBooleanField):
yield { 'selected' : self.lookup_val2 == 'True', yield {'selected': self.lookup_val2 == 'True',
'query_string' : cl.get_query_string( {self.lookup_kwarg2: 'True'}, [self.lookup_kwarg]), 'query_string': cl.get_query_string( {self.lookup_kwarg2: 'True'}, [self.lookup_kwarg]),
'display': _('Unknown') 'display': _('Unknown')}
}
FilterSpec.register(lambda f: isinstance(f, meta.BooleanField) or FilterSpec.register(lambda f: isinstance(f, meta.BooleanField) or isinstance(f, meta.NullBooleanField), BooleanFieldFilterSpec)
isinstance(f, meta.NullBooleanField), BooleanFieldFilterSpec)