clarified csv output options

Author: chfw

pyexcel_cli/merge.py

@@ -20,19 +20,19 @@
 @click.command(short_help="Merge excel files into one")
 @click.option('--output-file-type',
               help="file type of the stdout if '-' is given")
-@click.option('--csv-delimiter', default=None)
-@click.option('--csv-encoding', default=None)
-@click.option('--csv-lineterminator', default=None)
-@click.option('--csv-quotechar', default=None)
-@click.option('--csv-escapechar', default=None)
-@click.option('--csv-quoting', default=None)
-@click.option('--csv-no-doublequote', default=False, is_flag=True)
+@click.option('--csv-output-delimiter', default=None)
+@click.option('--csv-output-encoding', default=None)
+@click.option('--csv-output-lineterminator', default=None)
+@click.option('--csv-output-quotechar', default=None)
+@click.option('--csv-output-escapechar', default=None)
+@click.option('--csv-output-quoting', default=None)
+@click.option('--csv-output-no-doublequote', default=False, is_flag=True)
 @click.argument('sources', nargs=-1)
 @click.argument('output', nargs=1)
 def merge(output_file_type,
-          csv_delimiter, csv_encoding, csv_quotechar,
-          csv_escapechar, csv_quoting,
-          csv_lineterminator, csv_no_doublequote,
+          csv_output_delimiter, csv_output_encoding, csv_output_quotechar,
+          csv_output_escapechar, csv_output_quoting,
+          csv_output_lineterminator, csv_output_no_doublequote,
           sources, output):
     """
     Merge excel files in various file formats into one excel file
@@ -57,9 +57,10 @@ def merge(output_file_type,
     params = {}
     if output_file_type == 'csv' or output.endswith('csv'):
         params = _make_csv_params(
-            csv_lineterminator, csv_encoding, csv_delimiter,
-            csv_quoting, csv_quotechar, csv_escapechar,
-            csv_no_doublequote)
+            csv_output_lineterminator, csv_output_encoding,
+            csv_output_delimiter, csv_output_quoting,
+            csv_output_quotechar, csv_output_escapechar,
+            csv_output_no_doublequote)
 
     for afile in _join_the_list(file_list, dir_list, glob_list):
         try:

pyexcel_cli/transcode.py

@@ -45,13 +45,13 @@
 @click.option('--csv-source-escapechar', default=None)
 @click.option('--csv-source-quoting', default=None)
 @click.option('--csv-source-no-doublequote', default=False, is_flag=True)
-@click.option('--csv-dest-delimiter', default=None)
-@click.option('--csv-dest-encoding', default=None)
-@click.option('--csv-dest-lineterminator', default=None)
-@click.option('--csv-dest-quotechar', default=None)
-@click.option('--csv-dest-escapechar', default=None)
-@click.option('--csv-dest-quoting', default=None)
-@click.option('--csv-dest-no-doublequote', default=False, is_flag=True)
+@click.option('--csv-output-delimiter', default=None)
+@click.option('--csv-output-encoding', default=None)
+@click.option('--csv-output-lineterminator', default=None)
+@click.option('--csv-output-quotechar', default=None)
+@click.option('--csv-output-escapechar', default=None)
+@click.option('--csv-output-quoting', default=None)
+@click.option('--csv-output-no-doublequote', default=False, is_flag=True)
 @click.argument('source', nargs=1)
 @click.argument('output', nargs=1)
 def transcode(source_file_type, output_file_type,
@@ -61,10 +61,10 @@ def transcode(source_file_type, output_file_type,
               csv_source_lineterminator, csv_source_quotechar,
               csv_source_escapechar, csv_source_quoting,
               csv_source_no_doublequote,
-              csv_dest_delimiter, csv_dest_encoding,
-              csv_dest_lineterminator, csv_dest_quotechar,
-              csv_dest_escapechar, csv_dest_quoting,
-              csv_dest_no_doublequote,
+              csv_output_delimiter, csv_output_encoding,
+              csv_output_lineterminator, csv_output_quotechar,
+              csv_output_escapechar, csv_output_quoting,
+              csv_output_no_doublequote,
               source, output):
     """
     Trancode an excel file from one format to another.
@@ -97,10 +97,10 @@ def transcode(source_file_type, output_file_type,
 
     if output_file_type == 'csv' or output.endswith('csv'):
         csv_params = _make_csv_params(
-            csv_dest_lineterminator, csv_dest_encoding,
-            csv_dest_delimiter, csv_dest_quoting,
-            csv_dest_quotechar, csv_dest_escapechar,
-            csv_dest_no_doublequote, prefix="dest_")
+            csv_output_lineterminator, csv_output_encoding,
+            csv_output_delimiter, csv_output_quoting,
+            csv_output_quotechar, csv_output_escapechar,
+            csv_output_no_doublequote, prefix="dest_")
         params.update(csv_params)
 
     sheet_parameters = [sheet_name, sheet_index,

pyexcel_cli/view.py

@@ -35,13 +35,13 @@
 @click.option('--csv-source-escapechar', default=None)
 @click.option('--csv-source-quoting', default=None)
 @click.option('--csv-source-no-doublequote', default=False, is_flag=True)
-@click.option('--csv-dest-delimiter', default=None)
-@click.option('--csv-dest-encoding', default=None)
-@click.option('--csv-dest-lineterminator', default=None)
-@click.option('--csv-dest-quotechar', default=None)
-@click.option('--csv-dest-escapechar', default=None)
-@click.option('--csv-dest-quoting', default=None)
-@click.option('--csv-dest-no-doublequote', default=False, is_flag=True)
+@click.option('--csv-output-delimiter', default=None)
+@click.option('--csv-output-encoding', default=None)
+@click.option('--csv-output-lineterminator', default=None)
+@click.option('--csv-output-quotechar', default=None)
+@click.option('--csv-output-escapechar', default=None)
+@click.option('--csv-output-quoting', default=None)
+@click.option('--csv-output-no-doublequote', default=False, is_flag=True)
 @click.argument('source')
 @click.pass_context
 def view(ctx, **keywords):

tests/test_merge.py

@@ -40,8 +40,8 @@ def test_stdout_option():
     glob_fixture = os.path.join("tests", "fixtures", "glob_dir", "*")
     output = "-"
     result = runner.invoke(merge, ["--output-file-type", "csv",
-                                   "--csv-lineterminator", "\n",
-                                   "--csv-delimiter", ":",
+                                   "--csv-output-lineterminator", "\n",
+                                   "--csv-output-delimiter", ":",
                                    file_fixture, dir_fixture, glob_fixture,
                                    output])
     eq_(result.exit_code, 0)
@@ -64,9 +64,9 @@ def test_more_csv_options():
     file_fixture = os.path.join("tests", "fixtures", "transcode_quoted.csv")
     output = "-"
     result = runner.invoke(merge, ["--output-file-type", "csv",
-                                   "--csv-lineterminator", "\n",
-                                   "--csv-delimiter", ":",
-                                   "--csv-quoting", "minimal",
+                                   "--csv-output-lineterminator", "\n",
+                                   "--csv-output-delimiter", ":",
+                                   "--csv-output-quoting", "minimal",
                                    file_fixture, output])
     eq_(result.exit_code, 0)
     expected = dedent("""

tests/test_transcode.py

@@ -9,7 +9,7 @@ def test_simple_option():
     test_fixture = os.path.join("tests", "fixtures",
                                 "transcode_simple.csv")
     output = "test_simple_option.csv"
-    result = runner.invoke(transcode, ["--csv-dest-lineterminator", "\n",
+    result = runner.invoke(transcode, ["--csv-output-lineterminator", "\n",
                                        test_fixture, output])
     print(result.output)
     eq_(result.exit_code, 0)
@@ -24,7 +24,7 @@ def test_stdout_option():
     test_fixture = os.path.join("tests", "fixtures",
                                 "transcode_simple.csv")
     result = runner.invoke(transcode, ["--output-file-type", "csv",
-                                       "--csv-dest-lineterminator", "\n",
+                                       "--csv-output-lineterminator", "\n",
                                        test_fixture, '-'])
     eq_(result.exit_code, 0)
     eq_(result.output, '1,2,3\n')
@@ -34,7 +34,7 @@ def test_stdin_option():
     runner = CliRunner()
     result = runner.invoke(transcode,
                            ["--source-file-type", "csv",
-                            "--csv-dest-lineterminator", "\n",
+                            "--csv-output-lineterminator", "\n",
                             "--output-file-type", "csv", '-', '-'],
                            input='1,2,3')
     eq_(result.output, '1,2,3\n')
@@ -45,8 +45,8 @@ def test_quoting_char():
     runner = CliRunner()
     result = runner.invoke(transcode,
                            ["--source-file-type", "csv",
-                            "--csv-dest-lineterminator", "\n",
-                            "--csv-dest-quotechar", "|",
+                            "--csv-output-lineterminator", "\n",
+                            "--csv-output-quotechar", "|",
                             "--output-file-type", "csv", '-', '-'],
                            input='1,"Boris,J",3')
     eq_(result.output, '1,|Boris,J|,3\n')
@@ -58,7 +58,7 @@ def test_escape_char():
     result = runner.invoke(transcode,
                            ["--source-file-type", "csv",
                             "--csv-source-escapechar", "&",
-                            "--csv-dest-lineterminator", "\n",
+                            "--csv-output-lineterminator", "\n",
                             "--output-file-type", "csv", '-', '-'],
                            input='1,"Boris&,J",3')
     eq_(result.output, '1,"Boris,J",3\n')

tests/test_view.py

@@ -13,7 +13,7 @@ def test_stdin_option():
     runner = CliRunner()
     result = runner.invoke(view,
                            ["--source-file-type", "csv",
-                            "--csv-dest-lineterminator", "\n",
+                            "--csv-output-lineterminator", "\n",
                             "--output-file-type", "csv", '-'],
                            input='1,2,3')
     eq_(result.output, '1,2,3\n')
@@ -24,7 +24,7 @@ def test_stdout_option():
     runner = CliRunner()
     test_fixture = os.path.join("tests", "fixtures", "transcode_simple.csv")
     result = runner.invoke(view, ["--output-file-type", "csv",
-                                  "--csv-dest-lineterminator", "\n",
+                                  "--csv-output-lineterminator", "\n",
                                   test_fixture])
     eq_(result.exit_code, 0)
     eq_(result.output, '1,2,3\n')
@@ -35,7 +35,7 @@ def test_csv_encoding_option():
     test_fixture = os.path.join("tests", "fixtures", "csv-encoding-utf16.csv")
     result = runner.invoke(view, ["--output-file-type", "csv",
                                   "--csv-source-encoding", "utf-16",
-                                  "--csv-dest-lineterminator", "\n",
+                                  "--csv-output-lineterminator", "\n",
                                   test_fixture])
     eq_(result.exit_code, 0)
     if sys.version_info[0] == 2: