Changeset 3039

Timestamp:

05/31/06 23:21:26 (2 years ago)

Author:

adrian

Message:

Fixed #697 -- Added make_object_list parameter to archive_year generic view. Thanks, jhf@hex.no

Files:

• django/trunk/django/views/generic/date_based.py (modified) (4 diffs)
• django/trunk/docs/generic_views.txt (modified) (2 diffs)

django/trunk/django/views/generic/date_based.py

@@ -46 +46 @@
-def archive_year(request, year, queryset, date_field, template_name=None,
-        template_loader=loader, extra_context={}, allow_empty=False,
-
+
+
-    """
-    Generic yearly archive view.
@@ -56 +57 @@
-        year
-            This year
+        object_list
+            List of objects published in the given month
+            (Only available if make_object_list argument is True)
-    """
-    model = queryset.model
@@ -68 +72 @@
-    if not date_list and not allow_empty:
-        raise Http404
+    if make_object_list:
+        object_list = queryset.filter(**lookup_kwargs).order_by(date_field)
+    else:
+        object_list = []
-    if not template_name:
-        template_name = "%s/%s_archive_year.html" % (model._meta.app_label, model._meta.object_name.lower())
@@ -74 +82 @@
-        'date_list': date_list,
-        'year': year,
+        '%s_list' % template_object_name: object_list,
-    }, context_processors)
-    for key, value in extra_context.items():

django/trunk/docs/generic_views.txt

@@ -251 +251 @@
-      the view's template. See the `RequestContext docs`_.
-
+    * ``template_object_name``:  Designates the name of the template variable
+       to use in the template context. By default, this is ``'object'``. The
+       view will append ``'_list'`` to the value of this parameter in
+       determining the variable's name.
+
+    * ``make_object_list``: A boolean specifying whether to retrieve the full
+      list of objects for this year and pass those to the template. If ``True``,
+      this list of objects will be made available to the template as
+      ``object_list``. (The name ``object_list`` may be different; see the docs
+      for ``object_list`` in the "Template context" section below.) By default,
+      this is ``False``.
+
-    * ``mimetype``: The MIME type to use for the resulting document. Defaults
-      to the value of the ``DEFAULT_MIME_TYPE`` setting.
@@ -266 +278 @@
-      months that have objects available in the given year, according to
-      ``queryset``, in ascending order.
+
-    * ``year``: The given year, as a four-character string.
+
+    * ``object_list``: If the ``make_object_list`` parameter is ``True``, this
+      will be set to a list of objects available for the given year, ordered by
+      the date field. This variable's name depends on the
+      ``template_object_name`` parameter, which is ``'object'`` by default. If
+      ``template_object_name`` is ``'foo'``, this variable's name will be
+      ``foo_list``.
+
+      If ``make_object_list`` is ``False``, ``object_list`` will be passed to
+      the template as an empty list.
-
-``django.views.generic.date_based.archive_month``