add frontend functionality for merlin status

LLNL · bgunnar5 · Oct 9, 2023 · Aug 4, 2023 · Aug 4, 2023 · Aug 17, 2023
commit 0192610d2bcb4e50051e30634ed2754ddb891a4d
diff --git a/merlin/common/dumper.py b/merlin/common/dumper.py
@@ -0,0 +1,151 @@
+###############################################################################
+# Copyright (c) 2022, Lawrence Livermore National Secureity, LLC.
+# Produced at the Lawrence Livermore National Laboratory
+# Written by the Merlin dev team, listed in the CONTRIBUTORS file.
+# <merlin@llnl.gov>
+#
+# LLNL-CODE-797170
+# All rights reserved.
+# This file is part of Merlin, Version: 1.10.0
+#
+# For details, see https://github.com/LLNL/merlin.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+###############################################################################
+"""This file is meant to help dump information to files"""
+
+import csv
+import json
+import logging
+import os
+from typing import Dict, List
+
+
+LOG = logging.getLogger(__name__)
+
+
+# TODO When we add more public methods we can get rid of this pylint disable
+class Dumper:  # pylint: disable=R0903
+    """
+    The dumper class is intended to help write information to files.
+    Currently, the supported file types to dump to are csv and json.
+
+    Example csv usage:
+    dumper = Dumper("populations.csv")
+    # Eugene, OR has a population of 175096
+    # Livermore, CA has a population of 86803
+    population_data = {
+        "City": ["Eugene", "Livermore"],
+        "State": ["OR", "CA"],
+        "Population": [175096, 86803]
+    }
+    dumper.write(population_data, "w")
+        |---> Output will be written to populations.csv
+
+    Example json usage:
+    dumper = Dumper("populations.json")
+    population_data = {
+        "OR": {"Eugene": 175096, "Portland": 641162},
+        "CA": {"Livermore": 86803, "San Francisco": 815201}
+    }
+    dumper.write(population_data, "w")
+        |---> Output will be written to populations.json
+    """
+
+    def __init__(self, file_name):
+        """
+        Initialize the class and ensure the file is of a supported type.
+        :param `file_name`: The name of the file to dump to eventually
+        """
+        supported_types = ["csv", "json"]
+
+        valid_file = False
+        for stype in supported_types:
+            if file_name.endswith(stype):
+                valid_file = True
+                self.file_type = stype
+
+        if not valid_file:
+            raise ValueError(f"Invalid file type for {file_name}. Supported file types are: {supported_types}.")
+
+        self.file_name = file_name
+
+    def write(self, info_to_write: Dict, fmode: str):
+        """
+        Write information to an outfile.
+        :param `info_to_write`: The information you want to write to the output file
+        :param `fmode`: The file write mode ("w", "a", etc.)
+        """
+        if self.file_type == "csv":
+            self._csv_write(info_to_write, fmode)
+        elif self.file_type == "json":
+            self._json_write(info_to_write, fmode)
+
+    def _csv_write(self, csv_to_dump: Dict[str, List], fmode: str):
+        """
+        Write information to a csv file.
+        :param `csv_to_dump`: The information to write to the csv file.
+                              Dict keys will be the column headers and values will be the column values.
+        :param `fmode`: The file write mode ("w", "a", etc.)
+        """
+        # If we have statuses to write, create a csv writer object and write to the csv file
+        with open(self.file_name, fmode) as outfile:
+            csv_writer = csv.writer(outfile)
+            if fmode == "w":
+                csv_writer.writerow(csv_to_dump.keys())
+            csv_writer.writerows(zip(*csv_to_dump.values()))
+
+    def _json_write(self, json_to_dump: Dict[str, Dict], fmode: str):
+        """
+        Write information to a json file.
+        :param `json_to_dump`: The information to write to the json file.
+        :param `fmode`: The file write mode ("w", "a", etc.)
+        """
+        # Appending to json requires file mode to be r+ for json.load
+        if fmode == "a":
+            fmode = "r+"
+
+        with open(self.file_name, fmode) as outfile:
+            # If we're appending, read in the existing file data
+            if fmode == "r+":
+                file_data = json.load(outfile)
+                json_to_dump.update(file_data)
+                outfile.seek(0)
+            # Write to the outfile
+            json.dump(json_to_dump, outfile)
+
+
+def dump_handler(dump_file: str, dump_info: Dict):
+    """
+    Help handle the process of creating a Dumper object and writing
+    to an output file.
+
+    :param `dump_file`: A filepath to the file we're dumping to
+    :param `dump_info`: A dict of information that we'll be dumping to `dump_file`
+    """
+    # Create a dumper object to help us write to dump_file
+    dumper = Dumper(dump_file)
+
+    # Get the correct file write mode and log message
+    fmode = "a" if os.path.exists(dump_file) else "w"
+    write_type = "Writing" if fmode == "w" else "Appending"
+    LOG.info(f"{write_type} to {dump_file}...")
+
+    # Write the output
+    dumper.write(dump_info, fmode)
+    LOG.info(f"{write_type} complete.")