suppress capex schedule adjustment warning if Print Output to Console is not enabled

Author: softwareengineerprogrammer

src/geophires_x/EconomicsSam.py

@@ -44,12 +44,11 @@
     _TOTAL_AFTER_TAX_RETURNS_CASH_FLOW_ROW_NAME,
     PreRevenueCostsAndCashflow,
     calculate_pre_revenue_costs_and_cashflow,
-    _calculate_pre_revenue_costs_and_cashflow,
     adjust_phased_schedule_to_new_length,
 )
 from geophires_x.GeoPHIRESUtils import is_float, is_int, sig_figs, quantity
 from geophires_x.OptionList import EconomicModel, EndUseOptions
-from geophires_x.Parameter import Parameter, OutputParameter, floatParameter
+from geophires_x.Parameter import Parameter, OutputParameter, floatParameter, listParameter
 from geophires_x.Units import convertible_unit, EnergyCostUnit, CurrencyUnit, Units
 
 
@@ -199,7 +198,7 @@ def _inv_msg(param_name: str, invalid_value: Any, supported_description: str) ->
     econ.construction_capex_schedule.value = _validate_construction_capex_schedule(
         econ.construction_capex_schedule,
         model.surfaceplant.construction_years.value,
-        model.logger,
+        model,
     )
 
     construction_years = model.surfaceplant.construction_years.value
@@ -211,7 +210,7 @@ def _inv_msg(param_name: str, invalid_value: Any, supported_description: str) ->
 
 
 def _validate_construction_capex_schedule(
-    econ_capex_schedule: listParameter, construction_years: int, model_logger
+    econ_capex_schedule: listParameter, construction_years: int, model: Model
 ) -> list[float]:
     capex_schedule: list[float] = econ_capex_schedule.value.copy()
 
@@ -227,11 +226,16 @@ def _validate_construction_capex_schedule(
 
     if len(adjust_schedule_reasons) > 0:
         capex_schedule = adjust_phased_schedule_to_new_length(econ_capex_schedule.value, construction_years)
-        msg = f'{econ_capex_schedule.Name} ({econ_capex_schedule.value}) '
-        msg += ' and '.join(adjust_schedule_reasons)
-        msg += f'. It has been adjusted to: {capex_schedule}'
 
-        model_logger.warning(msg)
+        if model.outputs.printoutput:
+            # Use printoutput as a proxy for whether the user has requested logging;
+            #  TODO to implement/support logging-specific config
+
+            msg = f'{econ_capex_schedule.Name} ({econ_capex_schedule.value}) '
+            msg += ' and '.join(adjust_schedule_reasons)
+            msg += f'. It has been adjusted to: {capex_schedule}'
+
+            model.logger.warning(msg)
 
     return capex_schedule
 

tests/geophires_x_tests/test_economics_sam.py

@@ -295,7 +295,8 @@ def _sum(cf_row_name: str, abs_val: bool = False) -> float:
         )
 
     def test_validate_construction_capex_schedule(self):
-        model_logger = self._new_model(self._egs_test_file_path()).logger
+        model = self._new_model(self._egs_test_file_path(), {'Print Output to Console': 1})
+        model_logger = model.logger
 
         def _sched(sched: list[float]) -> listParameter:
             construction_capex_schedule_name = 'Construction CAPEX Schedule'
@@ -310,14 +311,12 @@ def _sched(sched: list[float]) -> listParameter:
             return schedule_param
 
         half_half = [0.5, 0.5]
-        self.assertListEqual(half_half, _validate_construction_capex_schedule(_sched(half_half), 2, model_logger))
+        self.assertListEqual(half_half, _validate_construction_capex_schedule(_sched(half_half), 2, model))
 
         try:
             with self.assertLogs(logger=model_logger.name, level='WARNING') as logs:
                 quarters = [0.25] * 4
-                self.assertListEqual(
-                    half_half, _validate_construction_capex_schedule(_sched(quarters), 2, model_logger)
-                )
+                self.assertListEqual(half_half, _validate_construction_capex_schedule(_sched(quarters), 2, model))
                 self.assertHasLogRecordWithMessage(
                     logs, 'has been adjusted to: [0.5, 0.5]', treat_substring_match_as_match=True
                 )
@@ -327,9 +326,7 @@ def _sched(sched: list[float]) -> listParameter:
         try:
             with self.assertLogs(logger=model_logger.name, level='WARNING') as logs2:
                 double_ones = [1.0, 1.0]
-                self.assertListEqual(
-                    half_half, _validate_construction_capex_schedule(_sched(double_ones), 2, model_logger)
-                )
+                self.assertListEqual(half_half, _validate_construction_capex_schedule(_sched(double_ones), 2, model))
                 self.assertHasLogRecordWithMessage(logs2, 'does not sum to 1.0', treat_substring_match_as_match=True)
         except AssertionError as ae:
             self._handle_assert_logs_failure(ae)