Display human-readable added/removed rows not using JSON

Author: simonw

csv_diff/__init__.py

@@ -73,7 +73,8 @@ def human_text(result):
         if show_headers:
             summary.append(fragment + "\n")
         for row in result["added"]:
-            summary.append("  {}".format(json.dumps(row)))
+            summary.append(human_row(row, prefix="  "))
+            summary.append("")
         summary.append("")
     if result["removed"]:
         fragment = "{} row{} removed".format(
@@ -83,6 +84,14 @@ def human_text(result):
         if show_headers:
             summary.append(fragment + "\n")
         for row in result["removed"]:
-            summary.append("  {}".format(json.dumps(row)))
+            summary.append(human_row(row, prefix="  "))
+            summary.append("")
         summary.append("")
     return (", ".join(title) + "\n\n" + ("\n".join(summary))).strip()
+
+
+def human_row(row, prefix=""):
+    bits = []
+    for key, value in row.items():
+        bits.append("{}{}: {}".format(prefix, key, value))
+    return "\n".join(bits)

tests/test_human_text.py

@@ -1,6 +1,12 @@
 from csv_diff import load_csv, compare, human_text
 from .test_csv_diff import ONE, TWO, THREE, FOUR
 
+FIVE = """id,name,age
+1,Cleo,5
+2,Pancakes,2,
+3,Bailey,1
+4,Carl,7"""
+
 from textwrap import dedent
 import io
 
@@ -24,7 +30,30 @@ def test_row_added():
     assert dedent("""
     1 row added
 
-      {"id": "2", "name": "Pancakes", "age": "2"}
+      id: 2
+      name: Pancakes
+      age: 2
+    """).strip() == human_text(diff)
+
+
+def test_rows_added():
+    diff = compare(
+        load_csv(io.StringIO(THREE), key="id"), load_csv(io.StringIO(FIVE), key="id")
+    )
+    assert dedent("""
+    3 rows added
+
+      id: 2
+      name: Pancakes
+      age: 2
+
+      id: 3
+      name: Bailey
+      age: 1
+
+      id: 4
+      name: Carl
+      age: 7
     """).strip() == human_text(diff)
 
 
@@ -35,7 +64,9 @@ def test_row_removed():
     assert dedent("""
     1 row removed
 
-      {"id": "2", "name": "Pancakes", "age": "2"}
+      id: 2
+      name: Pancakes
+      age: 2
     """).strip() == human_text(diff)
 
 
@@ -54,5 +85,7 @@ def test_row_changed_and_row_added():
 
     1 row added
 
-      {"id": "3", "name": "Bailey", "age": "1"}
+      id: 3
+      name: Bailey
+      age: 1
     """).strip() == human_text(diff)