Skip to content

Load package + version, datetime of analysis into metadata #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/diffpy/labpdfproc/tests/test_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
import re
from pathlib import Path

import freezegun
import pytest

from diffpy.labpdfproc.labpdfprocapp import get_args
from diffpy.labpdfproc.tools import (
known_sources,
load_datetime,
load_package_version,
load_user_metadata,
set_input_lists,
set_output_directory,
Expand Down Expand Up @@ -241,3 +244,25 @@ 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 = [(["2.5", "data.xy"], {"package_version": "0.1.0"})]


@pytest.mark.parametrize("inputs, expected", params7)
def test_load_package_version(inputs, expected, monkeypatch):
monkeypatch.setattr("importlib.metadata.version", lambda _: expected["package_version"])
actual_inputs = get_args(inputs)
actual_args = load_package_version(actual_inputs)
assert actual_args.package_version == expected["package_version"]


params8 = [(["2.5", "data.xy"], ["2024-05-21 17:18:19"])]


@pytest.mark.parametrize("inputs, expected_time", params8)
def test_load_datetime(inputs, expected_time):
with freezegun.freeze_time("2024-05-21 17:18:19"):
actual_inputs = get_args(inputs)
actual_args = load_datetime(actual_inputs)
assert actual_args.creation_time == expected_time
39 changes: 39 additions & 0 deletions src/diffpy/labpdfproc/tools.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
from datetime import datetime
from pathlib import Path

from pip._internal.metadata import importlib

WAVELENGTHS = {"Mo": 0.71, "Ag": 0.59, "Cu": 1.54}
known_sources = [key for key in WAVELENGTHS.keys()]

Expand Down Expand Up @@ -171,3 +174,39 @@ def load_user_metadata(args):
setattr(args, key, value)
delattr(args, "user_metadata")
return args


def load_package_version(args):
"""
Load package version into the provided argparse Namespace.

Parameters
----------
args argparse.Namespace
the arguments from the parser

Returns
-------
the updated argparse Namespace with package version inserted as key-value pairs
"""
package_version = importlib.metadata.version("diffpy.labpdfproc")
setattr(args, "package_version", package_version)
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
"""
curr_time = datetime.now()
setattr(args, "creation_time", curr_time)
return args
Loading