python-jsonschema#708 - improve pretty output format

Unicode box characters, true JSON output, (slightly) more space between each error, etc.

Author: sloanlance

jsonschema/cli.py

@@ -70,18 +70,21 @@ def validation_success(self, **kwargs):
 @attr.s
 class _PrettyFormatter(object):
 
-    _ERROR_MSG = dedent(
-        """\
-        ===[{type}]===({path})===
+    _WIDTH = 79
 
-        {body}
-        -----------------------------
-        """,
-    )
-    _SUCCESS_MSG = "===[SUCCESS]===({path})===\n"
+    def _simple_msg(self, path, type, header=False):
+        begin_end_chars = '╒╕' if header is True else '══'
+        return '{}══[{}]═══({})'.format(begin_end_chars[0], type, path)\
+                   .ljust(self._WIDTH - 1, '═') + begin_end_chars[1]
+
+    def _error_msg(self, path, type, body):
+        HEADER = self._simple_msg(path, type, header=True)
+        FOOTER = '└' + '─' * (self._WIDTH - 2) + '┘'
+
+        return '\n'.join((HEADER, str(body), FOOTER, '\n'))
 
     def filenotfound_error(self, path, exc_info):
-        return self._ERROR_MSG.format(
+        return self._error_msg(
             path=path,
             type="FileNotFoundError",
             body="{!r} does not exist.".format(path),
@@ -92,21 +95,21 @@ def parsing_error(self, path, exc_info):
         exc_lines = "".join(
             traceback.format_exception(exc_type, exc_value, exc_traceback),
         )
-        return self._ERROR_MSG.format(
+        return self._error_msg(
             path=path,
             type=exc_type.__name__,
             body=exc_lines,
         )
 
     def validation_error(self, instance_path, error):
-        return self._ERROR_MSG.format(
+        return self._error_msg(
             path=instance_path,
             type=error.__class__.__name__,
             body=error,
         )
 
     def validation_success(self, instance_path):
-        return self._SUCCESS_MSG.format(path=instance_path)
+        return self._simple_msg(path=instance_path, type='SUCCESS') + '\n\n'
 
 
 @attr.s

jsonschema/exceptions.py

@@ -1,6 +1,7 @@
 """
 Validation errors, and some surrounding helpers.
 """
+import json
 from collections import defaultdict, deque
 import itertools
 import pprint
@@ -68,7 +69,7 @@ def __unicode__(self):
         if any(m is _unset for m in essential_for_verbose):
             return self.message
 
-        pschema = pprint.pformat(self.schema, width=72)
+        pschema = json.dumps(self.schema, separators=(',\n', ': '), sort_keys=True)
         pinstance = pprint.pformat(self.instance, width=72)
         return self.message + textwrap.dedent("""
 
@@ -200,7 +201,7 @@ def __init__(self, type, instance, schema):
         self.schema = schema
 
     def __unicode__(self):
-        pschema = pprint.pformat(self.schema, width=72)
+        pschema = json.dumps(self.schema, separators=(',\n', ': '), sort_keys=True)
         pinstance = pprint.pformat(self.instance, width=72)
         return textwrap.dedent("""
             Unknown type %r for validator with schema: