consolidate tabulation into shared method

Author: softwareengineerprogrammer

src/geophires_x/EconomicsSam.py

@@ -21,8 +21,10 @@
 
 # noinspection PyPackageRequirements
 import PySAM.Utilityrate5 as UtilityRate
+from tabulate import tabulate
 
 import geophires_x.Model as Model
+from geophires_x import Model as Model
 from geophires_x.EconomicsSamCashFlow import _calculate_sam_economics_cash_flow
 from geophires_x.Parameter import Parameter
 from geophires_x.Units import convertible_unit
@@ -89,6 +91,16 @@ def calculate_sam_economics(model: Model) -> dict[str, dict[str, Any]]:
     return ret
 
 
+def get_sam_cash_flow_profile_tabulated_output(model: Model, **tabulate_kw_args) -> str:
+    """
+    Note model must have already calculated economics for this to work (used in Outputs)
+    """
+
+    _tabulate_kw_args = {'tablefmt': 'tsv', 'floatfmt': '.2f', 'intfmt': ',', **tabulate_kw_args}
+
+    return tabulate(model.economics.sam_economics.value[_SAM_CASH_FLOW_PROFILE_KEY], **_tabulate_kw_args)
+
+
 def _get_utility_rate_parameters(model: Model) -> dict[str, Any]:
     econ = model.economics
 

src/geophires_x/EconomicsSamCashFlow.py

@@ -10,7 +10,7 @@
 
 from PySAM import Singleowner
 
-from geophires_x import Model as Model
+import geophires_x.Model as Model
 
 
 @lru_cache(maxsize=12)

src/geophires_x/Outputs.py

@@ -9,7 +9,7 @@
 import geophires_x
 import geophires_x.Model as Model
 from geophires_x.Economics import Economics
-from geophires_x.EconomicsSam import _SAM_CASH_FLOW_PROFILE_KEY
+from geophires_x.EconomicsSam import get_sam_cash_flow_profile_tabulated_output
 from geophires_x.OutputsRich import print_outputs_rich
 from geophires_x.Parameter import ConvertUnitsBack, ConvertOutputUnits, LookupUnits, strParameter, boolParameter, \
     OutputParameter, ReadParameter
@@ -770,16 +770,7 @@ def get_sam_cash_flow_profile_output(self, model):
         ret += '                            *  SAM CASH FLOW PROFILE  *\n'
         ret += '                            ***************************\n'
 
-        ret += tabulate(
-            model.economics.sam_economics.value[_SAM_CASH_FLOW_PROFILE_KEY],
-            # tablefmt='pretty',
-            # tablefmt='psql',
-            # tablefmt='simple_grid',
-            #tablefmt='fancy_grid',
-            tablefmt='tsv',
-            floatfmt='.2f',
-            # headers='keys'
-        )
+        ret += get_sam_cash_flow_profile_tabulated_output(model)
 
         return ret
 

tests/geophires_x_tests/test_economics_sam.py

@@ -5,7 +5,6 @@
 from pathlib import Path
 from typing import Any
 
-from tabulate import tabulate
 
 from base_test_case import BaseTestCase
 
@@ -18,6 +17,7 @@
     _sig_figs,
     _SAM_CASH_FLOW_PROFILE_KEY,
     _GEOPHIRES_TO_SAM_PRICING_MODEL_RATE_CONVERSION_CONSTANT,
+    get_sam_cash_flow_profile_tabulated_output,
 )
 
 # noinspection PyProtectedMember
@@ -81,13 +81,13 @@ def test_cash_flow(self):
         self.assertIsNotNone(cash_flow)
 
         print(
-            tabulate(
-                cash_flow,
+            get_sam_cash_flow_profile_tabulated_output(
+                m,
+                # cash_flow,
                 # tablefmt='pretty',
                 # tablefmt='psql',
                 # tablefmt='simple_grid',
                 tablefmt='fancy_grid',
-                floatfmt='.2f',
                 # headers='keys'
             )
         )