Fix/update input comments unit test case. Add comments explaining list parameter parsing/special-casing

Author: softwareengineerprogrammer

src/geophires_x/Parameter.py

@@ -383,6 +383,9 @@ def default_parameter_value_message(new_val: Any, param_to_modify_name: str, def
                     ParamToModify.value.pop(position)
                     ParamToModify.value.insert(position, New_val)
             else:
+                # In an ideal world this would be handled in ParameterEntry such that its sValue and Comment are
+                # correct; however that would only be practical if ParameterEntry had typing information to know
+                # whether to treat text after a second comma as a comment or list entry.
                 ParamToModify.value = [float(x.strip()) for x in ParameterReadIn.raw_entry.split('--')[0].split(',')[1:]
                                        if x.strip() != '']
     elif isinstance(ParamToModify, boolParameter):

tests/geophires_x_client_tests/input_comments.txt

@@ -7,6 +7,8 @@ Gradient 1, 69
 Reservoir Depth, 5, -- comment here
 End-Use Option, 1, # another comment
 Power Plant Type, 4, comments galore
+Gradients, 10, 20, 30, 40, -- gradiance
+Thicknesses, 3,2, 1
 
 # another, comment, with, commas, down here
  # comment with space

tests/test_geophires_utils.py

@@ -538,10 +538,36 @@ def test_input_comments(self):
         self.assertDictEqual(
             d,
             {
-                'Gradient 1': ParameterEntry(Name='Gradient 1', sValue='69', Comment=''),
-                'Reservoir Depth': ParameterEntry(Name='Reservoir Depth', sValue='5', Comment='-- comment here'),
-                'End-Use Option': ParameterEntry(Name='End-Use Option', sValue='1', Comment='# another comment'),
-                'Power Plant Type': ParameterEntry(Name='Power Plant Type', sValue='4', Comment='comments galore'),
+                'Gradient 1': ParameterEntry(Name='Gradient 1', sValue='69', Comment='', raw_entry='Gradient 1, 69'),
+                'Reservoir Depth': ParameterEntry(
+                    Name='Reservoir Depth',
+                    sValue='5',
+                    Comment='-- comment here',
+                    raw_entry='Reservoir Depth, 5, -- comment here',
+                ),
+                'End-Use Option': ParameterEntry(
+                    Name='End-Use Option',
+                    sValue='1',
+                    Comment='# another comment',
+                    raw_entry='End-Use Option, 1, # another comment',
+                ),
+                'Power Plant Type': ParameterEntry(
+                    Name='Power Plant Type',
+                    sValue='4',
+                    Comment='comments galore',
+                    raw_entry='Power Plant Type, 4, comments galore',
+                ),
+                # Note sValue and Comment are, obviously, inaccurate for list-type parameters - this is handled in
+                # geophires_x.Parameter.ReadParameter where raw_entry value is parsed instead.
+                'Gradients': ParameterEntry(
+                    Name='Gradients',
+                    sValue='10',
+                    Comment=' 20 30 40 -- gradiance',
+                    raw_entry='Gradients, 10, 20, 30, 40, -- gradiance',
+                ),
+                'Thicknesses': ParameterEntry(
+                    Name='Thicknesses', sValue='3', Comment='2 1', raw_entry='Thicknesses, 3,2, 1'
+                ),
             },
         )