Миксины на основе дат

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

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

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; вместо него создавайте экземпляр одного из подклассов.

Во время выполнения этого представления (и его подклассов) 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().