Ticket #6398: add_default_to_for.3.diff

django/template/defaulttags.py

@@ -84 +84 @@
         return u''
 
 class ForNode(Node):
-    def __init__(self, loopvars, sequence, is_reversed, nodelist_loop):
+    def __init__(self, loopvars, sequence, is_reversed, nodelist_loop, nodelist_default=None):
         self.loopvars, self.sequence = loopvars, sequence
         self.is_reversed = is_reversed
-        self.nodelist_loop = nodelist_loop
+        self.nodelist_loop, self.nodelist_default = nodelist_loop, nodelist_default
 
     def __repr__(self):
         reversed_text = self.is_reversed and ' reversed' or ''
@@ -98 +98 @@
     def __iter__(self):
         for node in self.nodelist_loop:
             yield node
+        for node in self.nodelist_default:
+            yield node
 
     def get_nodes_by_type(self, nodetype):
         nodes = []
         if isinstance(self, nodetype):
             nodes.append(self)
         nodes.extend(self.nodelist_loop.get_nodes_by_type(nodetype))
+        nodes.extend(self.nodelist_default.get_nodes_by_type(nodetype))
         return nodes
 
     def render(self, context):
-        nodelist = NodeList()
         if 'forloop' in context:
             parentloop = context['forloop']
         else:
@@ -122 +124 @@
         if not hasattr(values, '__len__'):
             values = list(values)
         len_values = len(values)
+        if len_values < 1:
+            return self.nodelist_default.render(context)
+        nodelist = NodeList()
         if self.is_reversed:
             values = reversed(values)
         unpack = len(self.loopvars) > 1
@@ -594 +599 @@
             {{ key }}: {{ value }}
         {% endfor %}
 
+    As you can see, the ``for`` tag can take an option ``{% default %}`` clause
+    that will be displayed if the given array is empty or could not be found::
+
+        <ul>
+        {% for athlete in athlete_list %}
+            <li>{{ athlete.name }}</li>
+        {% default %}
+            <li>Sorry, no athlete in this list!</li>
+        {% endfor %}
+        <ul>
+
     The for loop sets a number of variables available within the loop:
 
         ==========================  ================================================
@@ -630 +646 @@
                                       " %s" % token.contents)
 
     sequence = parser.compile_filter(bits[in_index+1])
-    nodelist_loop = parser.parse(('endfor',))
-    parser.delete_first_token()
-    return ForNode(loopvars, sequence, is_reversed, nodelist_loop)
+    nodelist_loop = parser.parse(('default', 'endfor',))
+    token = parser.next_token()
+    if token.contents == 'default':
+        nodelist_default = parser.parse(('endfor',))
+        parser.delete_first_token()
+    else:
+        nodelist_default = NodeList()
+    return ForNode(loopvars, sequence, is_reversed, nodelist_loop, nodelist_default)
 do_for = register.tag("for", do_for)
 
 def do_ifequal(parser, token, negate):

tests/regressiontests/templates/tests.py

@@ -457 +457 @@
             'for-tag-unpack11': ("{% for x,y,z in items %}{{ x }}:{{ y }},{{ z }}/{% endfor %}", {"items": (('one', 1), ('two', 2))}, ("one:1,/two:2,/", "one:1,INVALID/two:2,INVALID/")),
             'for-tag-unpack12': ("{% for x,y,z in items %}{{ x }}:{{ y }},{{ z }}/{% endfor %}", {"items": (('one', 1, 'carrot'), ('two', 2))}, ("one:1,carrot/two:2,/", "one:1,carrot/two:2,INVALID/")),
             'for-tag-unpack13': ("{% for x,y,z in items %}{{ x }}:{{ y }},{{ z }}/{% endfor %}", {"items": (('one', 1, 'carrot'), ('two', 2, 'cheese'))}, ("one:1,carrot/two:2,cheese/", "one:1,carrot/two:2,cheese/")),
+            'for-tag-default01': ("{% for val in values %}{{ val }}{% default %}default text{% endfor %}", {"values": [1, 2, 3]}, "123"),
+            'for-tag-default02': ("{% for val in values %}{{ val }}{% default %}values array empty{% endfor %}", {"values": []}, "values array empty"),
+            'for-tag-default03': ("{% for val in values %}{{ val }}{% default %}values array not found{% endfor %}", {}, "values array not found"),
 
             ### IF TAG ################################################################
             'if-tag01': ("{% if foo %}yes{% else %}no{% endif %}", {"foo": True}, "yes"),

docs/templates.txt

@@ -700 +700 @@
 You can loop over a list in reverse by using ``{% for obj in list reversed %}``.
 
 **New in Django development version**
+
 If you need to loop over a list of lists, you can unpack the values
 in eachs sub-list into a set of known names. For example, if your context contains
 a list of (x,y) coordinates called ``points``, you could use the following
@@ -717 +718 @@
         {{ key }}: {{ value }}
     {% endfor %}
 
+**New in Django development version**
+
+The ``for`` tag can take an optional ``{% default %}`` clause that will be
+displayed if the given array is empty or could not be found::
+
+    <ul>
+    {% for athlete in athlete_list %}
+        <li>{{ athlete.name }}</li>
+    {% default %}
+        <li>Sorry, no athlete in this list!</li>
+    {% endfor %}
+    <ul>
+
 The for loop sets a number of variables available within the loop:
 
     ==========================  ================================================