Основанные на дате миксины

YearMixin

class YearMixin

Миксин, который может использоваться для получения и предоставления информации о разборе компонента года даты.

Методы и атрибуты

year_format

Формат strftime() для использования при разборе года. По умолчанию это '%Y'.

year

Необязательно Значение для года в виде строки. По умолчанию установлено в None, что означает, что год будет определён другими средствами.

get_year_format()

Возвращает формат strftime() для использования при разборе года. По умолчанию возвращает year_format.

get_year()

Возвращает год, для которого этот вид отобразит данные, в виде строки. По очереди пытается получить из:

• Значения атрибута YearMixin.year.
• Значения аргумента year , полученного из шаблона URL.
• Значения аргумента запроса year GET.

Возбуждает исключение 404, если не удаётся найти корректное указание года.

get_next_year(date)

Возвращает объект даты, содержащий первый день года, следующего за указанной датой. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

get_previous_year(date)

Возвращает объект даты, содержащий первый день года, предшествующего указанной дате. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

MonthMixin

class MonthMixin

Миксин, который может использоваться для получения и предоставления информации о разборе компонента месяца даты.

Методы и атрибуты

month_format

Формат strftime() для использования при разборе месяца. По умолчанию это '%b'.

month

Необязательно Значение для месяца в виде строки. По умолчанию установлено в None, что означает, что месяц будет определён другими средствами.

get_month_format()

Возвращает формат strftime() для использования при разборе месяца. По умолчанию возвращает month_format.

get_month()

Возвращает месяц, для которого этот вид отобразит данные, в виде строки. По очереди пытается получить из:

• Значения атрибута MonthMixin.month.
• Значения аргумента month , полученного из шаблона URL.
• Значения аргумента запроса month GET.

Возбуждает исключение 404, если не удаётся найти корректное указание месяца.

get_next_month(date)

Возвращает объект даты, содержащий первый день месяца, следующего за указанной датой. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

get_previous_month(date)

Возвращает объект даты, содержащий первый день месяца, предшествующего указанной дате. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

DayMixin

class DayMixin

Миксин, который можно использовать для извлечения и предоставления информации о разборе компонента дня даты.

Методы и атрибуты

day_format

Формат strftime() для использования при разборе дня. По умолчанию это '%d'.

day

Необязательно Значение дня в виде строки. По умолчанию установлено в None, что означает, что день будет определен другими средствами.

get_day_format()

Возвращает формат strftime() для использования при разборе дня. По умолчанию возвращает day_format.

get_day()

Возвращает день, для которого этот вид отобразит данные, в виде строки. Попытается получить данные из следующих источников в указанном порядке:

• Значение атрибута DayMixin.day.
• Значение аргумента day, полученного из шаблона URL.
• Значение day GET аргумента запроса.

Возбуждает ошибку 404, если не удается найти корректное указание дня.

get_next_day(date)

Возвращает объект даты, содержащий следующий допустимый день после указанной даты. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

get_previous_day(date)

Возвращает объект даты, содержащий предыдущий допустимый день. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

WeekMixin

class WeekMixin

Миксин, который можно использовать для извлечения и предоставления информации о разборе компонента недели даты.

Методы и атрибуты

week_format

Формат strftime() для использования при разборе недели. По умолчанию это '%U', что означает, что неделя начинается с воскресенья. Установите его в '%W' или '%V' (неделя ISO 8601), если ваша неделя начинается с понедельника.

week

Необязательно Значение недели в виде строки. По умолчанию установлено в None, что означает, что неделя будет определена другими средствами.

get_week_format()

Возвращает формат strftime() для использования при разборе недели. По умолчанию возвращает week_format.

get_week()

Возвращает неделю, для которой этот вид отобразит данные, в виде строки. Попытается получить данные из следующих источников в указанном порядке:

• Значение атрибута WeekMixin.week.
• Значение аргумента week, полученного из шаблона URL.
• Значение week GET аргумента запроса.

Возбуждает ошибку 404, если не удается найти корректное указание недели.

get_next_week(date)

Возвращает объект даты, содержащий первый день недели после указанной даты. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

get_prev_week(date)

Возвращает объект даты, содержащий первый день недели до указанной даты. Эта функция также может вернуть None или вызвать исключение Http404, в зависимости от значений allow_empty и allow_future.

DateMixin

class DateMixin

Миксин-класс, предоставляющий общее поведение для всех представлений, основанных на дате.

Методы и атрибуты

date_field

Имя поля DateField или DateTimeField в модели QuerySet, которое должно использоваться для определения списка объектов для отображения на странице.

Когда включена поддержка часовых поясов и date_field — DateTimeField, даты предполагаются в текущем часовом поясе. В противном случае набор запросов может включать объекты из предыдущего или следующего дня в часовом поясе конечного пользователя.

Предупреждение

В этой ситуации, если вы реализовали выбор часового пояса для каждого пользователя, один и тот же URL может отображать различные наборы объектов в зависимости от часового пояса конечного пользователя. Чтобы избежать этого, вы должны использовать DateField в качестве атрибута date_field.

allow_future

Булево значение, определяющее, следует ли включать «будущие» объекты на этой странице, где «будущее» означает объекты, у которых поле, указанное в date_field, больше текущей даты/времени. По умолчанию это False.

get_date_field()

Возвращает имя поля, содержащего данные даты, с которыми будет работать этот вид. По умолчанию возвращает date_field.

get_allow_future()

Определяет, следует ли включать «будущие» объекты на этой странице, где «будущее» означает объекты, у которых поле, указанное в date_field, больше текущей даты/времени. По умолчанию возвращает allow_future.

BaseDateListView

class BaseDateListView

Базовый класс, предоставляющий общее поведение для всех представлений, основанных на датах. Обычно нет необходимости создавать экземпляр BaseDateListView; вместо этого создайте один из подклассов.

Во время выполнения этого представления (и его подклассов) self.object_list будет содержать список объектов, над которыми работает представление, а self.date_list — список дат, для которых доступны данные.

Миксины

• DateMixin
• MultipleObjectMixin

Методы и атрибуты

allow_empty

Булево значение, определяющее, нужно ли отображать страницу, если доступны какие-либо объекты. Если это значение True и объекты отсутствуют, представление отобразит пустую страницу вместо вывода ошибки 404.

Это идентично django.views.generic.list.MultipleObjectMixin.allow_empty, за исключением значения по умолчанию, которое равно False.

date_list_period

Необязательно Строка, определяющая период агрегации для date_list. Она должна быть одной из 'year' (по умолчанию), 'month', или 'day'.

get_dated_items()

Возвращает кортеж из 3 элементов, содержащий (date_list, object_list, extra_context).

date_list — список дат, для которых доступны данные. object_list — список объектов. extra_context — словарь данных контекста, который будет добавлен к любым данным контекста, предоставленным MultipleObjectMixin.

get_dated_queryset(**lookup)

Возвращает набор результатов запроса, отфильтрованный с помощью аргументов запроса, определенных lookup. Обеспечивает соблюдение любых ограничений на набор результатов запроса, таких как allow_empty и allow_future.

get_date_list_period()

Возвращает период агрегации для date_list. По умолчанию возвращает date_list_period.

get_date_list(queryset, date_type=None, ordering='ASC')

Возвращает список дат типа date_type, для которых queryset содержит записи. Например, get_date_list(qs, 'year') вернет список лет, для которых qs содержит записи. Если date_type не указан, используется результат get_date_list_period(). date_type и ordering передаются в QuerySet.dates().