feat(csvclean): Add --header-normalize-space option, closes #1056

Author: jpmckinney

CHANGELOG.rst

@@ -7,6 +7,7 @@
 
 Other changes:
 
+* feat: :doc:`/scripts/csvclean` adds a :code:`--header-normalize-space` option to strip leading and trailing whitespace and replace sequences of whitespace characters by a single space in the header.
 * feat: The :code:`--quoting` option accepts 4 (`csv.QUOTE_STRINGS <https://docs.python.org/3/library/csv.html#csv.QUOTE_STRINGS>`__) and 5 (`csv.QUOTE_NOTNULL <https://docs.python.org/3/library/csv.html#csv.QUOTE_NOTNULL>`__) on Python 3.12.
 * feat: :doc:`/scripts/csvformat`: The :code:`--out-quoting` option accepts 4 (`csv.QUOTE_STRINGS <https://docs.python.org/3/library/csv.html#csv.QUOTE_STRINGS>`__) and 5 (`csv.QUOTE_NOTNULL <https://docs.python.org/3/library/csv.html#csv.QUOTE_NOTNULL>`__) on Python 3.12.
 * fix: :doc:`/scripts/csvformat`: The :code:`--out-quoting` option works with 2 (`csv.QUOTE_NONUMERIC <https://docs.python.org/3/library/csv.html#csv.QUOTE_NOTNUMERIC>`__). Use the :code:`--locale` option to set the locale of any formatted numbers.

csvkit/cleanup.py

@@ -28,10 +28,12 @@ class RowChecker:
     Iterate over rows of a CSV producing cleaned rows and storing error rows.
     """
 
-    def __init__(self, reader):
+    def __init__(self, reader, header_normalize_space=False):
         self.reader = reader
         try:
             self.column_names = next(reader)
+            if header_normalize_space:
+                self.column_names = [' '.join(column_name.split()) for column_name in self.column_names]
         except StopIteration:
             self.column_names = []
         self.errors = []

csvkit/utilities/csvclean.py

@@ -13,15 +13,18 @@ class CSVClean(CSVKitUtility):
     override_flags = ['L', 'blanks', 'date-format', 'datetime-format']
 
     def add_arguments(self):
-        pass
+        self.argparser.add_argument(
+            '--header-normalize-space', dest='header_normalize_space', action='store_true',
+            help='Strip leading and trailing whitespace and replace sequences of whitespace characters by a single '
+                 'space in the header.')
 
     def main(self):
         if self.additional_input_expected():
             sys.stderr.write('No input file or piped data provided. Waiting for standard input:\n')
 
         reader = agate.csv.reader(self.skip_lines(), **self.reader_kwargs)
 
-        checker = RowChecker(reader)
+        checker = RowChecker(reader, header_normalize_space=self.args.header_normalize_space)
 
         output_writer = agate.csv.writer(self.output_file, **self.writer_kwargs)
         output_writer.writerow(checker.column_names)

examples/test_header_newline.csv

@@ -0,0 +1,5 @@
+"	
+ start 	
+ end 	
+",b,c
+d,e,f

tests/test_utilities/test_csvclean.py

@@ -77,6 +77,12 @@ def test_no_header_row(self):
             ['1', '2', '3'],
         ], [])
 
+    def test_header_normalize_space(self):
+        self.assertCleaned(['--header-normalize-space', 'examples/test_header_newline.csv'], [
+            ['start end', 'b', 'c'],
+            ['d', 'e', 'f'],
+        ], [])
+
     def test_removes_optional_quote_characters(self):
         self.assertCleaned(['examples/optional_quote_characters.csv'], [
             ['a', 'b', 'c'],