addressed comments so far

Author: yucongalicechen

src/diffpy/labpdfproc/labpdfprocapp.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 
 from diffpy.labpdfproc.functions import apply_corr, compute_cve
-from diffpy.labpdfproc.tools import load_additional_info
+from diffpy.labpdfproc.tools import load_user_metadata
 from diffpy.utils.parsers.loaddata import loadData
 from diffpy.utils.scattering_objects.diffraction_objects import XQUANTITIES, Diffraction_object
 
@@ -37,7 +37,7 @@ def get_args():
     p.add_argument(
         "-x",
         "--xtype",
-        help=f"the quantity on the independnt variable axis. allowed "
+        help=f"the quantity on the independent variable axis. allowed "
         f"values: {*XQUANTITIES, }. If not specified then two-theta "
         f"is assumed for the independent variable. Only implemented for "
         f"tth currently",
@@ -55,23 +55,23 @@ def get_args():
         "-f",
         "--force-overwrite",
         action="store_true",
-        help="outputs will not overwrite existing file unless --force is spacified",
+        help="outputs will not overwrite existing file unless --force is specified",
     )
     p.add_argument(
-        "-add",
-        "--additional-info",
+        "-u",
+        "--user-metadata",
         metavar=("KEY=VALUE"),
         action="append",
         help="specify key-value pairs to be loaded into metadata by using key=value. "
-        "You can specify multiple paris by calling -add multiple times.",
+        "You can specify multiple paris by calling -u multiple times.",
     )
     args = p.parse_args()
     return args
 
 
 def main():
     args = get_args()
-    args = load_additional_info(args)
+    args = load_user_metadata(args)
     wavelength = WAVELENGTHS[args.anode_type]
     filepath = Path(args.input_file)
     outfilestem = filepath.stem + "_corrected"

src/diffpy/labpdfproc/tests/test_tools.py

@@ -2,29 +2,26 @@
 
 import pytest
 
-from diffpy.labpdfproc.tools import load_additional_info
+from diffpy.labpdfproc.tools import load_user_metadata
 
 params5 = [
-    ([], []),
-    ([["weather=rainy"]], [["weather", "rainy"]]),
+    ([[]], []),
+    ([["toast=for breakfast"]], [["toast", "for breakfast"]]),
+    ([["mylist=[1,2,3.0]"]], [["mylist", "[1,2,3.0]"]]),
     ([["weather=rainy", "day=tuesday"]], [["weather", "rainy"], ["day", "tuesday"]]),
 ]
 
 
 @pytest.mark.parametrize("inputs, expected", params5)
 def test_load_additional_info(inputs, expected):
     actual_parser = ArgumentParser()
-    actual_parser.add_argument("-add", "--additional-info", action="append", metavar=("KEY=VALUE"))
+    actual_parser.add_argument("-u", "--user-metadata", action="append", metavar=("KEY=VALUE"))
     actual_args = actual_parser.parse_args([])
     expected_parser = ArgumentParser()
     expected_args = expected_parser.parse_args([])
 
-    if not inputs:
-        actual_args = load_additional_info(actual_args)
-        assert actual_args == expected_args
-    else:
-        setattr(actual_args, "additional_info", inputs[0])
-        actual_args = load_additional_info(actual_args)
-        for expected_pair in expected:
-            setattr(expected_args, expected_pair[0], expected_pair[1])
-        assert actual_args == expected_args
+    setattr(actual_args, "user_metadata", inputs[0])
+    actual_args = load_user_metadata(actual_args)
+    for expected_pair in expected:
+        setattr(expected_args, expected_pair[0], expected_pair[1])
+    assert actual_args == expected_args

src/diffpy/labpdfproc/tools.py

@@ -1,7 +1,19 @@
-def load_additional_info(args):
-    if args.additional_info:
-        for item in args.additional_info:
-            key, value = item.split("=")
+import sys
+
+
+def load_user_metadata(args):
+    if args.user_metadata:
+        for item in args.user_metadata:
+            if not item:
+                sys.exit(
+                    "please provide at least one key-value pair in the format key=value. "
+                    "you can exclude -add if you don't want to provide additional info."
+                )
+            if "=" not in item:
+                sys.exit("please provide key-value pairs in the format key=value.")
+            key, value = item.split("=", 1)
+            # if "=" in value:
+            #    sys.exit("please use only one equals sign for key=value.")
             setattr(args, key, value)
-    delattr(args, "additional_info")
+    delattr(args, "user_metadata")
     return args