class MonthMixin

from django.views.generic.dates import MonthMixin
Hierarchy diagram Documentation Source code
Mixin for views manipulating month-based data.

Attributes

  Defined in
month = None MonthMixin
month_format = '%b' MonthMixin
Expand Collapse

Methods

def _get_current_month(self, date): MonthMixin

Return the start date of the previous interval.
125
126
127
128
129
def _get_current_month(self, date):
    """
    Return the start date of the previous interval.
    """
    return date.replace(day=1)

def get_month(self): MonthMixin

Return the month for which this view should display data.
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
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(_("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.
80
81
82
83
84
85
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_month(self, date): MonthMixin

Return the start date of the next interval.

The interval is defined by start date <= item date < next start date.
114
115
116
117
118
119
120
121
122
def _get_next_month(self, date):
    """
    Return the start date of the next interval.
    The interval is defined by start date <= item date < next start date.
    """
    if date.month == 12:
        return date.replace(year=date.year + 1, month=1, day=1)
    else:
        return date.replace(month=date.month + 1, day=1)

def get_next_month(self, date): MonthMixin

Get the next valid month.
102
103
104
105
106
def get_next_month(self, date):
    """
    Get the next valid month.
    """
    return _get_next_prev(self, date, is_previous=False, period='month')

def get_previous_month(self, date): MonthMixin

Get the previous valid month.
108
109
110
111
112
def get_previous_month(self, date):
    """
    Get the previous valid month.
    """
    return _get_next_prev(self, date, is_previous=True, period='month')