Only show headings if more than one change type

Author: simonw

csv_diff/__init__.py

@@ -46,12 +46,14 @@ def compare(previous, current):
 def human_text(result):
     title = []
     summary = []
+    show_headers = sum(1 for key in result if result[key]) > 1
     if result["added"]:
         fragment = "{} row{} added".format(
             len(result["added"]), "" if len(result["added"]) == 1 else "s"
         )
         title.append(fragment)
-        summary.append(fragment + "\n")
+        if show_headers:
+            summary.append(fragment + "\n")
         for row in result["added"]:
             summary.append("  {}".format(json.dumps(row)))
         summary.append("")
@@ -60,7 +62,8 @@ def human_text(result):
             len(result["removed"]), "" if len(result["removed"]) == 1 else "s"
         )
         title.append(fragment)
-        summary.append(fragment + "\n")
+        if show_headers:
+            summary.append(fragment + "\n")
         for row in result["removed"]:
             summary.append("  {}".format(json.dumps(row)))
         summary.append("")
@@ -69,7 +72,8 @@ def human_text(result):
             len(result["changed"]), "" if len(result["changed"]) == 1 else "s"
         )
         title.append(fragment)
-        summary.append(fragment + "\n")
+        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():

tests/test_cli.py

@@ -11,10 +11,7 @@ def test_human_cli(tmpdir):
     two.write(TWO)
     result = CliRunner().invoke(cli.cli, [str(one), str(two), "--key", "id"])
     assert 0 == result.exit_code
-    assert (
-        '1 row changed\n\n1 row changed\n\n  Row 1\n    age: "4" => "5"'
-        == result.output.strip()
-    )
+    assert '1 row changed\n\n  Row 1\n    age: "4" => "5"' == result.output.strip()
 
 
 def test_human_cli_json(tmpdir):

tests/test_csv_diff.py

@@ -12,6 +12,11 @@
 THREE = """id,name,age
 1,Cleo,5"""
 
+FOUR = """id,name,age
+1,Cleo,5
+2,Pancakes,2,
+3,Bailey,1"""
+
 
 def test_row_changed():
     diff = compare(

tests/test_human_text.py

@@ -1,25 +1,21 @@
 from csv_diff import load_csv, compare, human_text
-from .test_csv_diff import ONE, TWO, THREE
+from .test_csv_diff import ONE, TWO, THREE, FOUR
 import io
 
 
 def test_row_changed():
     diff = compare(
         load_csv(io.StringIO(ONE), key="id"), load_csv(io.StringIO(TWO), key="id")
     )
-    assert (
-        '1 row changed\n\n1 row changed\n\n  Row 1\n    age: "4" => "5"'
-        == human_text(diff)
-    )
+    assert '1 row changed\n\n  Row 1\n    age: "4" => "5"' == human_text(diff)
 
 
 def test_row_added():
     diff = compare(
         load_csv(io.StringIO(THREE), key="id"), load_csv(io.StringIO(TWO), key="id")
     )
-    assert (
-        '1 row added\n\n1 row added\n\n  {"id": "2", "name": "Pancakes", "age": "2"}'
-        == human_text(diff)
+    assert '1 row added\n\n  {"id": "2", "name": "Pancakes", "age": "2"}' == human_text(
+        diff
     )
 
 
@@ -28,6 +24,21 @@ def test_row_removed():
         load_csv(io.StringIO(TWO), key="id"), load_csv(io.StringIO(THREE), key="id")
     )
     assert (
-        '1 row removed\n\n1 row removed\n\n  {"id": "2", "name": "Pancakes", "age": "2"}'
+        '1 row removed\n\n  {"id": "2", "name": "Pancakes", "age": "2"}'
         == human_text(diff)
     )
+
+
+def test_row_changed_and_row_added():
+    "Should have headers for each section here"
+    diff = compare(
+        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\n\n"
+        "  Row 1\n"
+        '    age: "4" => "5"'
+    ) == human_text(diff)