Move OutputTableItem to separate OutputsUtils.py in preparation for refactoring AddOns/S-DAC output/rich output flow

Author: softwareengineerprogrammer

src/geophires_x/OutputsAddOns.py

@@ -1,7 +1,7 @@
 import sys
 import pandas as pd
 from geophires_x.Outputs import Outputs
-from geophires_x.OutputsRich import OutputTableItem
+from geophires_x.OutputsUtils import OutputTableItem
 
 NL = "\n"
 
@@ -10,13 +10,13 @@ class OutputsAddOns(Outputs):
     """
     Class to handle output of the AddOns values
     """
-    def PrintOutputs(self, model) -> tuple:
+    def PrintOutputs(self, model) -> tuple[pd.DataFrame, list]:
 
         """
         The PrintOutputs function prints the results of the AddOns to a text file and to the screen.
         :param model: Model: The container class of the application, giving access to everything else, including the logger
         :type model: :class:`~geophires_x.Model.Model`
-        :return: tuple of addon_df, addon_results: list[OutputTableItem]
+        :return: tuple of addon_df, addon_results
         """
         model.logger.info(f'Init {str(__class__)}: {__name__}')
 

src/geophires_x/OutputsRich.py

@@ -1,4 +1,3 @@
-import dataclasses
 import datetime
 import string
 import time
@@ -20,6 +19,7 @@
 from geophires_x.MatplotlibUtils import plt_subplots
 from geophires_x.OptionList import EndUseOptions, PlantType, EconomicModel, ReservoirModel, FractureShape, \
     ReservoirVolume
+from geophires_x.OutputsUtils import OutputTableItem
 
 from geophires_x.Parameter import intParameter, strParameter
 
@@ -30,20 +30,6 @@
 VERTICAL_WELL_DEPTH_OUTPUT_NAME = 'Well depth'
 
 
-@dataclasses.dataclass
-class OutputTableItem:
-    parameter: str = ''
-    value: str = ''
-    units: str = ''
-
-    def __init__(self, parameter: str, value: str = '', units: str = ''):
-        self.parameter = parameter
-        self.value = value
-        self.units = units
-        if self.units:
-            self.units = UpgradeSymbologyOfUnits(self.units)
-
-
 def print_outputs_rich(output_file: str, text_output_file: strParameter, html_output_file: strParameter, model: Model):
     """
     TODO Implementation of rich output in this method/file is duplicative of Outputs.PrintOutputs. This adds undue

src/geophires_x/OutputsS_DAC_GT.py

@@ -1,7 +1,7 @@
 import sys
 import pandas as pd
 from geophires_x.Outputs import Outputs
-from geophires_x.OutputsRich import OutputTableItem
+from geophires_x.OutputsUtils import OutputTableItem
 
 NL = "\n"
 

src/geophires_x/OutputsUtils.py

@@ -0,0 +1,17 @@
+import dataclasses
+
+from geophires_x.GeoPHIRESUtils import UpgradeSymbologyOfUnits
+
+
+@dataclasses.dataclass
+class OutputTableItem:
+    parameter: str = ''
+    value: str = ''
+    units: str = ''
+
+    def __init__(self, parameter: str, value: str = '', units: str = ''):
+        self.parameter = parameter
+        self.value = value
+        self.units = units
+        if self.units:
+            self.units = UpgradeSymbologyOfUnits(self.units)