Fixed #3101 -- newforms: Form.as_table() no longer puts hidden fields between <tr>s. Thanks for reporting, Eric

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4175 bcc190cf-cafb-0310-a4f2-bffc1f526a37

Author: adrianholovaty

django/newforms/forms.py

@@ -75,20 +75,28 @@ def is_valid(self):
     def as_table(self):
         "Returns this form rendered as HTML <tr>s -- excluding the <table></table>."
         top_errors = self.non_field_errors()
-        output = []
+        output, hidden_fields = [], []
         for name, field in self.fields.items():
             bf = BoundField(self, field, name)
             bf_errors = bf.errors # Cache in local variable.
             if bf.is_hidden:
                 if bf_errors:
                     top_errors.extend(['(Hidden field %s) %s' % (name, e) for e in bf_errors])
-                output.append(str(bf))
+                hidden_fields.append(str(bf))
             else:
                 if bf_errors:
                     output.append(u'<tr><td colspan="2">%s</td></tr>' % bf_errors)
                 output.append(u'<tr><td>%s</td><td>%s</td></tr>' % (bf.label_tag(escape(bf.verbose_name+':')), bf))
         if top_errors:
             output.insert(0, u'<tr><td colspan="2">%s</td></tr>' % top_errors)
+        if hidden_fields: # Insert any hidden fields in the last <td>.
+            str_hidden = u''.join(hidden_fields)
+            if output:
+                last_td = output[-1]
+                # Chop off the trailing '</td></tr>' and insert the hidden fields.
+                output[-1] = last_td[:-10] + str_hidden + '</td></tr>'
+            else: # If there aren't any '<td>'s in the output, just append the hidden fields.
+                output.append(str_hidden)
         return u'\n'.join(output)
 
     def as_ul(self):

tests/regressiontests/forms/tests.py

@@ -1756,7 +1756,8 @@
 
 HiddenInput widgets are displayed differently in the as_table() and as_ul()
 output of a Form -- their verbose names are not displayed, and a separate
-<tr>/<li> is not displayed.
+<tr>/<li> is not displayed. They're displayed in the last <td> of the form,
+directly after that <td>'s form element.
 >>> class Person(Form):
 ...     first_name = CharField()
 ...     last_name = CharField()
@@ -1766,8 +1767,7 @@
 >>> print p
 <tr><td>First name:</td><td><input type="text" name="first_name" /></td></tr>
 <tr><td>Last name:</td><td><input type="text" name="last_name" /></td></tr>
-<input type="hidden" name="hidden_text" />
-<tr><td>Birthday:</td><td><input type="text" name="birthday" /></td></tr>
+<tr><td>Birthday:</td><td><input type="text" name="birthday" /><input type="hidden" name="hidden_text" /></td></tr>
 >>> print p.as_ul()
 <li>First name: <input type="text" name="first_name" /></li>
 <li>Last name: <input type="text" name="last_name" /></li>
@@ -1779,8 +1779,7 @@
 >>> print p
 <tr><td><label for="id_first_name">First name:</label></td><td><input type="text" name="first_name" id="id_first_name" /></td></tr>
 <tr><td><label for="id_last_name">Last name:</label></td><td><input type="text" name="last_name" id="id_last_name" /></td></tr>
-<input type="hidden" name="hidden_text" id="id_hidden_text" />
-<tr><td><label for="id_birthday">Birthday:</label></td><td><input type="text" name="birthday" id="id_birthday" /></td></tr>
+<tr><td><label for="id_birthday">Birthday:</label></td><td><input type="text" name="birthday" id="id_birthday" /><input type="hidden" name="hidden_text" id="id_hidden_text" /></td></tr>
 >>> print p.as_ul()
 <li><label for="id_first_name">First name:</label> <input type="text" name="first_name" id="id_first_name" /></li>
 <li><label for="id_last_name">Last name:</label> <input type="text" name="last_name" id="id_last_name" /></li>
@@ -1796,15 +1795,25 @@
 <tr><td colspan="2"><ul class="errorlist"><li>(Hidden field hidden_text) This field is required.</li></ul></td></tr>
 <tr><td>First name:</td><td><input type="text" name="first_name" value="John" /></td></tr>
 <tr><td>Last name:</td><td><input type="text" name="last_name" value="Lennon" /></td></tr>
-<input type="hidden" name="hidden_text" />
-<tr><td>Birthday:</td><td><input type="text" name="birthday" value="1940-10-9" /></td></tr>
+<tr><td>Birthday:</td><td><input type="text" name="birthday" value="1940-10-9" /><input type="hidden" name="hidden_text" /></td></tr>
 >>> print p.as_ul()
 <li><ul class="errorlist"><li>(Hidden field hidden_text) This field is required.</li></ul></li>
 <li>First name: <input type="text" name="first_name" value="John" /></li>
 <li>Last name: <input type="text" name="last_name" value="Lennon" /></li>
 <input type="hidden" name="hidden_text" />
 <li>Birthday: <input type="text" name="birthday" value="1940-10-9" /></li>
 
+A corner case: It's possible for a form to have only HiddenInputs.
+>>> class TestForm(Form):
+...     foo = CharField(widget=HiddenInput)
+...     bar = CharField(widget=HiddenInput)
+>>> p = TestForm()
+>>> print p.as_table()
+<input type="hidden" name="foo" /><input type="hidden" name="bar" />
+>>> print p.as_ul()
+<input type="hidden" name="foo" />
+<input type="hidden" name="bar" />
+
 A Form's fields are displayed in the same order in which they were defined.
 >>> class TestForm(Form):
 ...     field1 = CharField()