class BaseTodayArchiveView

from django.views.generic.dates import BaseTodayArchiveView
List of objects published today.

Attributes

  Defined in
allow_empty = False BaseDateListView
allow_empty = True MultipleObjectMixin
allow_future = False DateMixin
context_object_name = None MultipleObjectMixin
date_field = None DateMixin
day = None DayMixin
day_format = '%d' DayMixin
http_method_names = ['get', 'post', 'put', 'delete', 'head', 'options', 'trace'] View
model = None MultipleObjectMixin
month = None MonthMixin
month_format = '%b' MonthMixin
paginate_by = None MultipleObjectMixin
paginator_class = <class 'django.core.paginator.Paginator'> MultipleObjectMixin
queryset = None MultipleObjectMixin
year = None YearMixin
year_format = '%Y' YearMixin
Expand Collapse

Methods

def __init__(self, **kwargs): View

Constructor. Called in the URLconf; can contain helpful extra
keyword arguments, and other things.
19
20
21
22
23
24
25
26
27
def __init__(self, **kwargs):
    """
    Constructor. Called in the URLconf; can contain helpful extra
    keyword arguments, and other things.
    """
    # Go through keyword arguments, and either save their values to our
    # instance, or raise an error.
    for key, value in kwargs.iteritems():
        setattr(self, key, value)

def _get_dated_items(self, date): BaseDayArchiveView

Do the actual heavy lifting of getting the dated items; this accepts a
date object so that TodayArchiveView can be trivial.
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
def _get_dated_items(self, date):
    """
    Do the actual heavy lifting of getting the dated items; this accepts a
    date object so that TodayArchiveView can be trivial.
    """
    date_field = self.get_date_field()
    field = self.get_queryset().model._meta.get_field(date_field)
    lookup_kwargs = _date_lookup_for_field(field, date)
    qs = self.get_dated_queryset(**lookup_kwargs)
    return (None, qs, {
        'day': date,
        'previous_day': self.get_previous_day(date),
        'next_day': self.get_next_day(date),
        'previous_month': self.get_previous_month(date),
        'next_month': self.get_next_month(date)
    })

def as_view(cls, **initkwargs): View

Main entry point for a request-response process.
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
@classonlymethod
def as_view(cls, **initkwargs):
    """
    Main entry point for a request-response process.
    """
    # sanitize keyword arguments
    for key in initkwargs:
        if key in cls.http_method_names:
            raise TypeError(u"You tried to pass in the %s method name as a "
                            u"keyword argument to %s(). Don't do that."
                            % (key, cls.__name__))
        if not hasattr(cls, key):
            raise TypeError(u"%s() received an invalid keyword %r" % (
                cls.__name__, key))
    def view(request, *args, **kwargs):
        self = cls(**initkwargs)
        if hasattr(self, 'get') and not hasattr(self, 'head'):
            self.head = self.get
        return self.dispatch(request, *args, **kwargs)
    # take name and docstring from class
    update_wrapper(view, cls, updated=())
    # and possible attributes set by decorators
    # like csrf_exempt from dispatch
    update_wrapper(view, cls.dispatch, assigned=())
    return view

def dispatch(self, request, *args, **kwargs): View

58
59
60
61
62
63
64
65
66
67
68
69
def dispatch(self, request, *args, **kwargs):
    # Try to dispatch to the right method; if a method doesn't exist,
    # defer to the error handler. Also defer to the error handler if the
    # request method isn't on the approved list.
    if request.method.lower() in self.http_method_names:
        handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
    else:
        handler = self.http_method_not_allowed
    self.request = request
    self.args = args
    self.kwargs = kwargs
    return handler(request, *args, **kwargs)

def get(self, request, *args, **kwargs): BaseDateListView

171
172
173
174
175
176
def get(self, request, *args, **kwargs):
    self.date_list, self.object_list, extra_context = self.get_dated_items()
    context = self.get_context_data(object_list=self.object_list,
                                    date_list=self.date_list)
    context.update(extra_context)
    return self.render_to_response(context)

def get_allow_empty(self): MultipleObjectMixin

Returns ``True`` if the view should display empty lists, and ``False``
if a 404 should be raised instead.
66
67
68
69
70
71
def get_allow_empty(self):
    """
    Returns ``True`` if the view should display empty lists, and ``False``
    if a 404 should be raised instead.
    """
    return self.allow_empty

def get_allow_future(self): DateMixin

Returns `True` if the view should be allowed to display objects from
the future.
157
158
159
160
161
162
def get_allow_future(self):
    """
    Returns `True` if the view should be allowed to display objects from
    the future.
    """
    return self.allow_future

def get_context_data(self, **kwargs):

BaseDateListView

Get the context. Must return a Context (or subclass) instance.
220
221
222
223
224
225
226
227
def get_context_data(self, **kwargs):
    """
    Get the context. Must return a Context (or subclass) instance.
    """
    items = kwargs.pop('object_list')
    context = super(BaseDateListView, self).get_context_data(object_list=items)
    context.update(kwargs)
    return context

MultipleObjectMixin

Get the context for this view.
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def get_context_data(self, **kwargs):
    """
    Get the context for this view.
    """
    queryset = kwargs.pop('object_list')
    page_size = self.get_paginate_by(queryset)
    context_object_name = self.get_context_object_name(queryset)
    if page_size:
        paginator, page, queryset, is_paginated = self.paginate_queryset(queryset, page_size)
        context = {
            'paginator': paginator,
            'page_obj': page,
            'is_paginated': is_paginated,
            'object_list': queryset
        }
    else:
        context = {
            'paginator': None,
            'page_obj': None,
            'is_paginated': False,
            'object_list': queryset
        }
    context.update(kwargs)
    if context_object_name is not None:
        context[context_object_name] = queryset
    return context

def get_context_object_name(self, object_list): MultipleObjectMixin

Get the name of the item to be used in the context.
73
74
75
76
77
78
79
80
81
82
def get_context_object_name(self, object_list):
    """
    Get the name of the item to be used in the context.
    """
    if self.context_object_name:
        return self.context_object_name
    elif hasattr(object_list, 'model'):
        return smart_str('%s_list' % object_list.model._meta.object_name.lower())
    else:
        return None

def get_date_field(self): DateMixin

Get the name of the date field to be used to filter by.
149
150
151
152
153
154
155
def get_date_field(self):
    """
    Get the name of the date field to be used to filter by.
    """
    if self.date_field is None:
        raise ImproperlyConfigured(u"%s.date_field is required." % self.__class__.__name__)
    return self.date_field

def get_date_list(self, queryset, date_type): BaseDateListView

Get a date list by calling `queryset.dates()`, checking along the way
for empty lists that aren't allowed.
204
205
206
207
208
209
210
211
212
213
214
215
216
def get_date_list(self, queryset, date_type):
    """
    Get a date list by calling `queryset.dates()`, checking along the way
    for empty lists that aren't allowed.
    """
    date_field = self.get_date_field()
    allow_empty = self.get_allow_empty()
    date_list = queryset.dates(date_field, date_type)[::-1]
    if date_list is not None and not date_list and not allow_empty:
        name = force_unicode(queryset.model._meta.verbose_name_plural)
        raise Http404(_(u"No %(verbose_name_plural)s available") %
                      {'verbose_name_plural': name})
    return date_list

def get_dated_items(self):

BaseTodayArchiveView

Return (date_list, items, extra_context) for this request.
433
434
435
436
437
def get_dated_items(self):
    """
    Return (date_list, items, extra_context) for this request.
    """
    return self._get_dated_items(datetime.date.today())

BaseDayArchiveView

Return (date_list, items, extra_context) for this request.
386
387
388
389
390
391
392
393
394
395
396
def get_dated_items(self):
    """
    Return (date_list, items, extra_context) for this request.
    """
    year = self.get_year()
    month = self.get_month()
    day = self.get_day()
    date = _date_from_string(year, self.get_year_format(),
                             month, self.get_month_format(),
                             day, self.get_day_format())
    return self._get_dated_items(date)

BaseDateListView

Obtain the list of dates and itesm
178
179
180
181
182
def get_dated_items(self):
    """
    Obtain the list of dates and itesm
    """
    raise NotImplementedError('A DateView must provide an implementation of get_dated_items()')

def get_dated_queryset(self, **lookup): BaseDateListView

Get a queryset properly filtered according to `allow_future` and any
extra lookup kwargs.
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def get_dated_queryset(self, **lookup):
    """
    Get a queryset properly filtered according to `allow_future` and any
    extra lookup kwargs.
    """
    qs = self.get_queryset().filter(**lookup)
    date_field = self.get_date_field()
    allow_future = self.get_allow_future()
    allow_empty = self.get_allow_empty()
    if not allow_future:
        qs = qs.filter(**{'%s__lte' % date_field: timezone.now()})
    if not allow_empty and not qs:
        raise Http404(_(u"No %(verbose_name_plural)s available") % {
                'verbose_name_plural': force_unicode(qs.model._meta.verbose_name_plural)
        })
    return qs

def get_day(self): DayMixin

Return the day for which this view should display data
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def get_day(self):
    "Return the day for which this view should display data"
    day = self.day
    if day is None:
        try:
            day = self.kwargs['day']
        except KeyError:
            try:
                day = self.request.GET['day']
            except KeyError:
                raise Http404(_(u"No day specified"))
    return day

def get_day_format(self): DayMixin

Get a day format string in strptime syntax to be used to parse the day
from url variables.
82
83
84
85
86
87
def get_day_format(self):
    """
    Get a day format string in strptime syntax to be used to parse the day
    from url variables.
    """
    return self.day_format

def get_month(self): MonthMixin

Return the month for which this view should display data
48
49
50
51
52
53
54
55
56
57
58
59
def get_month(self):
    "Return the month for which this view should display data"
    month = self.month
    if month is None:
        try:
            month = self.kwargs['month']
        except KeyError:
            try:
                month = self.request.GET['month']
            except KeyError:
                raise Http404(_(u"No month specified"))
    return month

def get_month_format(self): MonthMixin

Get a month format string in strptime syntax to be used to parse the
month from url variables.
41
42
43
44
45
46
def get_month_format(self):
    """
    Get a month format string in strptime syntax to be used to parse the
    month from url variables.
    """
    return self.month_format

def get_next_day(self, date): DayMixin

Get the next valid day.
102
103
104
105
106
107
def get_next_day(self, date):
    """
    Get the next valid day.
    """
    next = date + datetime.timedelta(days=1)
    return _get_next_prev_month(self, next, is_previous=False, use_first_day=False)

def get_next_month(self, date): MonthMixin

Get the next valid month.
61
62
63
64
65
66
67
def get_next_month(self, date):
    """
    Get the next valid month.
    """
    first_day, last_day = _month_bounds(date)
    next = (last_day + datetime.timedelta(days=1)).replace(day=1)
    return _get_next_prev_month(self, next, is_previous=False, use_first_day=True)

def get_paginate_by(self, queryset): MultipleObjectMixin

Get the number of items to paginate by, or ``None`` for no pagination.
54
55
56
57
58
def get_paginate_by(self, queryset):
    """
    Get the number of items to paginate by, or ``None`` for no pagination.
    """
    return self.paginate_by

def get_paginator(self, queryset, per_page, orphans=0, allow_empty_first_page=True): MultipleObjectMixin

Return an instance of the paginator for this view.
60
61
62
63
64
def get_paginator(self, queryset, per_page, orphans=0, allow_empty_first_page=True):
    """
    Return an instance of the paginator for this view.
    """
    return self.paginator_class(queryset, per_page, orphans=orphans, allow_empty_first_page=allow_empty_first_page)

def get_previous_day(self, date): DayMixin

Get the previous valid day.
109
110
111
112
113
114
def get_previous_day(self, date):
    """
    Get the previous valid day.
    """
    prev = date - datetime.timedelta(days=1)
    return _get_next_prev_month(self, prev, is_previous=True, use_first_day=False)

def get_previous_month(self, date): MonthMixin

Get the previous valid month.
69
70
71
72
73
74
75
def get_previous_month(self, date):
    """
    Get the previous valid month.
    """
    first_day, last_day = _month_bounds(date)
    prev = (first_day - datetime.timedelta(days=1))
    return _get_next_prev_month(self, prev, is_previous=True, use_first_day=True)

def get_queryset(self): MultipleObjectMixin

Get the list of items for this view. This must be an interable, and may
be a queryset (in which qs-specific behavior will be enabled).
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def get_queryset(self):
    """
    Get the list of items for this view. This must be an interable, and may
    be a queryset (in which qs-specific behavior will be enabled).
    """
    if self.queryset is not None:
        queryset = self.queryset
        if hasattr(queryset, '_clone'):
            queryset = queryset._clone()
    elif self.model is not None:
        queryset = self.model._default_manager.all()
    else:
        raise ImproperlyConfigured(u"'%s' must define 'queryset' or 'model'"
                                   % self.__class__.__name__)
    return queryset

def get_year(self): YearMixin

Return the year for which this view should display data
23
24
25
26
27
28
29
30
31
32
33
34
def get_year(self):
    "Return the year for which this view should display data"
    year = self.year
    if year is None:
        try:
            year = self.kwargs['year']
        except KeyError:
            try:
                year = self.request.GET['year']
            except KeyError:
                raise Http404(_(u"No year specified"))
    return year

def get_year_format(self): YearMixin

Get a year format string in strptime syntax to be used to parse the
year from url variables.
16
17
18
19
20
21
def get_year_format(self):
    """
    Get a year format string in strptime syntax to be used to parse the
    year from url variables.
    """
    return self.year_format

def http_method_not_allowed(self, request, *args, **kwargs): View

71
72
73
74
75
76
77
78
79
def http_method_not_allowed(self, request, *args, **kwargs):
    allowed_methods = [m for m in self.http_method_names if hasattr(self, m)]
    logger.warning('Method Not Allowed (%s): %s', request.method, request.path,
        extra={
            'status_code': 405,
            'request': self.request
        }
    )
    return http.HttpResponseNotAllowed(allowed_methods)

def paginate_queryset(self, queryset, page_size): MultipleObjectMixin

Paginate the queryset, if needed.
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def paginate_queryset(self, queryset, page_size):
    """
    Paginate the queryset, if needed.
    """
    paginator = self.get_paginator(queryset, page_size, allow_empty_first_page=self.get_allow_empty())
    page = self.kwargs.get('page') or self.request.GET.get('page') or 1
    try:
        page_number = int(page)
    except ValueError:
        if page == 'last':
            page_number = paginator.num_pages
        else:
            raise Http404(_(u"Page is not 'last', nor can it be converted to an int."))
    try:
        page = paginator.page(page_number)
        return (paginator, page, page.object_list, page.has_other_pages())
    except InvalidPage:
        raise Http404(_(u'Invalid page (%(page_number)s)') % {
                            'page_number': page_number
        })