Merge branch 'master' into 183-anonymise

Author: Bjwebb

examples/help/create-template/expected.txt

@@ -1,4 +1,4 @@
-usage: flatten-tool create-template [-h] -s SCHEMA [-f OUTPUT_FORMAT]
+usage: flatten-tool create-template [-h] -s SCHEMA [-f {csv,xlsx,all}]
                                     [-m MAIN_SHEET_NAME] [-o OUTPUT_NAME]
                                     [--rollup] [-r ROOT_ID] [--use-titles]
 
@@ -7,7 +7,7 @@ optional arguments:
   -s SCHEMA, --schema SCHEMA
                         Path to the schema file you want to use to create the
                         template
-  -f OUTPUT_FORMAT, --output-format OUTPUT_FORMAT
+  -f {csv,xlsx,all}, --output-format {csv,xlsx,all}
                         Type of template you want to create. Defaults to all
                         available options
   -m MAIN_SHEET_NAME, --main-sheet-name MAIN_SHEET_NAME

examples/help/flatten/expected.txt

@@ -1,4 +1,4 @@
-usage: flatten-tool flatten [-h] [-s SCHEMA] [-f OUTPUT_FORMAT] [--xml]
+usage: flatten-tool flatten [-h] [-s SCHEMA] [-f {csv,xlsx,all}] [--xml]
                             [--id-name ID_NAME] [-m MAIN_SHEET_NAME]
                             [-o OUTPUT_NAME] [--root-list-path ROOT_LIST_PATH]
                             [--rollup] [-r ROOT_ID] [--use-titles]
@@ -11,7 +11,7 @@ optional arguments:
   -h, --help            show this help message and exit
   -s SCHEMA, --schema SCHEMA
                         Path to a relevant schema.
-  -f OUTPUT_FORMAT, --output-format OUTPUT_FORMAT
+  -f {csv,xlsx,all}, --output-format {csv,xlsx,all}
                         Type of template you want to create. Defaults to all
                         available options
   --xml                 Use XML as the input format

examples/help/unflatten/expected.txt

@@ -1,4 +1,4 @@
-usage: flatten-tool unflatten [-h] -f INPUT_FORMAT [--xml] [--id-name ID_NAME]
+usage: flatten-tool unflatten [-h] -f {csv,xlsx} [--xml] [--id-name ID_NAME]
                               [-b BASE_JSON] [-m ROOT_LIST_PATH] [-e ENCODING]
                               [-o OUTPUT_NAME] [-c CELL_SOURCE_MAP]
                               [-a HEADING_SOURCE_MAP]
@@ -17,7 +17,7 @@ positional arguments:
 
 optional arguments:
   -h, --help            show this help message and exit
-  -f INPUT_FORMAT, --input-format INPUT_FORMAT
+  -f {csv,xlsx}, --input-format {csv,xlsx}
                         File format of input file or directory.
   --xml                 Use XML as the output format
   --id-name ID_NAME     String to use for the identifier key, defaults to 'id'
@@ -33,7 +33,7 @@ optional arguments:
                         Defaults to utf8.
   -o OUTPUT_NAME, --output-name OUTPUT_NAME
                         Name of the outputted file. Will have an extension
-                        appended as appropriate. Defaults to unflattened.json
+                        appended as appropriate.
   -c CELL_SOURCE_MAP, --cell-source-map CELL_SOURCE_MAP
                         Path to write a cell source map to. Will have an
                         extension appended as appropriate.

flattentool/__init__.py

@@ -12,7 +12,8 @@
 from collections import OrderedDict
 
 
-def create_template(schema, output_name='template', output_format='all', main_sheet_name='main', flatten=False, rollup=False, root_id=None, use_titles=False, **_):
+def create_template(schema, output_name='template', output_format='all', main_sheet_name='main',
+                    rollup=False, root_id=None, use_titles=False, **_):
     """
     Creates template file(s) from given inputs
     This function is built to deal with commandline input and arguments

flattentool/cli.py

@@ -1,6 +1,8 @@
 from __future__ import print_function
 import argparse
 from flattentool import create_template, unflatten, flatten
+from flattentool.input import FORMATS as INPUT_FORMATS
+from flattentool.output import FORMATS as OUTPUT_FORMATS
 from six import text_type
 
 """
@@ -28,6 +30,9 @@ def create_parser():
     parser = argparse.ArgumentParser()
     subparsers = parser.add_subparsers(dest='subparser_name')
 
+    output_formats = sorted(OUTPUT_FORMATS) + ['all']
+    input_formats = sorted(INPUT_FORMATS)
+
     parser_create_template = subparsers.add_parser(
         'create-template',
         help='Create a template from the given schema')
@@ -37,7 +42,8 @@ def create_parser():
         required=True)
     parser_create_template.add_argument(
         "-f", "--output-format",
-        help="Type of template you want to create. Defaults to all available options")
+        help="Type of template you want to create. Defaults to all available options",
+        choices=output_formats)
     parser_create_template.add_argument(
         "-m", "--main-sheet-name",
         help="The name of the main sheet, as seen in the first tab of the spreadsheet for example. Defaults to main")
@@ -67,7 +73,8 @@ def create_parser():
         help="Path to a relevant schema.")
     parser_flatten.add_argument(
         "-f", "--output-format",
-        help="Type of template you want to create. Defaults to all available options")
+        help="Type of template you want to create. Defaults to all available options",
+        choices=output_formats)
     parser_flatten.add_argument(
         "--xml",
         action='store_true',
@@ -105,6 +112,7 @@ def create_parser():
     parser_unflatten.add_argument(
         "-f", "--input-format",
         help="File format of input file or directory.",
+        choices=input_formats,
         required=True)
     parser_unflatten.add_argument(
         "--xml",
@@ -124,7 +132,7 @@ def create_parser():
         help="Encoding of the input file(s) (only relevant for CSV). This can be any encoding recognised by Python. Defaults to utf8.")
     parser_unflatten.add_argument(
         "-o", "--output-name",
-        help="Name of the outputted file. Will have an extension appended as appropriate. Defaults to unflattened.json")
+        help="Name of the outputted file. Will have an extension appended as appropriate.")
     parser_unflatten.add_argument(
         "-c", "--cell-source-map",
         help="Path to write a cell source map to. Will have an extension appended as appropriate.")