Breakout ecm_prep shared methods and variable classes in separate modules.

Author: aspeake

scout/config.py

@@ -9,8 +9,7 @@
 
 
 class LogConfig:
-    """Configure the logger
-    """
+    """Configure the logger"""
 
     @staticmethod
     def configure_logging():

scout/ecm_prep.py

@@ -13,8 +13,8 @@
 import numpy_financial as npf
 from datetime import datetime
 from scout.plots import run_plot
-from scout.config import FilePaths as fp
-from scout.config import Config
+from scout.config import Config, FilePaths as fp
+from scout.utils import PrintFormat as fmt
 import warnings
 
 
@@ -5022,9 +5022,6 @@ def main(opts: argparse.NameSpace):  # noqa: F821
         of key results to an output JSON.
     """
 
-    # Set function that only prints message when in verbose mode
-    verboseprint = print if opts.verbose else lambda *a, **k: None
-
     # Raise numpy errors as exceptions
     numpy.seterr('raise')
     # Initialize user opts variable (elements: S-S calculation method;
@@ -5268,7 +5265,7 @@ def main(opts: argparse.NameSpace):  # noqa: F821
             # Reset measure fuel split attribute to imported values
             m.eff_fs_splt = meas_eff_fs_data
         # Print data import message for each ECM if in verbose mode
-        verboseprint("Imported ECM '" + m.name + "' competition data")
+        fmt.verboseprint(opts.verbose, f"Imported ECM {m.name} competition data")
 
     # Import total absolute heating and cooling energy use data, used in
     # removing overlaps between supply-side and demand-side heating/cooling
@@ -5355,12 +5352,12 @@ def main(opts: argparse.NameSpace):  # noqa: F821
     try:
         elec_carb = elec_cost_carb['CO2 intensity of electricity']['data']
         elec_cost = elec_cost_carb['End-use electricity price']['data']
-        fmt = True  # Boolean for indicating data key substructure
+        format_data = True  # Boolean for indicating data key substructure
     except KeyError:
         # Data are structured as in the site_source_co2_conversions files
         elec_carb = elec_cost_carb['electricity']['CO2 intensity']['data']
         elec_cost = elec_cost_carb['electricity']['price']['data']
-        fmt = False
+        format_data = False
 
     # Determine regions and building types used by active measures for
     # aggregating onsite generation data
@@ -5401,7 +5398,7 @@ def variable_depth_dict(): return defaultdict(variable_depth_dict)
             else:
                 bt_bin = 'commercial'
             # Get CO2 intensity and electricity cost data and convert units
-            if fmt:  # Data (and data structure) from emm_region files
+            if format_data:  # Data (and data structure) from emm_region files
                 # Convert Mt/TWh to Mt/MMBtu
                 carbtmp = {k: elec_carb[cz].get(k, 0)/3.41214e6
                            for k in elec_carb[cz].keys()}

scout/ecm_prep_vars.py

@@ -0,0 +1,75 @@
+import json
+import numpy
+from pathlib import Path, PurePath
+
+
+class JsonIO:
+    @classmethod
+    def load_json(cls, filepath: Path) -> dict:
+        """Loads data from a .json file
+
+        Args:
+            filepath (pathlib.Path): filepath of .json file
+
+        Returns:
+            dict: .json data as a dict
+        """
+        with open(filepath, 'r') as handle:
+            try:
+                data = json.load(handle)
+            except ValueError as e:
+                raise ValueError(f"Error reading in '{filepath}': {str(e)}") from None
+        return data
+
+    @classmethod
+    def dump_json(cls, data, filepath: Path):
+        """Export data to .json file
+
+        Args:
+            data: data to write to .json file
+            filepath (pathlib.Path): filepath of .json file
+        """
+        with open(filepath, "w") as handle:
+            json.dump(data, handle, indent=2, cls=MyEncoder)
+
+
+class MyEncoder(json.JSONEncoder):
+    """Convert numpy arrays to list for JSON serializing."""
+
+    def default(self, obj):
+        """Modify 'default' method from JSONEncoder."""
+        # Case where object to be serialized is numpy array
+        if isinstance(obj, numpy.ndarray):
+            return obj.tolist()
+        if isinstance(obj, PurePath):
+            return str(obj)
+        # All other cases
+        else:
+            return super(MyEncoder, self).default(obj)
+
+
+class PrintFormat:
+    """Class for customizing print messages."""
+
+    @classmethod
+    def custom_showwarning(cls, message, category, filename, lineno, file=None, line=None):
+        """Define a custom warning message format."""
+        # Other message details suppressed because error location and type are not relevant
+        print(message)
+
+    @classmethod
+    def verboseprint(cls, verbose, msg):
+        """Print input message when the code is run in verbose mode.
+
+        Args:
+            verbose (boolean): Indicator of verbose mode
+            msg (string): Message to print to console when in verbose mode
+
+        Returns:
+            Printed console message when code is run in verbose mode.
+        """
+        print(msg) if verbose else lambda *a, **k: None
+
+    @classmethod
+    def format_console_list(cls, list_to_format):
+        return [f"  {elem}\n" for elem in list_to_format]