detquantlib 3.1.2__tar.gz → 3.2.0__tar.gz

{detquantlib-3.1.2 → detquantlib-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: detquantlib
-Version: 3.1.2
+Version: 3.2.0
 Summary: An internal library containing functions and classes that can be used across Quant models.
 Author: DET
 Requires-Python: >=3.10,<4.0
@@ -80,6 +80,15 @@ Classes:
 - `Entsoe`:
   - `from detquantlib.data import Entsoe`
   - `from detquantlib.data.entsoe.entsoe import Entsoe`
+- `OutputItem`:
+  - `from detquantlib.outputs import OutputItem`
+  - `from detquantlib.outputs.outputs_interface import OutputItem`
+- `OutputSet`:
+  - `from detquantlib.outputs import OutputSet`
+  - `from detquantlib.outputs.outputs_interface import OutputSet`
+- `PathDefinitions`:
+  - `from detquantlib.outputs import PathDefinitions`
+  - `from detquantlib.outputs.outputs_interface import PathDefinitions`
 - `Sftp`:
   - `from detquantlib.data import Sftp`
   - `from detquantlib.data.sftp.sftp import Sftp`

{detquantlib-3.1.2 → detquantlib-3.2.0}/README.md

@@ -60,6 +60,15 @@ Classes:
 - `Entsoe`:
   - `from detquantlib.data import Entsoe`
   - `from detquantlib.data.entsoe.entsoe import Entsoe`
+- `OutputItem`:
+  - `from detquantlib.outputs import OutputItem`
+  - `from detquantlib.outputs.outputs_interface import OutputItem`
+- `OutputSet`:
+  - `from detquantlib.outputs import OutputSet`
+  - `from detquantlib.outputs.outputs_interface import OutputSet`
+- `PathDefinitions`:
+  - `from detquantlib.outputs import PathDefinitions`
+  - `from detquantlib.outputs.outputs_interface import PathDefinitions`
 - `Sftp`:
   - `from detquantlib.data import Sftp`
   - `from detquantlib.data.sftp.sftp import Sftp`

detquantlib-3.2.0/detquantlib/outputs/__init__.py

@@ -0,0 +1,3 @@
+from .outputs_interface import OutputItem, OutputSet, PathDefinitions
+
+__all__ = ["OutputItem", "OutputSet", "PathDefinitions"]

detquantlib-3.2.0/detquantlib/outputs/outputs_interface.py

@@ -0,0 +1,182 @@
+# Python built-in packages
+import json
+from pathlib import Path
+
+# Third-party packages
+import numpy as np
+import pandas as pd
+import plotly.graph_objects as go
+
+
+class OutputItem:
+    """A class to easily manage, store and export a model output."""
+
+    def __init__(
+        self, data=None, filename: str = None, extension: str = None, sub_path: str = None
+    ):
+        """
+        Constructor method.
+
+        Args:
+            data: Output data
+            filename: Filename to be used when exporting the output data
+            extension: File extension to be used when exporting the output data
+            sub_path: Within the output base directory, indicates the sub-path (if any) of the
+                folder where the output data should be exported
+        """
+        self.data = data
+        self.filename = filename
+        self.extension = extension
+        self.sub_path = sub_path
+
+    def export_to_file(self, folder_dir: Path = None):
+        """
+        Exports the model output to a file.
+
+        Args:
+            folder_dir: Base directory of the folder containing all model outputs
+
+        Raises:
+            ValueError: Raises an error if the output file extension is not supported
+        """
+        # Define output folder directory, and create it if it doesn't exist yet
+        if folder_dir is None:
+            folder_dir = PathDefinitions.get_outputs_folder_dir()
+        if self.sub_path is not None:
+            folder_dir = folder_dir.joinpath(self.sub_path)
+        folder_dir.mkdir(parents=True, exist_ok=True)
+
+        # Define output file directory
+        filename = f"{self.filename}.{self.extension}"
+        file_dir = folder_dir.joinpath(filename)
+
+        # Create output file
+        if self.extension == "csv":
+            self.export_to_csv(file_dir)
+        elif self.extension == "json":
+            self.export_to_json(file_dir)
+        elif self.extension == "html":
+            self.export_to_html(file_dir)
+        elif self.extension == "npz":
+            self.export_to_npz(file_dir)
+        else:
+            raise ValueError("Invalid output file extension.")
+
+    def export_to_csv(self, file_dir: Path):
+        """
+        Exports the model output to a csv file.
+
+        Args:
+            file_dir: Directory of the output file
+
+        Raises:
+            TypeError: Raises an error if the data type is not supported
+        """
+        data_type = type(self.data)
+        if data_type is pd.DataFrame:
+            self.data.to_csv(file_dir, sep=",", index=False)
+        else:
+            raise TypeError(f"Exporting data type {data_type} to csv file is not supported.")
+
+    def export_to_json(self, file_dir: Path):
+        """
+        Exports the model output to a json file.
+
+        Args:
+            file_dir: Directory of the output file
+
+        Raises:
+            TypeError: Raises an error if the data type is not supported
+        """
+        data_type = type(self.data)
+        if data_type is dict:
+            with open(file_dir, "w") as f:
+                json.dump(self.data, f, indent=4)
+        else:
+            raise TypeError(f"Exporting data type {data_type} to json file is not supported.")
+
+    def export_to_html(self, file_dir: Path):
+        """
+        Exports the model output to a html file.
+
+        Args:
+            file_dir: Directory of the output file
+
+        Raises:
+            TypeError: Raises an error if the data type is not supported
+        """
+        data_type = type(self.data)
+        if data_type is go.Figure:
+            self.data.write_html(file_dir)
+        else:
+            raise TypeError(f"Exporting data type {data_type} to html file is not supported.")
+
+    def export_to_npz(self, file_dir: Path):
+        """
+        Exports the model output to a npz file.
+
+        Args:
+            file_dir: Directory of the output file
+
+        Raises:
+            TypeError: Raises an error if the data type is not supported
+        """
+        data_type = type(self.data)
+        if data_type is np.ndarray:
+            np.savez_compressed(file_dir, data=self.data)
+        else:
+            raise TypeError(f"Exporting data type {data_type} to npz file is not supported.")
+
+
+class OutputSet:
+    """A short class to store all OutputItem objects into a single object."""
+
+    def __init__(self, output_items: list[OutputItem] = None):
+        """
+        Constructor method.
+
+        Args:
+            output_items: List of OutputItem objects
+        """
+        if output_items is None:
+            output_items = list()
+        self.output_items = output_items
+
+    def add_item(self, data, filename: str, extension: str, sub_path: str = None):
+        """
+        Creates an OutputItem object and adds it to the OutputSet list.
+
+        Args:
+            data: Output data
+            filename: Filename to be used when exporting the output data
+            extension: File extension to be used when exporting the output data
+            sub_path: Within the output base directory, indicates the sub-path (if any) of the
+                folder where the output data should be exported
+        """
+        # Create OutputItem object
+        item = OutputItem(data=data, filename=filename, extension=extension, sub_path=sub_path)
+        # Append to OutputSet list
+        self.output_items.append(item)
+
+
+class PathDefinitions:
+    """A class containing hard-coded path definitions."""
+
+    @staticmethod
+    def outputs_folder():
+        return "Outputs"
+
+    @staticmethod
+    def outputs_plotly_folder():
+        return "PlotlyFigures"
+
+    @staticmethod
+    def get_outputs_folder_dir():
+        # Base directory of the folder containing all model outputs
+        return Path.cwd().joinpath(PathDefinitions.outputs_folder())
+
+    @staticmethod
+    def get_outputs_plotly_folder_dir():
+        # Directory of the output folder containing all plotly figures
+        base_dir = PathDefinitions.get_outputs_folder_dir()
+        return base_dir.joinpath(PathDefinitions.outputs_plotly_folder())

{detquantlib-3.1.2 → detquantlib-3.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "detquantlib"
-version = "3.1.2"
+version = "3.2.0"
 description = "An internal library containing functions and classes that can be used across Quant models."
 authors = ["DET"]
 readme = "README.md"