consolidate csv options

Author: chfw

pyexcel_cli/_shared.py

@@ -1,3 +1,5 @@
+import sys
+import csv
 import click
 from pyexcel.core import get_io_type
 
@@ -21,3 +23,41 @@ def get_stream(name, file_type):
         stream = click.get_binary_stream(name)
 
     return stream
+
+
+def _make_single_character(single_char_input):
+    if sys.version_info[0] == 2:
+        return single_char_input.encode('ascii')
+    else:
+        return single_char_input[0]
+
+
+def _make_csv_params(lineterminator,
+                     encoding,
+                     delimiter,
+                     quoting,
+                     quotechar,
+                     escapechar,
+                     no_doublequote, prefix=""):
+    params = {}
+    if lineterminator is not None:
+        params[prefix + 'lineterminator'] = lineterminator
+    if encoding is not None:
+        params[prefix + 'encoding'] = encoding
+    if delimiter is not None:
+        params[prefix + 'delimiter'] = _make_single_character(delimiter)
+    if quotechar is not None:
+        params[prefix + 'quotechar'] = _make_single_character(quotechar)
+    if escapechar is not None:
+        params[prefix + 'escapechar'] = _make_single_character(escapechar)
+    if no_doublequote:
+        params[prefix + 'no_doublequote'] = no_doublequote
+    if quoting is None:
+        params[prefix + 'quoting'] = csv.QUOTE_MINIMAL
+    elif quoting == 'none':
+        params[prefix + 'quoting'] = csv.QUOTE_NONE
+    elif quoting == "all":
+        params[prefix + 'quoting'] = csv.QUOTE_ALL
+    elif quoting == "nonnumeric":
+        params[prefix + 'quoting'] = csv.QUOTE_NONNUMERIC
+    return params

pyexcel_cli/merge.py

@@ -7,12 +7,14 @@
 
 """
 import os
-import csv
 import sys
 import glob
 import click
 from pyexcel.book import Book
 from pyexcel import get_book
+from pyexcel_cli._shared import (
+    _make_csv_params
+)
 
 
 @click.command(short_help="Merge excel files into one")
@@ -54,26 +56,10 @@ def merge(output_file_type,
 
     params = {}
     if output_file_type == 'csv' or output.endswith('csv'):
-        if csv_lineterminator is not None:
-            params['lineterminator'] = csv_lineterminator
-        if csv_encoding is not None:
-            params['encoding'] = csv_encoding
-        if csv_delimiter is not None:
-            params['delimiter'] = _make_single_character(csv_delimiter)
-        if csv_quotechar is not None:
-            params['quotechar'] = _make_single_character(csv_quotechar)
-        if csv_escapechar is not None:
-            params['escapechar'] = _make_single_character(csv_escapechar)
-        if csv_no_doublequote:
-            params['no_doublequote'] = csv_no_doublequote
-        if csv_quoting is None:
-            params['quoting'] = csv.QUOTE_MINIMAL
-        elif csv_quoting == 'none':
-            params['quoting'] = csv.QUOTE_NONE
-        elif csv_quoting == "all":
-            params['quoting'] = csv.QUOTE_ALL
-        elif csv_quoting == "nonnumeric":
-            params['quoting'] = csv.QUOTE_NONNUMERIC
+        params = _make_csv_params(
+            csv_lineterminator, csv_encoding, csv_delimiter,
+            csv_quoting, csv_quotechar, csv_escapechar,
+            csv_no_doublequote)
 
     for afile in _join_the_list(file_list, dir_list, glob_list):
         try:
@@ -102,10 +88,3 @@ def _join_the_list(file_list, dir_list, glob_list):
     for globee in glob_list:
         for afile in glob.iglob(globee):
             yield afile
-
-
-def _make_single_character(single_char_input):
-    if sys.version_info[0] == 2:
-        return single_char_input.encode('ascii')
-    else:
-        return single_char_input[0]

pyexcel_cli/transcode.py

@@ -11,7 +11,8 @@
 
 from pyexcel_cli._shared import (
     get_input_content,
-    get_output_stream
+    get_output_stream,
+    _make_csv_params
 )
 
 
@@ -40,14 +41,19 @@
 @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.argument('source', nargs=1)
 @click.argument('output', nargs=1)
 def transcode(source_file_type, output_file_type,
               sheet_name, sheet_index,
               name_columns_by_row, name_rows_by_column,
               csv_delimiter, csv_encoding,
-              csv_lineterminator, csv_no_doublequote,
+              csv_lineterminator, csv_quotechar,
+              csv_escapechar, csv_quoting,
+              csv_no_doublequote,
               source, output):
     """
     Trancode an excel file from one format to another.
@@ -71,14 +77,11 @@ def transcode(source_file_type, output_file_type,
         params['dest_file_name'] = output
 
     if output_file_type == 'csv' or output.endswith('csv'):
-        if csv_lineterminator is not None:
-            params['dest_lineterminator'] = csv_lineterminator
-        if csv_encoding is not None:
-            params['dest_encoding'] = csv_encoding
-        if csv_delimiter is not None:
-            params['dest_delimiter'] = csv_delimiter
-        if csv_no_doublequote:
-            params['dest_no_doublequote'] = csv_no_doublequote
+        csv_params = _make_csv_params(
+            csv_lineterminator, csv_encoding, csv_delimiter,
+            csv_quoting, csv_quotechar, csv_escapechar,
+            csv_no_doublequote, prefix="dest_")
+        params.update(csv_params)
 
     sheet_parameters = [sheet_name, sheet_index,
                         name_columns_by_row, name_rows_by_column]

pyexcel_cli/view.py

@@ -31,14 +31,18 @@
 @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.argument('source')
 @click.pass_context
 def view(ctx, source_file_type, output_file_type,
          sheet_name, sheet_index,
          name_columns_by_row, name_rows_by_column,
          csv_delimiter, csv_encoding,
-         csv_lineterminator, csv_no_doublequote,
+         csv_lineterminator, csv_quotechar,
+         csv_escapechar, csv_quoting, csv_no_doublequote,
          source):
     """
     Simply show the data inside the file
@@ -57,5 +61,8 @@ def view(ctx, source_file_type, output_file_type,
                csv_delimiter=csv_delimiter,
                csv_encoding=csv_encoding,
                csv_lineterminator=csv_lineterminator,
+               csv_quotechar=csv_quotechar,
+               csv_escapechar=csv_escapechar,
+               csv_quoting=csv_quoting,
                csv_no_doublequote=csv_no_doublequote,
                output='-')

tests/test_merge.py

@@ -44,7 +44,6 @@ def test_stdout_option():
                                    "--csv-delimiter", ":",
                                    file_fixture, dir_fixture, glob_fixture,
                                    output])
-    print(result.exc_info)
     eq_(result.exit_code, 0)
     expected = dedent("""
     ---pyexcel:transcode_simple.csv---