Ticket #3026: newforms_errors.2.patch

django/newforms/forms.py

@@ -24 +24 @@
     __metaclass__ = DeclarativeFieldsMetaclass
 
     def __init__(self, data=None, auto_id=False): # TODO: prefix stuff
+        self.ignore_errors = data is None
         self.data = data or {}
         self.auto_id = auto_id
         self.clean_data = None # Stores the data after clean() has been called.
@@ -44 +45 @@
             raise KeyError('Key %r not found in Form' % name)
         return BoundField(self, field, name)
 
-    def clean(self):
-        if self.__errors is None:
-            self.full_clean()
-        return self.clean_data
-
-    def errors(self):
+    def _errors(self):
         "Returns an ErrorDict for self.data"
         if self.__errors is None:
             self.full_clean()
-        return self.__errors
+        if self.ignore_errors:
+            return ErrorDict()
+        else:
+            return self.__errors
+    errors = property(_errors)
 
     def is_valid(self):
         """
         Returns True if the form has no errors. Otherwise, False. This exists
         solely for convenience, so client code can use positive logic rather
-        than confusing negative logic ("if not form.errors()").
+        than confusing negative logic ("if not form.errors").
         """
-        return not bool(self.errors())
+        return not bool(self.errors)
 
     def as_table(self):
-        "Returns this form rendered as HTML <tr>s -- excluding the <table></table>."
-        return u'\n'.join(['<tr><td>%s:</td><td>%s</td></tr>' % (pretty_name(name), BoundField(self, field, name)) for name, field in self.fields.items()])
-
-    def as_ul(self):
-        "Returns this form rendered as HTML <li>s -- excluding the <ul></ul>."
-        return u'\n'.join(['<li>%s: %s</li>' % (pretty_name(name), BoundField(self, field, name)) for name, field in self.fields.items()])
-
-    def as_table_with_errors(self):
-        "Returns this form rendered as HTML <tr>s, with errors."
+        "Returns this form rendered as HTML <tr>s -- excluding the <table></table>, with errors."
         output = []
-        if self.errors().get(NON_FIELD_ERRORS):
+        if self.errors.get(NON_FIELD_ERRORS):
             # Errors not corresponding to a particular field are displayed at the top.
-            output.append('<tr><td colspan="2"><ul>%s</ul></td></tr>' % '\n'.join(['<li>%s</li>' % e for e in self.errors()[NON_FIELD_ERRORS]]))
+            output.append('<tr><td colspan="2"><ul>%s</ul></td></tr>' % '\n'.join(['<li>%s</li>' % e for e in self.errors[NON_FIELD_ERRORS]]))
         for name, field in self.fields.items():
             bf = BoundField(self, field, name)
             if bf.errors:
@@ -84 +76 @@
             output.append('<tr><td>%s:</td><td>%s</td></tr>' % (pretty_name(name), bf))
         return u'\n'.join(output)
 
-    def as_ul_with_errors(self):
-        "Returns this form rendered as HTML <li>s, with errors."
+    def as_ul(self):
+        "Returns this form rendered as HTML <li>s -- excluding the <ul></ul>, with errors."
         output = []
-        if self.errors().get(NON_FIELD_ERRORS):
+        if self.errors.get(NON_FIELD_ERRORS):
             # Errors not corresponding to a particular field are displayed at the top.
-            output.append('<li><ul>%s</ul></li>' % '\n'.join(['<li>%s</li>' % e for e in self.errors()[NON_FIELD_ERRORS]]))
+            output.append('<li><ul>%s</ul></li>' % '\n'.join(['<li>%s</li>' % e for e in self.errors[NON_FIELD_ERRORS]]))
         for name, field in self.fields.items():
             bf = BoundField(self, field, name)
             line = '<li>'
@@ -149 +141 @@
         if there are none.
         """
         try:
-            return self._form.errors()[self._name]
+            return self._form.errors[self._name]
         except KeyError:
             return ErrorList()
     errors = property(_errors)

tests/regressiontests/forms/tests.py

@@ -879 +879 @@
 ...     first_name = CharField()
 ...     last_name = CharField()
 ...     birthday = DateField()
->>> p = Person()
+>>> p_new = Person()  # Not passed data, so no validation will take place.
+>>> p = Person({})    # Even passing an empty dictionary will cause validation.
+>>> print p_new
+<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>
+<tr><td>Birthday:</td><td><input type="text" name="birthday" /></td></tr>
 >>> print p
+<tr><td colspan="2"><ul><li>This field is required.</li></ul></td></tr>
 <tr><td>First name:</td><td><input type="text" name="first_name" /></td></tr>
+<tr><td colspan="2"><ul><li>This field is required.</li></ul></td></tr>
 <tr><td>Last name:</td><td><input type="text" name="last_name" /></td></tr>
+<tr><td colspan="2"><ul><li>This field is required.</li></ul></td></tr>
 <tr><td>Birthday:</td><td><input type="text" name="birthday" /></td></tr>
->>> print p.as_table()
+
+>>> print p_new.as_table()
 <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>
 <tr><td>Birthday:</td><td><input type="text" name="birthday" /></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>
-<li>Birthday: <input type="text" name="birthday" /></li>
->>> print p.as_table_with_errors()
+>>> print p.as_table()
 <tr><td colspan="2"><ul><li>This field is required.</li></ul></td></tr>
 <tr><td>First name:</td><td><input type="text" name="first_name" /></td></tr>
 <tr><td colspan="2"><ul><li>This field is required.</li></ul></td></tr>
 <tr><td>Last name:</td><td><input type="text" name="last_name" /></td></tr>
 <tr><td colspan="2"><ul><li>This field is required.</li></ul></td></tr>
 <tr><td>Birthday:</td><td><input type="text" name="birthday" /></td></tr>
->>> print p.as_ul_with_errors()
+
+>>> print p_new.as_ul()
+<li>First name: <input type="text" name="first_name" /></li>
+<li>Last name: <input type="text" name="last_name" /></li>
+<li>Birthday: <input type="text" name="birthday" /></li>
+>>> print p.as_ul()
 <li><ul><li>This field is required.</li></ul>First name: <input type="text" name="first_name" /></li>
 <li><ul><li>This field is required.</li></ul>Last name: <input type="text" name="last_name" /></li>
 <li><ul><li>This field is required.</li></ul>Birthday: <input type="text" name="birthday" /></li>
 
 >>> p = Person({'first_name': u'John', 'last_name': u'Lennon', 'birthday': u'1940-10-9'})
->>> p.errors()
+>>> p.errors
 {}
 >>> p.is_valid()
 True
->>> p.errors().as_ul()
+>>> p.errors.as_ul()
 u''
->>> p.errors().as_text()
+>>> p.errors.as_text()
 u''
 >>> p.clean()
 {'first_name': u'John', 'last_name': u'Lennon', 'birthday': datetime.date(1940, 10, 9)}
@@ -932 +942 @@
 <tr><td>Birthday:</td><td><input type="text" name="birthday" value="1940-10-9" /></td></tr>
 
 >>> p = Person({'last_name': u'Lennon'})
->>> p.errors()
+>>> p.errors
 {'first_name': [u'This field is required.'], 'birthday': [u'This field is required.']}
 >>> p.is_valid()
 False
->>> p.errors().as_ul()
+>>> p.errors.as_ul()
 u'<ul class="errorlist"><li>first_name<ul class="errorlist"><li>This field is required.</li></ul></li><li>birthday<ul class="errorlist"><li>This field is required.</li></ul></li></ul>'
->>> print p.errors().as_text()
+>>> print p.errors.as_text()
 * first_name
   * This field is required.
 * birthday
@@ -1109 +1119 @@
 ...        if self.clean_data.get('password1') and self.clean_data.get('password2') and self.clean_data['password1'] != self.clean_data['password2']:
 ...            raise ValidationError(u'Please make sure your passwords match.')
 ...        return self.clean_data['password2']
+
+Forms which are not passed any data will not contain error messages.
 >>> f = UserRegistration()
->>> f.errors()
+>>> f.errors
+{}
+
+If you wish to receive error messages, pass the form an empty dictionary.
+>>> f = UserRegistration({})
+>>> f.errors
 {'username': [u'This field is required.'], 'password1': [u'This field is required.'], 'password2': [u'This field is required.']}
+
 >>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'bar'})
->>> f.errors()
+>>> f.errors
 {'password2': [u'Please make sure your passwords match.']}
 >>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'foo'})
->>> f.errors()
+>>> f.errors
 {}
 >>> f.clean()
 {'username': u'adrian', 'password1': u'foo', 'password2': u'foo'}
@@ -1134 +1152 @@
 ...        if self.clean_data.get('password1') and self.clean_data.get('password2') and self.clean_data['password1'] != self.clean_data['password2']:
 ...            raise ValidationError(u'Please make sure your passwords match.')
 ...        return self.clean_data
->>> f = UserRegistration()
->>> print f.as_table()
-<tr><td>Username:</td><td><input type="text" name="username" /></td></tr>
-<tr><td>Password1:</td><td><input type="password" name="password1" /></td></tr>
-<tr><td>Password2:</td><td><input type="password" name="password2" /></td></tr>
->>> f.errors()
+>>> f = UserRegistration({})
+>>> f.errors
 {'username': [u'This field is required.'], 'password1': [u'This field is required.'], 'password2': [u'This field is required.']}
 >>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'bar'})
->>> f.errors()
+>>> f.errors
 {'__all__': [u'Please make sure your passwords match.']}
 >>> print f.as_table()
-<tr><td>Username:</td><td><input type="text" name="username" value="adrian" /></td></tr>
-<tr><td>Password1:</td><td><input type="password" name="password1" value="foo" /></td></tr>
-<tr><td>Password2:</td><td><input type="password" name="password2" value="bar" /></td></tr>
->>> print f.as_table_with_errors()
 <tr><td colspan="2"><ul><li>Please make sure your passwords match.</li></ul></td></tr>
 <tr><td>Username:</td><td><input type="text" name="username" value="adrian" /></td></tr>
 <tr><td>Password1:</td><td><input type="password" name="password1" value="foo" /></td></tr>
 <tr><td>Password2:</td><td><input type="password" name="password2" value="bar" /></td></tr>
->>> print f.as_ul_with_errors()
+>>> print f.as_ul()
 <li><ul><li>Please make sure your passwords match.</li></ul></li>
 <li>Username: <input type="text" name="username" value="adrian" /></li>
 <li>Password1: <input type="password" name="password1" value="foo" /></li>
 <li>Password2: <input type="password" name="password2" value="bar" /></li>
 >>> f = UserRegistration({'username': 'adrian', 'password1': 'foo', 'password2': 'foo'})
->>> f.errors()
+>>> f.errors
 {}
 >>> f.clean()
 {'username': u'adrian', 'password1': u'foo', 'password2': u'foo'}