From 24085c446c1bdeda339c2c287cc2c929718dc3f5 Mon Sep 17 00:00:00 2001
From: Thomas Kluyver <thomas.kluyver@xfel.eu>
Date: Thu, 28 Nov 2024 09:50:39 +0000
Subject: [PATCH] Condense two non-reproducibility checks into one
---
src/xfel_calibrate/nb_args.py | 58 +++++++++++++++--------------------
1 file changed, 24 insertions(+), 34 deletions(-)
diff --git a/src/xfel_calibrate/nb_args.py b/src/xfel_calibrate/nb_args.py
index 98fe0feb1..f63265ca7 100644
--- a/src/xfel_calibrate/nb_args.py
+++ b/src/xfel_calibrate/nb_args.py
@@ -411,32 +411,6 @@ def parse_argv_and_load_nb(argv) -> Tuple[Dict, NBDetails]:
print("Not one of the known calibrations or detectors")
sys.exit(1)
- # Pick out any arguments that may prevent reproducibility from
- # working, sorted alphabetically and converted back to their
- # canonical representation.
- not_reproducible_args = sorted(
- ('--' + x.replace('_', '-')
- for x in ['skip_env_freeze']
- if getattr(args, x))
- )
-
- # If any of these arguments are set, present a warning.
- if not_reproducible_args:
- print('WARNING: One or more command line arguments ({}) may prevent '
- 'this specific correction result from being reproducible based '
- 'on its metadata. It may not be possible to restore identical '
- 'output data files when they have been deleted or lost. Please '
- 'ensure that the data retention policy of the chosen storage '
- 'location is sufficient for your '
- 'needs.'.format(', '.join(not_reproducible_args)))
-
- if not args.not_reproducible:
- # If not explicitly specified that reproducibility may be
- # broken, remind the user and exit.
- print('To proceed, you can explicitly allow reproducibility to '
- 'be broken by adding --not-reproducible')
- sys.exit(1)
-
if nb_info["notebook"]:
notebook = os.path.join(PKG_DIR, nb_info["notebook"])
else:
@@ -477,18 +451,34 @@ def parse_argv_and_load_nb(argv) -> Tuple[Dict, NBDetails]:
arg_dict = deconsolize_args(vars(parser.parse_args(argv[1:])))
- not_reproducible_params = [
+ # Pick out any arguments that may prevent reproducibility from
+ # working
+ not_reproducible_args = [
+ x for x in ['skip_env_freeze']
+ if getattr(args, x)
+ ] + [
p for p in nb.metadata.get("euxfel_not_reproducible_params", [])
if p in arg_dict and arg_dict[p] != default_values[p]
]
- if not_reproducible_params:
- print(f"WARNING: you have specified parameters ({', '.join(not_reproducible_params)}) "
- f"which may interfere with reproducibility, potentially making it "
- f"impossible to reconstruct the resulting data in the future.")
- if not args.not_reproducible:
- sys.exit("To continue anyway, re-run the command with the "
- "--not-reproducible flag.")
+ # If any of these arguments are set, present a warning.
+ if not_reproducible_args:
+ fmted = ', '.join(sorted('--' + x.replace('_', '-')
+ for x in not_reproducible_args))
+ print(f'WARNING: One or more command line arguments ({fmted}) may prevent '
+ 'this specific correction result from being reproducible based '
+ 'on its metadata. It may not be possible to restore identical '
+ 'output data files when they have been deleted or lost. Please '
+ 'ensure that the data retention policy of the chosen storage '
+ 'location is sufficient for your '
+ 'needs.')
+
+ if not args.not_reproducible:
+ # If not explicitly specified that reproducibility may be
+ # broken, remind the user and exit.
+ print('To proceed, you can explicitly allow reproducibility to '
+ 'be broken by adding --not-reproducible')
+ sys.exit(1)
user_venv = nb_info.get("user", {}).get("venv")
if user_venv is not None:
--
GitLab