initial commit on loading username and email

Author: yucongalicechen

prevent_commit_to_main.sh

@@ -4,6 +4,7 @@
 from diffpy.labpdfproc.functions import apply_corr, compute_cve
 from diffpy.labpdfproc.tools import (
     known_sources,
+    load_user_info,
     load_user_metadata,
     set_input_lists,
     set_output_directory,
@@ -90,12 +91,33 @@ 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(
+        "-n",
+        "--username",
+        help="Your username. If not provided here, it can be specified in input "
+        "or stored in diffpyconfig.json in the current or home directory. "
+        "Existing config files prevent re-prompting. Values can be overridden here "
+        "but won't be saved to config files unless it's the first time specifying, "
+        "which saves to the config file in the home directory.",
+        default=None,
+    )
+    p.add_argument(
+        "-e",
+        "--email",
+        help="Your email. If not provided here, it can be specified in input "
+        "or stored in diffpyconfig.json in the current or home directory. "
+        "Existing config files prevent re-prompting. Values can be overridden here "
+        "but won't be saved to config files unless it's the first time specifying, "
+        "which saves to the config file in the home directory.",
+        default=None,
+    )
     args = p.parse_args(override_cli_inputs)
     return args
 
 
 def main():
     args = get_args()
+    args = load_user_info(args)
     args = set_input_lists(args)
     args.output_directory = set_output_directory(args)
     args.wavelength = set_wavelength(args)

src/diffpy/labpdfproc/labpdfprocapp.py

@@ -1,3 +1,4 @@
+import json
 from pathlib import Path
 
 import pytest
@@ -8,6 +9,10 @@ def user_filesystem(tmp_path):
     base_dir = Path(tmp_path)
     input_dir = base_dir / "input_dir"
     input_dir.mkdir(parents=True, exist_ok=True)
+    home_dir = base_dir / "home_dir"
+    home_dir.mkdir(parents=True, exist_ok=True)
+    cwd_dir = base_dir / "cwd_dir"
+    cwd_dir.mkdir(parents=True, exist_ok=True)
 
     chi_data = "dataformat = twotheta\n mode = xray\n # chi_Q chi_I\n 1 2\n 3 4\n 5 6\n 7 8\n"
     xy_data = "1 2\n 3 4\n 5 6\n 7 8"
@@ -44,4 +49,8 @@ def user_filesystem(tmp_path):
         f.write("good_data.xy \n")
         f.write(f"{str(input_dir.resolve() / 'good_data.txt')}\n")
 
+    home_config_data = {"username": "home_username", "email": "[email protected]"}
+    with open(home_dir / "diffpyconfig.json", "w") as f:
+        json.dump(home_config_data, f)
+
     yield tmp_path

src/diffpy/labpdfproc/tests/conftest.py

@@ -1,3 +1,4 @@
+import json
 import os
 import re
 from pathlib import Path
@@ -7,6 +8,7 @@
 from diffpy.labpdfproc.labpdfprocapp import get_args
 from diffpy.labpdfproc.tools import (
     known_sources,
+    load_user_info,
     load_user_metadata,
     set_input_lists,
     set_output_directory,
@@ -241,3 +243,119 @@ 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)
+
+
+def _setup_dirs(monkeypatch, user_filesystem):
+    cwd = Path(user_filesystem)
+    home_dir = cwd / "home_dir"
+    monkeypatch.setattr("pathlib.Path.home", lambda _: home_dir)
+    os.chdir(cwd)
+    return home_dir
+
+
+def _run_tests(inputs, expected):
+    expected_username, expected_email = expected
+    cli_inputs = ["2.5", "data.xy", "--username", inputs[0], "--email", inputs[1]]
+    actual_args = get_args(cli_inputs)
+    actual_args = load_user_info(actual_args)
+    assert actual_args.username == expected_username
+    assert actual_args.email == expected_email
+
+
+params_user_info_with_home_conf_file = [
+    (["", ""], ["home_username", "[email protected]"]),
+    (["cli_username", ""], ["cli_username", "[email protected]"]),
+    (["", "[email protected]"], ["home_username", "[email protected]"]),
+    ([None, None], ["home_username", "[email protected]"]),
+    (["cli_username", None], ["cli_username", "[email protected]"]),
+    ([None, "[email protected]"], ["home_username", "[email protected]"]),
+    (["cli_username", "[email protected]"], ["cli_username", "[email protected]"]),
+]
+params_user_info_with_local_conf_file = [
+    (["", ""], ["cwd_username", "[email protected]"]),
+    (["cli_username", ""], ["cli_username", "[email protected]"]),
+    (["", "[email protected]"], ["cwd_username", "[email protected]"]),
+    ([None, None], ["cwd_username", "[email protected]"]),
+    (["cli_username", None], ["cli_username", "[email protected]"]),
+    ([None, "[email protected]"], ["cwd_username", "[email protected]"]),
+    (["cli_username", "[email protected]"], ["cli_username", "[email protected]"]),
+]
+params_user_info_with_no_home_conf_file = [
+    (
+        [None, None],
+        ["input_username", "[email protected]"],
+        ["input_username", "[email protected]"],
+    ),
+    (
+        ["cli_username", None],
+        ["", "[email protected]"],
+        ["cli_username", "[email protected]"],
+    ),
+    (
+        [None, "[email protected]"],
+        ["input_username", ""],
+        ["input_username", "[email protected]"],
+    ),
+    (
+        ["", ""],
+        ["input_username", "[email protected]"],
+        ["input_username", "[email protected]"],
+    ),
+    (
+        ["cli_username", ""],
+        ["", "[email protected]"],
+        ["cli_username", "[email protected]"],
+    ),
+    (
+        ["", "[email protected]"],
+        ["input_username", ""],
+        ["input_username", "[email protected]"],
+    ),
+    (
+        ["cli_username", "[email protected]"],
+        ["input_username", "[email protected]"],
+        ["cli_username", "[email protected]"],
+    ),
+]
+params_user_info_no_conf_file_no_inputs = [
+    ([None, None], ["", ""], ["", ""]),
+]
+
+
+@pytest.mark.parametrize("inputs, expected", params_user_info_with_home_conf_file)
+def test_load_user_info_with_home_conf_file(monkeypatch, inputs, expected, user_filesystem):
+    _setup_dirs(monkeypatch, user_filesystem)
+    _run_tests(inputs, expected)
+
+
+@pytest.mark.parametrize("inputs, expected", params_user_info_with_local_conf_file)
+def test_load_user_info_with_local_conf_file(monkeypatch, inputs, expected, user_filesystem):
+    _setup_dirs(monkeypatch, user_filesystem)
+    local_config_data = {"username": "cwd_username", "email": "[email protected]"}
+    with open(Path(user_filesystem) / "diffpyconfig.json", "w") as f:
+        json.dump(local_config_data, f)
+    _run_tests(inputs, expected)
+    os.remove(Path().home() / "diffpyconfig.json")
+    _run_tests(inputs, expected)
+
+
+@pytest.mark.parametrize("inputsa, inputsb, expected", params_user_info_with_no_home_conf_file)
+def test_load_user_info_with_no_home_conf_file(monkeypatch, inputsa, inputsb, expected, user_filesystem):
+    _setup_dirs(monkeypatch, user_filesystem)
+    os.remove(Path().home() / "diffpyconfig.json")
+    inp_iter = iter(inputsb)
+    monkeypatch.setattr("builtins.input", lambda _: next(inp_iter))
+    _run_tests(inputsa, expected)
+    confile = Path().home() / "diffpyconfig.json"
+    assert confile.is_file()
+
+
+@pytest.mark.parametrize("inputsa, inputsb, expected", params_user_info_no_conf_file_no_inputs)
+def test_load_user_info_no_conf_file_no_inputs(monkeypatch, inputsa, inputsb, expected, user_filesystem):
+    _setup_dirs(monkeypatch, user_filesystem)
+    os.remove(Path().home() / "diffpyconfig.json")
+    inp_iter = iter(inputsb)
+    monkeypatch.setattr("builtins.input", lambda _: next(inp_iter))
+    _run_tests(inputsa, expected)
+    confile = Path().home() / "diffpyconfig.json"
+    assert confile.exists() is False

src/diffpy/labpdfproc/tests/test_tools.py

@@ -1,5 +1,7 @@
 from pathlib import Path
 
+from diffpy.utils.tools import get_user_info
+
 WAVELENGTHS = {"Mo": 0.71, "Ag": 0.59, "Cu": 1.54}
 known_sources = [key for key in WAVELENGTHS.keys()]
 
@@ -171,3 +173,24 @@ def load_user_metadata(args):
             setattr(args, key, value)
     delattr(args, "user_metadata")
     return args
+
+
+def load_user_info(args):
+    """
+    Update username and email using get_user_info function from diffpy.utils
+
+    Parameters
+    ----------
+    args argparse.Namespace
+        the arguments from the parser, default is None
+
+    Returns
+    -------
+    the updated argparse Namespace with username and email inserted
+
+    """
+    config = {"username": args.username, "email": args.email}
+    config = get_user_info(config)
+    args.username = config["username"]
+    args.email = config["email"]
+    return args