Changeset 1427

Timestamp:

11/24/05 21:18:11 (3 years ago)

Author:

adrian

Message:

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

Files:

• django/branches/new-admin/django/contrib/admin/filterspecs.py (modified) (5 diffs)

django/branches/new-admin/django/contrib/admin/filterspecs.py

@@ +1 @@
+"""
+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
@@ -7 +15 @@
-        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):
-    
+
-    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(_('<h3>By %s:</h3>\n<ul>\n') % self.title())
-
+
-            for choice in self.choices(cl):
-                t.append('<li%s><a href="%s">%s</a></li>\n' % \
-                    ((choice['selected'] and ' class="selected"' or ''),
- 
-            
+
+
-            t.append('</ul>\n\n')
-        return "".join(t)
-
+
-class RelatedFilterSpec(FilterSpec):
-    def __init__(self, f, request, params):
-    
+
-        if isinstance(f, meta.ManyToManyField):
-            self.lookup_title = f.rel.to.verbose_name
@@ -50 +58 @@
-        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):
-     
-
+
+
-    def choices(self, cl):
-        yield {'selected': self.lookup_val is None,
- 
- 
+
+
-        for val in self.lookup_choices:
-            pk_val = getattr(val, self.field.rel.to.pk.attname)
-
-
-
+
+
+
+
-FilterSpec.register(lambda f: bool(f.rel), RelatedFilterSpec)
-
@@ -73 +82 @@
-        self.lookup_kwarg = '%s__exact' % f.name
-        self.lookup_val = request.GET.get(self.lookup_kwarg, None)
-
+
-    def choices(self, cl):
- : self.lookup_val is None, 
- 
- 
+: self.lookup_val is None,
+
+
-        for k, v in self.field.choices:
-
-
-
+
+
+
+
-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'), {}),
- 
- 
+
+
-                       '%s__day' % self.field.name: str(today.day)}),
- 
+
-                             '%s__lte' % f.name: today_str}),
- 
+
-                             '%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:
- 'selected' : self.date_params == param_dict, 
- 'query_string' 
- 'display' : title 
-
+'selected': self.date_params == param_dict,
+'query_string'
+'display': title
+
-FilterSpec.register(lambda f: isinstance(f, meta.DateField), DateFieldFilterSpec)
-
@@ -127 +136 @@
-        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')):
-
-
-
-
+
+
+
-        if isinstance(self.field, meta.NullBooleanField):
-
-
-
-
-
-
+
+
+
+
+