通用日期视图

    注解

    本页的一些例子假定 Article 模型已在 myapp/models.py 中定义如下:

    class ArchiveIndexView

    一个按日期显示“最新”对象的顶层索引页。除非你将 allow_future 设置为 True,否则不包含日期在 未来 的对象。

    祖先(MRO)

    上下文

    除了 django.views.generic.list.MultipleObjectMixin (通过 )提供的上下文外,模板的上下文将是:

    • date_list:一个 QuerySet 对象,包含根据 queryset 有对象可用的所有年份,以 对象表示,按降序排列。

    注意

    • 使用默认为 latestcontext_object_name
    • 使用默认为 _archivetemplate_name_suffix
    • 默认情况下,按年提供 date_list,但可以使用 date_list_period 属性将其改为月或日。这也适用于所有子类视图。

    示例 myapp/urls.py

    1. from django.urls import path
    2. from django.views.generic.dates import ArchiveIndexView
    3. from myapp.models import Article
    4. urlpatterns = [
    5. path('archive/',
    6. ArchiveIndexView.as_view(model=Article, date_field="pub_date"),
    7. name="article_archive"),
    8. ]

    示例 myapp/article_archive.html

    1. <ul>
    2. {% for article in latest %}
    3. <li>{{ article.pub_date }}: {{ article.title }}</li>
    4. {% endfor %}
    5. </ul>

    这将输出所有文章。

    YearArchiveView

    class YearArchiveView

    每年的存档页,显示某一年的所有可用月份。除非你把 allow_future 设置为 True,否则不显示日期在 未来 的对象。

    祖先(MRO)

    上下文

    除了 (通过 django.views.generic.dates.BaseDateListView)提供的上下文外,模板的上下文将是:

    • date_list。一个 对象,包含根据 queryset 有对象可用的所有月份,以 datetime.datetime 对象表示,按升序排列。
    • year:一个 对象,代表特定年份。
    • next_year: 一个:class:~datetime.date 对象,根据 allow_empty 和 ,表示下一年的第一天。
    • previous_year: 一个 date 对象,根据 和 allow_future,表示前一年的第一天。

    注意

    • 使用默认为 _archive_yeartemplate_name_suffix

    示例 myapp/views.py

    1. from django.views.generic.dates import YearArchiveView
    2. from myapp.models import Article
    3. class ArticleYearArchiveView(YearArchiveView):
    4. queryset = Article.objects.all()
    5. date_field = "pub_date"
    6. make_object_list = True
    7. allow_future = True

    示例 myapp/urls.py

    1. from django.urls import path
    2. from myapp.views import ArticleYearArchiveView
    3. urlpatterns = [
    4. path('<int:year>/',
    5. ArticleYearArchiveView.as_view(),
    6. name="article_year_archive"),
    7. ]

    示例 myapp/article_archive_year.html

    1. <ul>
    2. {% for date in date_list %}
    3. <li>{{ date|date }}</li>
    4. {% endfor %}
    5. </ul>
    6. <div>
    7. <h1>All Articles for {{ year|date:"Y" }}</h1>
    8. {% for obj in object_list %}
    9. <p>
    10. {{ obj.title }} - {{ obj.pub_date|date:"F j, Y" }}
    11. </p>
    12. {% endfor %}
    13. </div>

    class MonthArchiveView

    每月的存档页,显示特定月份的所有对象。除非你把 allow_future 设置为 True,否则不显示日期在 未来 的对象。

    上下文

    除了 (通过 BaseDateListView)提供的上下文外,模板的上下文将是:

    • :一个 对象,根据 queryset,以 datetime.datetime 对象的形式表示,按升序排列,包含给定月份内有对象可用的所有日子。
    • month:一个 对象,代表指定月份。
    • next_month: 一个 date 对象,根据 和 allow_future,表示下个月的第一天。
    • previous_month: 一个 对象,根据 allow_empty 和 ,表示前一个月的第一天。

    注意

    • 使用默认为 _archive_monthtemplate_name_suffix

    示例 myapp/views.py

    示例 myapp/urls.py

    1. from django.urls import path
    2. from myapp.views import ArticleMonthArchiveView
    3. urlpatterns = [
    4. # Example: /2012/08/
    5. path('<int:year>/<int:month>/',
    6. ArticleMonthArchiveView.as_view(month_format='%m'),
    7. name="archive_month_numeric"),
    8. # Example: /2012/aug/
    9. path('<int:year>/<str:month>/',
    10. ArticleMonthArchiveView.as_view(),
    11. name="archive_month"),
    12. ]

    示例 myapp/article_archive_month.html

    1. <ul>
    2. {% for article in object_list %}
    3. <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li>
    4. {% endfor %}
    5. </ul>
    6. <p>
    7. {% if previous_month %}
    8. Previous Month: {{ previous_month|date:"F Y" }}
    9. {% endif %}
    10. {% if next_month %}
    11. Next Month: {{ next_month|date:"F Y" }}
    12. {% endif %}
    13. </p>

    WeekArchiveView

    class WeekArchiveView

    每周的档案页,显示某一周的所有对象。除非你将 allow_future 设置为 True,否则不显示日期在 未来 的对象。

    祖先(MRO)

    上下文

    除了 (通过 BaseDateListView)提供的上下文外,模板的上下文将是:

    • week:一个 对象,表示指定星期的第一天。
    • next_week:一个 date 对象,根据 和 allow_future,表示下周的第一天。
    • previous_week:一个 对象,根据 allow_empty 和 ,表示前一周的第一天。

    注意

    • 使用默认为 _archive_weektemplate_name_suffix

    • week_format 属性是一个 strptime() 格式字符串,用于解析星期数。支持的值如下:

      • '%U':根据美国的周制,一周从周日开始。这是默认值。

      • '%W':与 '%U' 类似,但它假定一周从星期一开始。这与 ISO 8601 周号不同。

      • '%V': ISO 8601 week number where the week begins on Monday.

        New in Django Development version:

        Support for the '%V' week format was added.

    示例 myapp/views.py

    1. from django.views.generic.dates import WeekArchiveView
    2. from myapp.models import Article
    3. class ArticleWeekArchiveView(WeekArchiveView):
    4. queryset = Article.objects.all()
    5. date_field = "pub_date"
    6. week_format = "%W"
    7. allow_future = True

    示例 myapp/urls.py

    1. from django.urls import path
    2. from myapp.views import ArticleWeekArchiveView
    3. urlpatterns = [
    4. # Example: /2012/week/23/
    5. path('<int:year>/week/<int:week>/',
    6. ArticleWeekArchiveView.as_view(),
    7. name="archive_week"),
    8. ]

    示例 myapp/article_archive_week.html

    1. <h1>Week {{ week|date:'W' }}</h1>
    2. <ul>
    3. {% for article in object_list %}
    4. <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li>
    5. {% endfor %}
    6. </ul>
    7. <p>
    8. {% if previous_week %}
    9. Previous Week: {{ previous_week|date:"W" }} of year {{ previous_week|date:"Y" }}
    10. {% endif %}
    11. {% if previous_week and next_week %}--{% endif %}
    12. {% if next_week %}
    13. Next week: {{ next_week|date:"W" }} of year {{ next_week|date:"Y" }}
    14. {% endif %}
    15. </p>

    在这个例子中,你输出的是周数。请记住,由 模板过滤器用 ‘`W’` 格式字符计算的星期数与 strftime() 和 用 '%W' 格式字符串计算的星期数并不总是相同的。例如,对于 2015 年, date 输出的周数比 输出的周数高 1。date 中的 '%U' 格式字符串没有等价物。因此,你应该避免使用 dateWeekArchiveView 生成 URL。

    class DayArchiveView

    一个显示某一天所有对象的日存档页面。未来的日子会抛出 404 错误,不管未来的日子是否有任何对象存在,除非你把 allow_future 设置为 True

    祖先(MRO)

    上下文

    • day:一个 date 对象,代表指定的一天。
    • next_day:一个 对象,根据 allow_empty 和 表示第二天。
    • previous_day:一个 date 对象,根据 和 allow_future 表示前一天。
    • next_month: 一个 对象,根据 allow_empty 和 ,表示下个月的第一天。
    • previous_month: 一个 date 对象,根据 和 allow_future,表示前一个月的第一天。

    注意

    • 使用默认为 _archive_daytemplate_name_suffix

    示例 myapp/views.py

    示例 myapp/urls.py

    1. from django.urls import path
    2. from myapp.views import ArticleDayArchiveView
    3. urlpatterns = [
    4. # Example: /2012/nov/10/
    5. path('<int:year>/<str:month>/<int:day>/',
    6. ArticleDayArchiveView.as_view(),
    7. name="archive_day"),
    8. ]

    示例 myapp/article_archive_day.html

    1. <h1>{{ day }}</h1>
    2. <ul>
    3. {% for article in object_list %}
    4. <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li>
    5. {% endfor %}
    6. </ul>
    7. <p>
    8. {% if previous_day %}
    9. Previous Day: {{ previous_day }}
    10. {% endif %}
    11. {% if previous_day and next_day %}--{% endif %}
    12. {% if next_day %}
    13. Next Day: {{ next_day }}
    14. {% endif %}
    15. </p>

    TodayArchiveView

    class TodayArchiveView

    一个显示 今天 所有对象的日存档页面。这和 完全一样,只是用今天的日期代替 yearmonthday 参数。

    祖先(MRO)

    注意

    • 使用默认为 _archive_todaytemplate_name_suffix

    示例 myapp/views.py

    1. from django.views.generic.dates import TodayArchiveView
    2. from myapp.models import Article
    3. class ArticleTodayArchiveView(TodayArchiveView):
    4. queryset = Article.objects.all()
    5. date_field = "pub_date"
    6. allow_future = True

    示例 myapp/urls.py

    1. from django.urls import path
    2. from myapp.views import ArticleTodayArchiveView
    3. urlpatterns = [
    4. path('today/',
    5. ArticleTodayArchiveView.as_view(),
    6. name="archive_today"),
    7. ]

    TodayArchiveView 的示例模板在哪里?

    该视图默认使用与前面例子中的 相同的模板。如果你需要一个不同的模板,请将 template_name 属性设置为新模板的名称。

    class DateDetailView

    一个页面代表一个单独的对象。如果对象有一个未来的日期值,除非你把 allow_future 设置为 True,否则视图会默认抛出 404 错误。

    祖先(MRO)

    上下文

    • 包括与 DateDetailView 中指定的 model 相关的单个对象。

    注意

    • 使用默认为 _detailtemplate_name_suffix

    示例 myapp/urls.py

    1. from django.urls import path
    2. from django.views.generic.dates import DateDetailView
    3. urlpatterns = [
    4. path('<int:year>/<str:month>/<int:day>/<int:pk>/',
    5. DateDetailView.as_view(model=Article, date_field="pub_date"),
    6. name="archive_date_detail"),

    示例 myapp/article_detail.html

    注解

    上面列出的所有通用视图都有匹配的 Base 视图,唯一不同的是它们不包括 MultipleObjectTemplateResponseMixin)用于存档视图)或 (用于 DateDetailView)。

    class BaseArchiveIndexView

    class BaseYearArchiveView

    class BaseMonthArchiveView

    class BaseWeekArchiveView

    class BaseDayArchiveView

    class