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

YearMixin

class YearMixin [source]

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

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

year_format

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

year

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

get_year_format() [source]

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

get_year() [source]

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

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

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

get_next_year(date) [source]

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

get_previous_year(date) [source]

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

MonthMixin

class MonthMixin [source]

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

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

month_format

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

month

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

get_month_format() [source]

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

get_month() [source]

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

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

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

get_next_month(date) [source]

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

get_previous_month(date) [source]

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

DayMixin

class DayMixin [source]

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

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

day_format

Формат strftime() для парсинга дня. По умолчанию, это '%d'.

day

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

get_day_format() [source]

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

get_day() [source]

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

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

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

get_next_day(date) [source]

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

get_previous_day(date) [source]

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

WeekMixin

class WeekMixin [source]

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

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

week_format

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

week

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

get_week_format() [source]

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

get_week() [source]

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

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

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

get_next_week(date) [source]

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

get_prev_week(date)

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

DateMixin

class DateMixin [source]

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

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

date_field

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

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

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

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

allow_future

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

get_date_field() [source]

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

get_allow_future() [source]

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

BaseDateListView

class BaseDateListView [source]

Базовый класс, обеспечивающий общее поведение для всех представлений, основанных на датах. Обычно нет необходимости создавать экземпляры 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() [source]

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

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

get_dated_queryset(**lookup) [source]

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

get_date_list_period() [source]

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

get_date_list(queryset, date_type=None, ordering='ASC') [source]

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