Fixed #17413 -- Serialization of form errors along with all metadata.

django/forms/utils.py

@@ -1,5 +1,7 @@
 from __future__ import unicode_literals
 
+import json
+import sys
 import warnings
 
 from django.conf import settings
@@ -8,12 +10,16 @@ from django.utils.encoding import force_text, python_2_unicode_compatible
 from django.utils import timezone
 from django.utils.translation import ugettext_lazy as _
 from django.utils import six
-import sys
 
 # Import ValidationError so that it can be imported from this
 # module to maintain backwards compatibility.
 from django.core.exceptions import ValidationError
 
+try:
+    from collections import UserList
+except ImportError:  # Python 2
+    from UserList import UserList
+
 
 def flatatt(attrs):
     """
@@ -46,8 +52,12 @@ class ErrorDict(dict):
 
     The dictionary keys are the field names, and the values are the errors.
     """
-    def __str__(self):
-        return self.as_ul()
+    def as_data(self):
+        return {f: e.as_data() for f, e in self.items()}
+
+    def as_json(self):
+        errors = {f: json.loads(e.as_json()) for f, e in self.items()}
+        return json.dumps(errors)
 
     def as_ul(self):
         if not self:
@@ -58,19 +68,35 @@ class ErrorDict(dict):
         )
 
     def as_text(self):
-        return '\n'.join('* %s\n%s' % (k, '\n'.join('  * %s' % force_text(i) for i in v)) for k, v in self.items())
+        output = []
+        for field, errors in self.items():
+            output.append('* %s' % field)
+            output.append('\n'.join('  * %s' % e for e in errors))
+        return '\n'.join(output)
 
-
-@python_2_unicode_compatible
-class ErrorList(list):
-    """
-    A collection of errors that knows how to display itself in various formats.
-    """
     def __str__(self):
         return self.as_ul()
 
+
+@python_2_unicode_compatible
+class ErrorList(UserList):
+    """
+    A collection of errors that knows how to display itself in various formats.
+    """
+    def as_data(self):
+        return self.data
+
+    def as_json(self):
+        errors = []
+        for error in ValidationError(self.data).error_list:
+            errors.append({
+                'message': list(error)[0],
+                'code': error.code or '',
+            })
+        return json.dumps(errors)
+
     def as_ul(self):
-        if not self:
+        if not self.data:
             return ''
         return format_html(
             '<ul class="errorlist">{0}</ul>',
@@ -78,12 +104,28 @@ class ErrorList(list):
         )
 
     def as_text(self):
-        if not self:
-            return ''
-        return '\n'.join('* %s' % force_text(e) for e in self)
+        return '\n'.join('* %s' % e for e in self)
+
+    def __str__(self):
+        return self.as_ul()
 
     def __repr__(self):
-        return repr([force_text(e) for e in self])
+        return repr(list(self))
+
+    def __contains__(self, item):
+        return item in list(self)
+
+    def __eq__(self, other):
+        return list(self) == other
+
+    def __ne__(self, other):
+        return list(self) != other
+
+    def __getitem__(self, i):
+        error = self.data[i]
+        if isinstance(error, ValidationError):
+            return list(error)[0]
+        return force_text(error)
 
 
 # Utilities for time zone support in DateTimeField et al.