Merge pull request #360 from OpenDataServices/1285-sheetnames

input: Include sheet names in warnings about duplicate column headings

Author: Bjwebb

CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+- Include sheet name with duplicate heading warnings.
+
 ## [0.13.0] - 2020-09-09
 
 ### Changed

flattentool/input.py

@@ -333,7 +333,7 @@ def do_unflatten(self):
                             warn(
                                 (
                                     'Duplicate heading "{}" found, ignoring '
-                                    "the data in columns {} and {}."
+                                    'the data in columns {} and {} (sheet: "{}").'
                                 ).format(
                                     actual_heading,
                                     ", ".join(
@@ -343,28 +343,32 @@ def do_unflatten(self):
                                         ]
                                     ),
                                     _get_column_letter(ignoring[-1] + 1),
+                                    sheet_name,
                                 ),
                                 DataErrorWarning,
                             )
                         elif len(found[actual_heading]) == 3:
                             warn(
                                 (
                                     'Duplicate heading "{}" found, ignoring '
-                                    "the data in columns {} and {}."
+                                    'the data in columns {} and {} (sheet: "{}").'
                                 ).format(
                                     actual_heading,
                                     _get_column_letter(ignoring[0] + 1),
                                     _get_column_letter(ignoring[1] + 1),
+                                    sheet_name,
                                 ),
                                 DataErrorWarning,
                             )
                         else:
                             warn(
                                 (
                                     'Duplicate heading "{}" found, ignoring '
-                                    "the data in column {}."
+                                    'the data in column {} (sheet: "{}").'
                                 ).format(
-                                    actual_heading, _get_column_letter(ignoring[0] + 1),
+                                    actual_heading,
+                                    _get_column_letter(ignoring[0] + 1),
+                                    sheet_name,
                                 ),
                                 DataErrorWarning,
                             )

flattentool/tests/test_headings.py

@@ -14,7 +14,7 @@
             # Check we use the later values
             [1, 2],
         ],
-        ['Duplicate heading "a" found, ignoring the data in column A.'],
+        ['Duplicate heading "a" found, ignoring the data in column A (sheet: "main").'],
         ([OrderedDict([("a", 2)])], None, None),
     ),
     (
@@ -24,9 +24,9 @@
             [1,],
         ],
         [
-            'Duplicate heading "b" found, ignoring the data in column B.',
-            'Duplicate heading "c" found, ignoring the data in columns C and E.',
-            'Duplicate heading "d" found, ignoring the data in columns G, H and I.',
+            'Duplicate heading "b" found, ignoring the data in column B (sheet: "main").',
+            'Duplicate heading "c" found, ignoring the data in columns C and E (sheet: "main").',
+            'Duplicate heading "d" found, ignoring the data in columns G, H and I (sheet: "main").',
         ],
         ([OrderedDict([("a", 1)])], None, None),
     ),