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

Заметка

Все атрибуты форматирования даты в этих классах миксинов используют символы формата strftime() . Не пытайтесь использовать символы формата тега шаблона, now потому что они несовместимы.

YearMixin

класс YearMixin

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

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

year_format

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

year

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

get_year_format()

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

get_year()

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

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

Выдает ошибку 404, если действительный год не найден.

get_next_year( дата )

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

get_previous_year( дата )

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

MonthMixin

класс MonthMixin

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

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

month_format

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

month

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

get_month_format()

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

get_month()

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

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

Выдает ошибку 404, если не удается найти действительную спецификацию для месяца.

get_next_month( дата )

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

get_previous_month( дата )

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

DayMixin

класс DayMixin

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

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

day_format

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

day

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

get_day_format()

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

get_day()

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

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

Выдает ошибку 404, если не может быть найдено действительной спецификации для дня.

get_next_day( дата )

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

get_previous_day( дата )

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

WeekMixin

класс WeekMixin

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

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

week_format

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

week

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

get_week_format()

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

get_week()

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

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

Выдает ошибку 404, если не может быть найдена действительная спецификация для недели.

get_next_week( дата )

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

get_prev_week( дата )

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

DateMixin

класс 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

класс BaseDateListView

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

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

Классы миксинов

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

allow_empty

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

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

date_list_period

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

get_dated_items()

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

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

get_dated_queryset( ** поиск )

Возвращает набор запросов, отфильтрованный по параметрам запроса, определенным с помощью 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()

Copyright ©2021 All rights reserved