Merge pull request #79 from yucongalicechen/pkg

load package info

Author: sbillinge

src/diffpy/labpdfproc/labpdfprocapp.py

@@ -4,6 +4,7 @@
 from diffpy.labpdfproc.functions import apply_corr, compute_cve
 from diffpy.labpdfproc.tools import (
     known_sources,
+    load_package_info,
     load_user_info,
     load_user_metadata,
     set_input_lists,
@@ -111,6 +112,7 @@ def get_args(override_cli_inputs=None):
 
 def main():
     args = get_args()
+    args = load_package_info(args)
     args = load_user_info(args)
     args = set_input_lists(args)
     args.output_directory = set_output_directory(args)

src/diffpy/labpdfproc/tests/test_tools.py

@@ -7,6 +7,7 @@
 from diffpy.labpdfproc.labpdfprocapp import get_args
 from diffpy.labpdfproc.tools import (
     known_sources,
+    load_package_info,
     load_user_info,
     load_user_metadata,
     set_input_lists,
@@ -265,3 +266,14 @@ def test_load_user_info(monkeypatch, inputs, expected, user_filesystem):
     actual_args = load_user_info(actual_args)
     assert actual_args.username == expected_username
     assert actual_args.email == expected_email
+
+
+def test_load_package_info(mocker):
+    mocker.patch(
+        "importlib.metadata.version",
+        side_effect=lambda package_name: "3.3.0" if package_name == "diffpy.utils" else "1.2.3",
+    )
+    cli_inputs = ["2.5", "data.xy"]
+    actual_args = get_args(cli_inputs)
+    actual_args = load_package_info(actual_args)
+    assert actual_args.package_info == {"diffpy.labpdfproc": "1.2.3", "diffpy.utils": "3.3.0"}

src/diffpy/labpdfproc/tools.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from diffpy.utils.tools import get_user_info
+from diffpy.utils.tools import get_package_info, get_user_info
 
 WAVELENGTHS = {"Mo": 0.71, "Ag": 0.59, "Cu": 1.54}
 known_sources = [key for key in WAVELENGTHS.keys()]
@@ -194,3 +194,22 @@ def load_user_info(args):
     args.username = config["username"]
     args.email = config["email"]
     return args
+
+
+def load_package_info(args):
+    """
+    Load diffpy.labpdfproc package name and version into args using get_package_info function from diffpy.utils
+
+    Parameters
+    ----------
+    args argparse.Namespace
+        the arguments from the parser, default is None
+
+    Returns
+    -------
+    the updated argparse Namespace with diffpy.labpdfproc name and version inserted
+
+    """
+    metadata = get_package_info("diffpy.labpdfproc")
+    setattr(args, "package_info", metadata["package_info"])
+    return args