Миксины на основе даты ¶
Примечание
Все атрибуты форматирования даты в этих примерах используют
strftime()
символы формата. Не пытайтесь использовать символы формата из now
тега шаблона, поскольку они несовместимы.
YearMixin
¶
-
класс
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
( дата ) ¶ Возвращает объект даты, содержащий первый день года после указанной даты. Эта функция также может возвращать
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. - Значение
month
GET
аргумента запроса.
Выдает ошибку 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. - Значение
day
GET
аргумента запроса.
Выдает ошибку 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'
или'%V'
(неделя ISO 8601), если ваша неделя начинается в понедельник.Новое в Django 3.2:'%V'
Добавлена поддержка формата недели.
-
week
¶ Необязательно . Значение недели в виде строки. По умолчанию установлено значение
None
, что означает, что неделя будет определяться другими способами.
-
get_week_format
() ¶ Возвращает
strftime()
формат, используемый при анализе недели. Возвратweek_format
по умолчанию.
-
get_week
() ¶ Возвращает неделю, за которую это представление будет отображать данные, в виде строки. Пробует следующие источники по порядку:
- Значение
WeekMixin.week
атрибута. - Значение
week
аргумента, записанное в шаблоне URL. - Значение
week
GET
аргумента запроса.
Выдает ошибку 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
имеет значение aDateTimeField
, предполагается, что даты находятся в текущем часовом поясе. В противном случае набор запросов может включать объекты за предыдущий или следующий день в часовом поясе конечного пользователя.Предупреждение
В этой ситуации, если вы реализовали выбор часового пояса для каждого пользователя, один и тот же 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
() ¶ Возвращает 3-кортеж , содержащий (
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()
-