Enhance GUI to support generating CSV file and specifying log level

Author: gitname

gui.py

@@ -1,12 +1,27 @@
 import PySimpleGUI as sg
+from uuid import uuid4
+from os import path
 from main import main
 
 sg.theme('Default1')  # alternatives include, e.g., 'DarkGrey9'
 
-layout = [[sg.Text('Select a folder and CSV file, then click the Launch button.')],
-          [sg.Text('Folder', size=(8, 1)), sg.Input(), sg.FolderBrowse()],
-          [sg.Text('CSV File', size=(8, 1)), sg.Input(), sg.FileBrowse(file_types=["CSV .csv"])],
-          [sg.Button('Launch')]]
+layout = [[sg.Text('Select a folder, a CSV file and, optionally, an output folder, then click the Launch button.')],
+          [sg.Text('Folder', size=(17, 1)), sg.Input(key="-FOLDER-"), sg.FolderBrowse()],
+          [sg.Text('CSV File', size=(17, 1)), sg.Input(key="-CSV_FILE-"), sg.FileBrowse(file_types=["CSV .csv"])],
+          [
+              sg.Text('Output Folder (optional)', size=(17, 1), tooltip='If specified, the main script will generate '
+                                                                        'a CSV file in this folder'),
+              sg.Input(key="-OUTPUT_FOLDER-"),
+              sg.FolderBrowse()
+          ],
+          [
+              sg.Text('Log level', size=(17, 1)),
+              sg.Radio('NOTSET (default)', "log_level_radio_group", key="-NOTSET-", default=True),
+              sg.Radio('DEBUG', "log_level_radio_group", key="-DEBUG-"),
+              sg.Radio('INFO', "log_level_radio_group", key="-INFO-"),
+              sg.Radio('WARNING', "log_level_radio_group", key="-WARNING-"),
+          ],
+          [sg.Button('Launch', tooltip='Launch the main script with the specified parameters')]]
 
 # Create the Window
 window = sg.Window('dupeguru-post-processor (Graphical Launcher)', layout)
@@ -19,10 +34,52 @@
         break
     # Else, if the user clicked the Launch button, invoke the script's main function.
     elif event == 'Launch':
-        path_to_folder = values[0]
-        path_to_csv_file = values[1]
+        # Retrieve and strip input values.
+        path_to_folder = values["-FOLDER-"].strip()
+        path_to_csv_file = values["-CSV_FILE-"].strip()
+        path_to_output_folder = values["-OUTPUT_FOLDER-"].strip()
 
-        print("\nLaunching dupeguru-post-processor...\n")
-        main(path_to_folder, path_to_csv_file)
+        # Normalize the log level.
+        log_level = "DEBUG" if values["-DEBUG-"] \
+            else "INFO" if values["-INFO-"] \
+            else "WARNING" if values["-WARNING-"] \
+            else "NOTSET"
+
+        # Validate stripped input values.
+        if not path.isdir(path_to_folder):
+            sg.Popup("Folder path is invalid", keep_on_top=True)
+            continue  # end this iteration
+        elif not path.isfile(path_to_csv_file):
+            sg.Popup("CSV file path is invalid", keep_on_top=True)
+            continue
+        elif len(path_to_output_folder) > 0 and not path.isdir(path_to_output_folder):
+            sg.Popup("Output folder (optional) path was specified, but is invalid", keep_on_top=True)
+            continue
+
+        # If the user specified an output _folder_, generate an output file path; otherwise, default to None.
+        path_to_output_file = None
+        if len(path_to_output_folder) > 0:
+            # Keep trying to generate a random file name that does not already exist.
+            #
+            # Note: This is not a foolproof way of preventing naming collisions. It is technically possible that some
+            #       other process creates a file at the same path, between now (i.e. the time we perform this name
+            #       collision check) and the time the main script creates a file at that path.
+            #
+            while True:
+                random_file_name = f"{uuid4().hex}.csv"
+                path_to_output_file = path.join(path_to_output_folder, random_file_name)
+                if not path.isfile(path_to_output_file):
+                    break  # stop iterating once we have a unique file name
+            print(f"Output file path: {path.normpath(path_to_output_file)}\n")
+
+        print("Launching dupeguru-post-processor...\n")
+        main(
+            path.normpath(path_to_folder),
+            path.normpath(path_to_csv_file),
+            path.normpath(path_to_output_file),
+            log_level=log_level
+        )
+
+        sg.Popup("Done.", keep_on_top=True)
 
 window.close()

main.py

@@ -68,9 +68,13 @@ def get_file_paths_from_csv_file(path_to_csv_file):
         return file_paths
 
 
-def main(path_to_folder, path_to_csv_file, path_to_output_file=None):
+def main(path_to_folder, path_to_csv_file, path_to_output_file=None, log_level=logging.NOTSET):
     """Entrypoint to the script."""
 
+    # Configure logging so entries are sent to STDOUT and so the threshold level is the one specified.
+    level = logging.getLevelName(log_level) if type(log_level) is str else log_level
+    logging.basicConfig(stream=sys.stdout, level=level)
+
     logging.info(f'Folder       : {path_to_folder}')
     logging.info(f'dupeGuru CSV : {path_to_csv_file}')
     logging.info(f'Output file  : {path_to_output_file}')
@@ -95,13 +99,15 @@ def main(path_to_folder, path_to_csv_file, path_to_output_file=None):
 
     # Either write the results to a CSV file or print them to STDOUT.
     if type(path_to_output_file) is str:
-        with open(path_to_output_file, 'w', newline='') as f:
+        with open(path_to_output_file, 'w', encoding='utf-8', newline='') as f:
             writer = csv.writer(f)
             rows = [[path] for path in sorted_differences]  # gives `rows` the shape: `[ [path_1], [path_2], ... ]`
             writer.writerows(rows)
     else:
         print('\n'.join(sorted_differences))
 
+    print("\nDone.\n")
+
 
 if __name__ == '__main__':
     parser = argparse.ArgumentParser(description='Compares a folder to a CSV file exported from dupeGuru. Displays the '
@@ -118,7 +124,4 @@ def main(path_to_folder, path_to_csv_file, path_to_output_file=None):
                         help='specify a logging level for the script')
     args = parser.parse_args()
 
-    # Configure logging so entries are sent to STDOUT and so the threshold level is the one specified.
-    logging.basicConfig(stream=sys.stdout, level=logging.getLevelName(args.log_level))
-
-    main(args.folder, args.csv_file, args.output_csv_file)
+    main(args.folder, args.csv_file, args.output_csv_file, args.log_level)