parse_units_and_comments initial impl (WIP)

Author: softwareengineerprogrammer

src/geophires_x_client/geophires_input_parameters.py

@@ -1,4 +1,6 @@
 import csv
+import json
+import os
 import tempfile
 import uuid
 from dataclasses import dataclass
@@ -231,22 +233,48 @@ def as_csv(self, parse_units_and_comments: bool = False) -> str:
             raise NotImplementedError('CSV from file path is not implemented.')
 
         if parse_units_and_comments:
-            raise NotImplementedError  # FIXME WIP
+
+            def _get_file_path(file_name: str | Path) -> str:
+                return os.path.join(os.path.abspath(os.path.dirname(__file__)), str(file_name))
+
+            with open(_get_file_path('../geophires_x_schema_generator/geophires-request.json'), encoding='utf-8') as f:
+                request_schema: dict[str, Any] = json.loads(f.read())
 
         f = StringIO()
         w = csv.writer(f)
 
         def _row_entries(param_name: str, param_value_raw: str) -> list[str]:
-            value_entry = param_value_raw
+            value_entry = (str(param_value_raw) if param_value_raw is not None else '').strip()
             units_entry = ''
             comment_entry = ''
+
+            if parse_units_and_comments:
+                # TODO consolidate with other codebase parameter parsing logic...
+                param_schema = request_schema['properties'].get(param_name, {param_name: {}})
+
+                value_non_value_split = (
+                    value_entry.split(' ', maxsplit=1)
+                    if not param_schema.get('type') == 'array'
+                    else value_entry.split(', --', maxsplit=1)
+                )
+                value_entry = value_non_value_split[0]
+                unit_and_comment_split = (
+                    value_non_value_split[1].split(' --', maxsplit=1) if len(value_non_value_split) > 1 else ['', '']
+                )
+
+                default_units_for_param = param_schema.get('units', '')
+                units_entry = unit_and_comment_split[0] if unit_and_comment_split[0] != '' else default_units_for_param
+
+                if len(unit_and_comment_split) > 1:
+                    comment_entry = unit_and_comment_split[1]
+
             return [
                 'INPUT PARAMETERS',
                 param_name,
                 '',  # Year column, N/A for input parameters
                 value_entry,
                 units_entry,
-                # comment_entry
+                comment_entry,
             ]
 
         w.writerows([_row_entries(key, value) for key, value in self.params.items()])

tests/test_geophires_x_client.py

@@ -655,8 +655,8 @@ def test_csv_with_input_parameters(self):
         # Ensure the returned CSV are as expected.
         csv_lines = csv_result.splitlines()
         self.assertEqual('Category,Field,Year,Value,Units', csv_lines[0])
-        self.assertEqual('INPUT PARAMETERS,Reservoir Depth,,3,', csv_lines[1])
-        self.assertEqual('INPUT PARAMETERS,Gradient 1,,50,', csv_lines[2])
+        self.assertEqual('INPUT PARAMETERS,Reservoir Depth,,3,,', csv_lines[1])
+        self.assertEqual('INPUT PARAMETERS,Gradient 1,,50,,', csv_lines[2])
         self.assertEqual('SUMMARY OF RESULTS,End-Use Option,,Direct-Use Heat,', csv_lines[3])
         self.assertEqual(
             'HEAT AND/OR ELECTRICITY EXTRACTION AND GENERATION PROFILE,PERCENTAGE OF TOTAL HEAT MINED,25,42.7,%',
@@ -667,3 +667,21 @@ def test_csv_with_input_parameters(self):
         result_file = Path(tempfile.gettempdir(), f'geophires-result_{uuid.uuid1()!s}.csv')
         with open(result_file, 'w', newline='', encoding='utf-8') as rf:
             rf.write(csv_result)
+
+    def test_csv_with_input_parameters_parse_units_and_comments(self):
+        csv_input_with_units_and_comments = ImmutableGeophiresInputParameters(
+            params={
+                'Reservoir Depth': '3000 m',
+                'Gradient 1': 50,
+                'End-Use Option': '1, -- Direct-Use Heat',
+                'Construction CAPEX Schedule': '0.014,0.027,0.139,0.431,0.389',
+                'Drawdown Parameter Schedule': '0.003,0.001,0.0 * 10,0.001 * 3,0.002 * 3,0.003 * 3,0.004 * 3,0.005 * 4,0.006, -- No drawdown for first 10 years, then 0.005/year',
+            }
+        ).as_csv(parse_units_and_comments=True)
+
+        # Export the CSV for testing in Excel (or other spreadsheet software).
+        result_file = Path(tempfile.gettempdir(), f'geophires-result_{uuid.uuid1()!s}.csv')
+        with open(result_file, 'w', newline='', encoding='utf-8') as rf:
+            rf.write(csv_input_with_units_and_comments)
+
+        self.assertIsNotNone(csv_input_with_units_and_comments)  # FIXME WIP