feat: config workflow for wavelength / anode type #169
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #169 +/- ##
==========================================
+ Coverage 99.21% 99.32% +0.11%
==========================================
Files 5 5
Lines 254 297 +43
==========================================
+ Hits 252 295 +43
Misses 2 2
|
| @@ -159,6 +160,33 @@ def set_input_lists(args): | |||
| return args | |||
|
|
|||
|
|
|||
| def _load_wavelength_from_config_file(args): | |||
| """Load wavelength and anode type from config files. | |||
| It takes cli inputs first, and local config, and then global config. | |||
There was a problem hiding this comment.
there should be a blank line before this.
Also, I suggest to make this not private.
| # C3: anode type provided, expect to return args unchanged | ||
| (["--anode-type", "Mo"], {"wavelength": None, "anode_type": "Mo"}), | ||
| # C4: both wavelength and anode type provided, | ||
| # expect to return args unchanged |
There was a problem hiding this comment.
Is this what we want? I think it should be either wavelength or anode_type. If both are provided raise an exception.
| # C3: anode type provided, expect to return args unchanged | ||
| (["--anode-type", "Mo"], {"wavelength": None, "anode_type": "Mo"}), | ||
| # C4: both wavelength and anode type provided, | ||
| # expect to return args unchanged |
There was a problem hiding this comment.
I agree that the tests should be the same here, as they are, but we then need to modify the last test in both places.
Also maybe mention in the preamble that the home config file has wavelength of 0.3 and the local config has wavelength of 0.6 to make the test easier to read.
A thought occurred to me that maybe having both wavelength and anode_type specified is tested elsewhere and you do want to return both values here but have it fail in a test elsewhere, but i fthat is the case, say it explicitly in the comment about the test.
| "inputs, expected", | ||
| [ | ||
| # Test when no config files exist, | ||
| # expect to return args without modification. |
There was a problem hiding this comment.
here don't we expect it to run the "create config" workflow if no wavelength/anode_type is specified?
There was a problem hiding this comment.
Yeah I think the idea is that this function just updates the correct args. The error will be reported when we set the wavelength etc. I will add a comment here.
For the create config workflow, I think we discussed that we might not want to make it too complicated for users?
There was a problem hiding this comment.
I am not sure what we discussed. We created to the "create config workflow" to be as intuitive to use as possible. After that it should just be a choice in apps (a) use it (b) don't use it, so I am not sure I understand your statement about making things not complicated for users.
closes #160
@sbillinge ready for review