Initial commit to load datetime automatically with datetime function.

Author: stevenhua0320

src/diffpy/labpdfproc/labpdfprocapp.py

@@ -89,6 +89,13 @@ def get_args(override_cli_inputs=None):
         "For example, facility='NSLS II', 'facility=NSLS II', beamline=28ID-2, "
         "'beamline'='28ID-2', 'favorite color'=blue, are all valid key=value items. ",
     )
+    p.add_argument(
+        "-t"
+        "--is-test",
+        action="store_true",
+        help="If this flag is specified, the app would be run in test mode. No need for general users to specify this "
+             "flag",
+        )
     args = p.parse_args(override_cli_inputs)
     return args
 

src/diffpy/labpdfproc/tests/test_tools.py

@@ -2,6 +2,9 @@
 import re
 from pathlib import Path
 
+import freezegun
+from freezegun import freeze_time
+from datetime import datetime
 import pytest
 
 from diffpy.labpdfproc.labpdfprocapp import get_args
@@ -12,6 +15,7 @@
     set_input_lists,
     set_output_directory,
     set_wavelength,
+    load_datetime
 )
 
 # Use cases can be found here: https://github.com/diffpy/diffpy.labpdfproc/issues/48
@@ -153,7 +157,7 @@ def test_set_wavelength(inputs, expected):
 params3 = [
     (
         ["--anode-type", "invalid"],
-        [f"Anode type not recognized. Please rerun specifying an anode_type from {*known_sources, }."],
+        [f"Anode type not recognized. Please rerun specifying an anode_type from {*known_sources,}."],
     ),
     (
         ["--wavelength", "0"],
@@ -232,3 +236,18 @@ def test_load_user_metadata_bad(inputs, msg):
     actual_args = get_args(cli_inputs)
     with pytest.raises(ValueError, match=msg[0]):
         actual_args = load_user_metadata(actual_args)
+
+
+params7 = [(["--user-metadata", "facility=NSLS II", "beamline=28ID-2", "favorite color=blue"],
+            [["facility", "NSLS II"], ["beamline", "28ID-2"], ["favorite color", "blue"],
+             ["datetime", "2014-02-01 12:34:56"]])]
+
+
+@freezegun.freeze_time("2014-02-01 12:34:56")
+@pytest.mark.parametrize("inputs, expected", params7)
+def test_load_datetime(inputs, expected):
+    actual_inputs = ["2.5", "data.xy"] + inputs
+    actual_args = get_args(actual_inputs)
+    time_loaded_args = load_datetime(actual_args)
+    actual_args = load_user_metadata(time_loaded_args)
+    assert actual_args == expected

src/diffpy/labpdfproc/tools.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from pathlib import Path
 
 WAVELENGTHS = {"Mo": 0.71, "Ag": 0.59, "Cu": 1.54}
@@ -165,3 +166,24 @@ def load_user_metadata(args):
             setattr(args, key, value)
     delattr(args, "user_metadata")
     return args
+
+
+def load_datetime(args):
+    """
+    Load datetime into the provided argparse Namespace.
+
+    Parameters
+    ----------
+    args argparse.Namespace
+        the arguments from the parser
+
+    Returns
+    -------
+    the updated argparse Namespace with datetime inserted as key-value pairs
+    """
+    if args.user_metadata:
+        curr_time = datetime.now()
+        setattr(args, "datetime", curr_time.strftime("%Y-%m-%d %H:%M:%S"))
+    return args
+
+