Move trace dumping to a separate module. Add option to not dump arg names.

[apitrace] / scripts / jsondiff.py

diff --git a/scripts/jsondiff.py b/scripts/jsondiff.py
index 00976cad3c74729b33eecd1a3ba58fae83f8794c..b541e449f03ec1f0e81e6bc53df2180a7678b53e 100755 (executable)
--- a/scripts/jsondiff.py
+++ b/scripts/jsondiff.py
@@ -26,6 +26,8 @@
 
 
 import json
+import optparse
+import re
 import sys
 
 
@@ -83,9 +85,7 @@ class Dumper(Visitor):
             value = node[name]
             self.enter_member(name)
             self.visit(value)
-            if i:
-                self._write(',')
-            self.leave_member()
+            self.leave_member(i == len(members) - 1)
         self.leave_object()
 
     def enter_object(self):
@@ -97,13 +97,17 @@ class Dumper(Visitor):
         self._indent()
         self._write('%s: ' % name)
 
-    def leave_member(self):
+    def leave_member(self, last):
+        if not last:
+            self._write(',')
         self._newline()
 
     def leave_object(self):
         self.level -= 1
         self._indent()
         self._write('}')
+        if self.level <= 0:
+            self._newline()
 
     def visit_array(self, node):
         self.enter_array()
@@ -111,7 +115,7 @@ class Dumper(Visitor):
             value = node[i]
             self._indent()
             self.visit(value)
-            if i:
+            if i != len(node) - 1:
                 self._write(',')
             self._newline()
         self.leave_array()
@@ -189,23 +193,19 @@ class Differ(Visitor):
         else:
             self.dumper.enter_object()
             names = set(a.keys())
-            names.update(b.keys())
+            if not self.comparer.ignore_added:
+                names.update(b.keys())
             names = list(names)
             names.sort()
 
-            for name in names:
-                try:
-                    ae = a[name]
-                except KeyError:
-                    if self.comparer.ignore_added:
-                        continue
-                    else:
-                        ae = None
+            for i in range(len(names)):
+                name = names[i]
+                ae = a.get(name, None)
                 be = b.get(name, None)
                 if not self.comparer.visit(ae, be):
                     self.dumper.enter_member(name)
                     self.visit(ae, be)
-                    self.dumper.leave_member()
+                    self.dumper.leave_member(i == len(names) - 1)
 
             self.dumper.leave_object()
 
@@ -214,7 +214,8 @@ class Differ(Visitor):
             self.replace(a, b)
         else:
             self.dumper.enter_array()
-            for i in range(max(len(a), len(b))):
+            max_len = max(len(a), len(b))
+            for i in range(max_len):
                 try:
                     ae = a[i]
                 except IndexError:
@@ -228,6 +229,8 @@ class Differ(Visitor):
                     self.dumper.visit(ae)
                 else:
                     self.visit(ae, be)
+                if i != max_len - 1:
+                    self.dumper._write(',')
                 self.dumper._newline()
 
             self.dumper.leave_array()
@@ -242,20 +245,70 @@ class Differ(Visitor):
         self.dumper.visit(b)
 
 
-def load(stream, strip = True):
-    if strip:
+#
+# Unfortunately JSON standard does not include comments, but this is a quite
+# useful feature to have on regressions tests
+#
+
+_token_res = [
+    r'//[^\r\n]*', # comment
+    r'"[^"\\]*(\\.[^"\\]*)*"', # string
+]
+
+_tokens_re = re.compile(r'|'.join(['(' + token_re + ')' for token_re in _token_res]), re.DOTALL)
+
+
+def _strip_comment(mo):
+    if mo.group(1):
+        return ''
+    else:
+        return mo.group(0)
+
+
+def _strip_comments(data):
+    '''Strip (non-standard) JSON comments.'''
+    return _tokens_re.sub(_strip_comment, data)
+
+
+assert _strip_comments('''// a comment
+"// a comment in a string
+"''') == '''
+"// a comment in a string
+"'''
+
+
+def load(stream, strip_images = True, strip_comments = True):
+    if strip_images:
         object_hook = strip_object_hook
     else:
         object_hook = None
-    return json.load(stream, strict=False, object_hook = object_hook)
+    if strip_comments:
+        data = stream.read()
+        data = _strip_comments(data)
+        return json.loads(data, strict=False, object_hook = object_hook)
+    else:
+        return json.load(stream, strict=False, object_hook = object_hook)
 
 
 def main():
-    a = load(open(sys.argv[1], 'rt'))
-    b = load(open(sys.argv[2], 'rt'))
+    optparser = optparse.OptionParser(
+        usage="\n\t%prog [options] <ref_json> <src_json>")
+    optparser.add_option(
+        '--keep-images',
+        action="store_false", dest="strip_images", default=True,
+        help="compare images")
+
+    (options, args) = optparser.parse_args(sys.argv[1:])
+
+    if len(args) != 2:
+        optparser.error('incorrect number of arguments')
+
+    a = load(open(sys.argv[1], 'rt'), options.strip_images)
+    b = load(open(sys.argv[2], 'rt'), options.strip_images)
 
-    #dumper = Dumper()
-    #dumper.visit(a)
+    if False:
+        dumper = Dumper()
+        dumper.visit(a)
 
     differ = Differ()
     differ.visit(a, b)