Put changed first, then added, then removed

Author: simonw

csv_diff/__init__.py

@@ -47,6 +47,24 @@ def human_text(result):
     title = []
     summary = []
     show_headers = sum(1 for key in result if result[key]) > 1
+    if result["changed"]:
+        fragment = "{} row{} changed".format(
+            len(result["changed"]), "" if len(result["changed"]) == 1 else "s"
+        )
+        title.append(fragment)
+        if show_headers:
+            summary.append(fragment + "\n")
+        change_blocks = []
+        for details in result["changed"]:
+            block = []
+            block.append("  Row {}".format(details["key"]))
+            for field, (prev_value, current_value) in details["changes"].items():
+                block.append(
+                    '    {}: "{}" => "{}"'.format(field, prev_value, current_value)
+                )
+            block.append("")
+            change_blocks.append("\n".join(block))
+        summary.append("\n".join(change_blocks))
     if result["added"]:
         fragment = "{} row{} added".format(
             len(result["added"]), "" if len(result["added"]) == 1 else "s"
@@ -67,19 +85,4 @@ def human_text(result):
         for row in result["removed"]:
             summary.append("  {}".format(json.dumps(row)))
         summary.append("")
-    if result["changed"]:
-        fragment = "{} row{} changed".format(
-            len(result["changed"]), "" if len(result["changed"]) == 1 else "s"
-        )
-        title.append(fragment)
-        if show_headers:
-            summary.append(fragment + "\n")
-        for details in result["changed"]:
-            summary.append("  Row {}".format(details["key"]))
-            for field, (prev_value, current_value) in details["changes"].items():
-                summary.append(
-                    '    {}: "{}" => "{}"'.format(field, prev_value, current_value)
-                )
-            summary.append("")
-        summary.append("")
     return (", ".join(title) + "\n\n" + ("\n".join(summary))).strip()

tests/test_human_text.py

@@ -35,10 +35,10 @@ def test_row_changed_and_row_added():
         load_csv(io.StringIO(ONE), key="id"), load_csv(io.StringIO(FOUR), key="id")
     )
     assert (
-        "1 row added, 1 row changed\n\n"
-        "1 row added\n\n"
-        '  {"id": "3", "name": "Bailey", "age": "1"}\n\n'
+        "1 row changed, 1 row added\n\n"
         "1 row changed\n\n"
         "  Row 1\n"
-        '    age: "4" => "5"'
+        '    age: "4" => "5"\n\n'
+        "1 row added\n\n"
+        '  {"id": "3", "name": "Bailey", "age": "1"}'
     ) == human_text(diff)