[#130] Add ignore command

Author: kindly

flattentool/input.py

@@ -490,13 +490,17 @@ def get_sheet_headings(self, sheet_name):
             sheet_configuration = {}
 
         skip_rows = sheet_configuration.get("skipRows", 0)
+        if sheet_configuration.get("ignore"):
+            # returning empty headers is a proxy for no data in the sheet.
+            return []
 
         if self.vertical_orientation:
             return [cell.value for cell in worksheet.columns[skip_rows][configuration_line:]]
 
         try:
             return [cell.value for cell in worksheet.rows[skip_rows + configuration_line]]
         except IndexError:
+            # If the heading line is after data in the spreadsheet. i.e when skipRows
             return []
 
     def get_sheet_configuration(self, sheet_name):

flattentool/lib.py

@@ -13,4 +13,6 @@ def parse_sheet_configuration(configuration_list):
             configuration['skipRows'] = max(int(parts[1]), 0)
         if (len(parts) == 2 and parts[0].lower() == "headerrows" and isint(parts[1])):
             configuration['headerRows'] = max(int(parts[1]), 1)
+        if (len(parts) == 1 and parts[0].lower() == "ignore"):
+            configuration['ignore'] = True
     return configuration

flattentool/tests/fixtures/xlsx/commands_ignore.xlsx

@@ -1198,3 +1198,17 @@ def test_commands_single_sheet_default(tmpdir):
     unflattened = json.load(tmpdir.join('command_single_unflattened.json'))
 
     assert unflattened == {'main': [{'actual': 'other', 'headings': 'headings', 'some': 'some'}, {'actual': 'actual', 'headings': 'data', 'some': 'some'}]}
+
+def test_commands_ignore(tmpdir):
+
+    unflatten(
+        'flattentool/tests/fixtures/xlsx/commands_ignore.xlsx',
+        input_format='xlsx',
+        output_name=tmpdir.join('command_single_unflattened.json').strpath,
+        cell_source_map=tmpdir.join('command_single_source_map.json').strpath,
+        heading_source_map=tmpdir.join('command_single_heading_source_map.json').strpath,
+        )
+
+    unflattened = json.load(tmpdir.join('command_single_unflattened.json'))
+
+    assert unflattened == {'main': [{'actual': 'actual', 'headings': 'data', 'some': 'some'}]}