Adding force overwrite command line flag.

Author: astronomerritt

src/sorcha/utilities/sorcha_copy_configs.py

@@ -7,7 +7,7 @@
 from sorcha.modules.PPConfigParser import PPFindDirectoryOrExit
 
 
-def copy_demo_configs(copy_location, which_configs):
+def copy_demo_configs(copy_location, which_configs, force_overwrite):
     """
     Copies the example Sorcha configuration files to a user-specified location.
 
@@ -19,6 +19,9 @@ def copy_demo_configs(copy_location, which_configs):
     which_configs : string
         String indicating which configuration files to retrieve. Should be "rubin", "demo" or "all".
 
+    force_overwrite: boolean
+        Flag for determining whether existing files should be overwritten.
+
     Returns
     -----------
     None
@@ -49,6 +52,9 @@ def copy_demo_configs(copy_location, which_configs):
         )
 
     for config in config_locations:
+        if not force_overwrite and os.path.isfile(config):
+            sys.exit("Identical file exists at location. Re-run with -f or --force to force overwrite.")
+
         shutil.copy(config, copy_location)
 
     print("Example configuration files {} copied to {}.".format(config_locations, copy_location))
@@ -91,10 +97,10 @@ def main():
     to a user-specified location. Filepath to copy files to is specified by command-line
     flag. Selection of configuration files is done via user input.
 
-    usage: sorcha_copy_configs [-h] [-f FILEPATH]
+    usage: sorcha_copy_configs [-h] [-p PATH]
         arguments:
           -h, --help                                  Show this help message and exit.
-          [-f FILEPATH, --filename FILEPATH]          Filepath where you want to copy the config files. Default is current working directory.
+          [-p PATH, --path PATH]          Filepath where you want to copy the config files. Default is current working directory.
 
     Parameters
     -----------
@@ -111,13 +117,21 @@ def main():
     )
 
     parser.add_argument(
-        "-f",
-        "--filepath",
+        "-p",
+        "--path",
         help="Filepath where you want to copy the config files. Default is current working directory.",
         type=str,
         default="./",
     )
 
+    parser.add_argument(
+        "-f",
+        "--force",
+        help="Force deletion/overwrite of existing config file(s). Default False.",
+        action="store_true",
+        default=False,
+    )
+
     args = parser.parse_args()
 
     print("\nWhich configuration file(s) would you like to copy?:\n")
@@ -128,8 +142,8 @@ def main():
 
     which_configs = parse_file_selection(file_select)
 
-    copy_location = os.path.abspath(args.filepath)
-    copy_demo_configs(copy_location, which_configs)
+    copy_location = os.path.abspath(args.path)
+    copy_demo_configs(copy_location, which_configs, args.force)
 
 
 if __name__ == "__main__":

tests/sorcha/test_sorcha_copy_configs.py

@@ -6,11 +6,11 @@ def test_sorcha_copy_configs(tmp_path):
     from sorcha.utilities.sorcha_copy_configs import copy_demo_configs
 
     # test that the Rubin files are successfully copied
-    copy_demo_configs(tmp_path, "rubin_circle")
+    copy_demo_configs(tmp_path, "rubin_circle", True)
 
     assert os.path.isfile(os.path.join(tmp_path, "Rubin_circular_approximation.ini"))
 
-    copy_demo_configs(tmp_path, "rubin_footprint")
+    copy_demo_configs(tmp_path, "rubin_footprint", True)
 
     assert os.path.isfile(os.path.join(tmp_path, "Rubin_full_footprint.ini"))
 
@@ -19,29 +19,36 @@ def test_sorcha_copy_configs(tmp_path):
     os.remove(os.path.join(tmp_path, "Rubin_full_footprint.ini"))
 
     # test that all the configs are successfully copied
-    copy_demo_configs(tmp_path, "all")
+    copy_demo_configs(tmp_path, "all", True)
 
     assert os.path.isfile(os.path.join(tmp_path, "Rubin_circular_approximation.ini"))
     assert os.path.isfile(os.path.join(tmp_path, "Rubin_full_footprint.ini"))
 
     # test the error message if user supplies non-existent directory
     dummy_folder = os.path.join(tmp_path, "dummy_folder")
     with pytest.raises(SystemExit) as e:
-        copy_demo_configs(dummy_folder, "all")
+        copy_demo_configs(dummy_folder, "all", True)
 
     assert e.value.code == "ERROR: filepath {} supplied for filepath argument does not exist.".format(
         dummy_folder
     )
 
     # test the error message if user supplies unrecognised keyword for which_configs variable
     with pytest.raises(SystemExit) as e2:
-        copy_demo_configs(tmp_path, "laphroaig")
+        copy_demo_configs(tmp_path, "laphroaig", True)
 
     assert (
         e2.value.code
         == "String 'laphroaig' not recognised for 'configs' variable. Must be 'rubin_circle', 'rubin_footprint' or 'all'."
     )
 
+    # test tthe error message if file exists and overwrite isn't forced
+
+    with pytest.raises(SystemExit) as e3:
+        copy_demo_configs(tmp_path, "rubin_footprint", False)
+
+    assert e3.value.code == "Identical file exists at location. Re-run with -f or --force to force overwrite."
+
 
 def test_parse_file_selection():
     from sorcha.utilities.sorcha_copy_configs import parse_file_selection