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

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]

A mixin that can be used to retrieve and provide parsing information for a day component of a date.

Methods and Attributes

day_format

The strftime() format to use when parsing the day. By default, this is '%d'.

day

Optional The value for the day, as a string. By default, set to None, which means the day will be determined using other means.

get_day_format() [source]

Returns the strftime() format to use when parsing the day. Returns day_format by default.

get_day() [source]

Returns the day for which this view will display data, as a string. Tries the following sources, in order:

• The value of the DayMixin.day attribute.
• The value of the day argument captured in the URL pattern.
• The value of the day GET query argument.

Raises a 404 if no valid day specification can be found.

get_next_day(date) [source]

Returns a date object containing the next valid day after the date provided. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and allow_future.

get_previous_day(date) [source]

Returns a date object containing the previous valid day. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and allow_future.

WeekMixin

class WeekMixin [source]

A mixin that can be used to retrieve and provide parsing information for a week component of a date.

Methods and Attributes

week_format

The strftime() format to use when parsing the week. By default, this is '%U', which means the week starts on Sunday. Set it to '%W' if your week starts on Monday.

week

Optional The value for the week, as a string. By default, set to None, which means the week will be determined using other means.

get_week_format() [source]

Returns the strftime() format to use when parsing the week. Returns week_format by default.

get_week() [source]

Returns the week for which this view will display data, as a string. Tries the following sources, in order:

• The value of the WeekMixin.week attribute.
• The value of the week argument captured in the URL pattern
• The value of the week GET query argument.

Raises a 404 if no valid week specification can be found.

get_next_week(date) [source]

Returns a date object containing the first day of the week after the date provided. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and allow_future.

get_prev_week(date)

Returns a date object containing the first day of the week before the date provided. This function can also return None or raise an Http404 exception, depending on the values of allow_empty and 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().