Improved CLI error messages

Author: pombredanne

about_code_tool/about.py

@@ -1077,7 +1077,7 @@ def get_genattrib_errors(self):
 
 def main(parser, options, args):
     """
-    Main command line entry point.
+    Main commnand line entry point.
     """
     overwrite = options.overwrite
     verbosity = options.verbosity
@@ -1092,7 +1092,7 @@ def main(parser, options, args):
         handler.setLevel(logging.WARNING)
 
     if not len(args) == 2:
-        print('Input and Output paths are required.')
+        print('ERROR: <input_path> and <output_path> are required.')
         print()
         parser.print_help()
         return errno.EEXIST
@@ -1101,25 +1101,25 @@ def main(parser, options, args):
     output_path = os.path.abspath(output_path)
 
     if not path_exists(input_path):
-        print('Input path does not exist.')
+        print('ERROR: <input_path>  does not exist.')
         print()
         parser.print_help()
         return errno.EEXIST
 
     if os.path.isdir(output_path):
-        print('Output must be a file, not a directory.')
+        print('ERROR: <output_path> must be a file, not a directory.')
         print()
         parser.print_help()
         return errno.EISDIR
 
     if not output_path.endswith('.csv'):
-        print('Output file name must end with ".csv".')
+        print('ERROR: <output_path> must be a CSV file ending with ".csv".')
         print()
         parser.print_help()
         return errno.EINVAL
 
     if path_exists(output_path) and not overwrite:
-        print('Output file already exists. Select a different file name or use the --overwrite option.')
+        print('ERROR: <output_path> file already exists. Select a different file name or use the --overwrite option.')
         print()
         parser.print_help()
         return errno.EEXIST
@@ -1136,7 +1136,7 @@ def main(parser, options, args):
         return OK
     else:
         # we should never reach this
-        assert False, 'Unsupported option(s).'
+        assert False, 'ERROR: Unsupported option(s).'
 
 
 def get_parser():

about_code_tool/genabout.py

@@ -654,7 +654,7 @@ def filter_empty_values(abouts):
 
 def main(parser, options, args):
     """
-    Main commnad line entry point.
+    Main commnand line entry point.
     """
     verbosity = options.verbosity
     action = options.action
@@ -684,25 +684,25 @@ def main(parser, options, args):
         if action in valid_actions:
             action_num = action
         else:
-            print('Invalid action: should be 0, 1, 2 or 3')
+            print('ERROR: Invalid action: must be one of: 0, 1, 2 or 3')
             sys.exit(errno.EINVAL)
 
     if copy_files_path:
         # code to handle tilde character
         copy_files_path = os.path.abspath(expanduser(copy_files_path))
         if not path_exists(copy_files_path):
-            print("The project path does not exist.")
+            print("ERROR: The COPY_FILES path does not exist.")
             sys.exit(errno.EINVAL)
 
     if license_text_path:
         # code to handle tilde character
         license_text_path = os.path.abspath(expanduser(license_text_path))
         if not path_exists(license_text_path):
-            print("The license text path does not exist.")
+            print("ERROR: LICENSE_TEXT_LOCATION path does not exist.")
             sys.exit(errno.EINVAL)
 
     if mapping_config and not path_exists('MAPPING.CONFIG'):
-            print("The file 'MAPPING.CONFIG' does not exist.")
+            print("ERROR: The file 'MAPPING.CONFIG' does not exist.")
             sys.exit(errno.EINVAL)
 
     if extract_license:
@@ -712,7 +712,7 @@ def main(parser, options, args):
         gen_license = True
 
     if not len(args) == 2:
-        print('Input and Output paths are required.')
+        print('ERROR: <input_path> and <utput_path> are required.')
         print()
         parser.print_help()
         sys.exit(errno.EEXIST)
@@ -724,25 +724,25 @@ def main(parser, options, args):
         output_path += '/'
 
     if not exists(input_path):
-        print('Input path does not exist.')
+        print('ERROR: <input_path> file does not exist.')
         print()
         parser.print_help()
         sys.exit(errno.EEXIST)
 
     if not exists(output_path):
-        print('Output path does not exist.')
+        print('ERROR: <output_path> directory does not exist.')
         print()
         parser.print_help()
         sys.exit(errno.EEXIST)
 
     if not isdir(output_path):
-        print('Output must be a directory, not a file.')
+        print('ERROR: <output_path> must be a directory, not a file.')
         print()
         parser.print_help()
         sys.exit(errno.EISDIR)
 
     if not input_path.endswith('.csv'):
-        print("Input file name must be a CSV file ends with '.csv'")
+        print("ERROR: <input_path> file must be a CSV file ends with '.csv'")
         print()
         parser.print_help()
         sys.exit(errno.EINVAL)
@@ -751,8 +751,8 @@ def main(parser, options, args):
 
     dup_keys = gen.get_duplicated_keys(input_path)
     if dup_keys:
-        print('The input file contains duplicated keys. '
-              'Duplicated keys are not allowed.')
+        print('ERROR: The <input_path> CSV file contains duplicated column keys. '
+              'Duplicated column keys are not allowed.')
         print(dup_keys)
         print()
         print('Please fix the input file and re-run the tool.')
@@ -783,43 +783,43 @@ def main(parser, options, args):
 
     if copy_files_path:
         if not isdir(copy_files_path):
-            print("The COPY_FILES path must be a directory.")
-            print("'--copy_files' is skipped.")
+            print("WARNING: The COPY_FILES path must be a directory.")
+            print("'--copy_files' option ignored.")
         else:
             licenses_in_project = True
             license_list = gen.verify_files_existence(input_list,
                                                       copy_files_path,
                                                       licenses_in_project)
             if not license_list:
-                print("None of the file was found. '--copy_files' is ignored.")
+                print("WARNING: No file found. '--copy_files' is ignored.")
             else:
                 gen.copy_files(output_path, license_list)
 
     if license_text_path:
         if not isdir(license_text_path):
-            print("The LICENSE_TEXT_LOCATION  path must be a directory.")
-            print("'--license_text_location' is skipped.")
+            print("WARNING: The LICENSE_TEXT_LOCATION  path must be a directory.")
+            print("'--license_text_location' option ignored.")
         else:
             licenses_in_project = False
             license_list = gen.verify_files_existence(input_list,
                                                       license_text_path,
                                                       licenses_in_project)
             if not license_list:
-                print("None of the file was found. '--copy_files' is ignored.")
+                print("WARNING: No file found. '--copy_files' option ignored.")
             else:
                 gen.copy_files(output_path, license_list)
 
     if extract_license:
         if not api_url or not api_username or not api_key:
-            print("Missing argument for --extract_license")
+            print("ERROR: Missing argument for --extract_license")
             sys.exit(errno.EINVAL)
         for line in input_list:
             try:
                 if line['dje_license_key']:
                     break
             except Exception as e:
                 print(repr(e))
-                print("The <input_path> CSV does not contain the required column 'dje_license_key' ")
+                print("ERROR: The <input_path> CSV does not contain the required column 'dje_license_key' ")
                 sys.exit(errno.EINVAL)
 
     if gen_license:

about_code_tool/genattrib.py

@@ -150,29 +150,29 @@ def main(parser, options, args):
 
     if mapping_config:
         if not exists('MAPPING.CONFIG'):
-            print("The 'MAPPING.CONFIG' file does not exist.")
+            print("ERROR: The 'MAPPING.CONFIG' file does not exist.")
             sys.exit(errno.EINVAL)
 
     if template_location:
         template_location = abspath(expanduser(template_location))
         if not exists(template_location):
-            print('The TEMPLATE_LOCATION file does not exist.')
+            print('ERROR: The TEMPLATE_LOCATION file does not exist.')
             parser.print_help()
             sys.exit(errno.EINVAL)
 
     if verification_location:
         verification_location = abspath(expanduser(verification_location))
         if not verification_location.endswith('.csv'):
-            print('The VERIFICATION_LOCATION path must end with ".csv".')
+            print('ERROR: The VERIFICATION_LOCATION file path must end with ".csv".')
             parser.print_help()
             sys.exit(errno.EINVAL)
         if not exists(dirname(verification_location)):
-            print('The VERIFICATION_LOCATION file parent directory does not exist.')
+            print('ERROR: The VERIFICATION_LOCATION file parent directory does not exist.')
             parser.print_help()
             sys.exit(errno.EINVAL)
 
     if not len(args) >= 2 or not len(args) < 4:
-        print('The number of arguments is incorrect.\n')
+        print('ERROR: The number of arguments is incorrect.')
         parser.print_help()
         sys.exit(errno.EEXIST)
 
@@ -194,7 +194,7 @@ def main(parser, options, args):
     sys.setdefaultencoding('utf-8')  # @UndefinedVariable
 
     if not exists(input_path):
-        print('<input_path> does not exist.')
+        print('ERROR: <input_path> does not exist.')
         parser.print_help()
         sys.exit(errno.EEXIST)
 
@@ -203,23 +203,23 @@ def main(parser, options, args):
         input_path = extract_zip(input_path)
 
     if isdir(output_path):
-        print('<output_path> must be an HTML file, not a directory')
+        print('ERROR: <output_path> must be an HTML file, not a directory')
         parser.print_help()
         sys.exit(errno.EISDIR)
 
     # We only support HTML currently
     if not output_path.endswith('.html'):
-        print('<output_path> must be an HTML file.')
+        print('ERROR: <output_path> must be an HTML file.')
         parser.print_help()
         sys.exit(errno.EINVAL)
 
     if exists(output_path) and not overwrite:
-        print('A file at <output_path> already exists. Select a different file name or use the --overwrite option.')
+        print('ERROR: A file at <output_path> already exists. Select a different file name or use the --overwrite option.')
         parser.print_help()
         sys.exit(errno.EEXIST)
 
     if component_subset_path and not exists(component_subset_path):
-        print('<component_list> CSV file does not exist.')
+        print('ERROR: the <component_list> CSV file does not exist.')
         parser.print_help()
         sys.exit(errno.EEXIST)
 
@@ -240,7 +240,7 @@ def main(parser, options, args):
                 abouts = apply_mappings(abouts)
 
             if not has_about_file_keys(abouts):
-                print('The required key "about_file" was not found.')
+                print('ERROR: The required column key "about_file" was not found in the <component_list> CSV file.')
                 print('Please use the "--mapping" option to map the input keys and verify the mapping information are correct.')
                 print('OR, correct the header keys from the component list.')
                 parser.print_help()