Merge pull request #7 from DesignBuilderSoftware/split-writer

split-writer

Author: voightp

db_temperature_distribution/parser.py

@@ -1,7 +1,6 @@
 """Define functions to extract and parse EnergyPlus temperature distribution."""
 
 
-import csv
 import re
 from collections import defaultdict
 from pathlib import Path
@@ -100,36 +99,25 @@ def format_time_bins(all_time_bins: Dict[str, Dict[str, Table]]) -> Dict[str, Ta
     return formatted_time_bins
 
 
-def write_tables(all_time_bins: Dict[str, Table], directory: Path) -> List[Path]:
-    """Write time bins to a given directory."""
-    output_paths = []
-    for temperature, time_bins in all_time_bins.items():
-        filename = f"Distribution - {temperature}.csv"
-        path = Path(directory, filename)
-        with open(path, mode="w", newline="", encoding="utf-8") as csv_file:
-            writer = csv.writer(csv_file)
-            writer.writerows(time_bins)
-        output_paths.append(path)
-    return output_paths
-
-
-def process_time_bins(html_path: Path, destination_dir: Path) -> List[Path]:
+def process_time_bins(html_path: Path) -> Dict[str, Table]:
     """
     Read source html file and write parsed time bins to .csv.
 
     Arguments
     ---------
     html_path : Path
         A path to energyplus html summary file.
-    destination_dir : Path
-        A path to directory to place output file / files.
+
+    Returns
+    -------
+    dict of {str, Table}
+        Processed time bins for all temperature types.
 
     """
     tables = read_html(html_path)
     time_bins_dict = find_time_bins(tables)
     if time_bins_dict:
-        formatted_time_bins = format_time_bins(time_bins_dict)
-        return write_tables(formatted_time_bins, destination_dir)
+        return format_time_bins(time_bins_dict)
     raise NoTemperatureDistribution(
         f"File '{html_path}' does not include temperature distribution time bins."
     )

db_temperature_distribution/writer.py

@@ -0,0 +1,34 @@
+"""Define functions to writer parsed tables to various formats."""
+import csv
+from pathlib import Path
+from typing import Dict, List
+
+from db_temperature_distribution.parser import Table
+
+
+def write_tables(all_time_bins: Dict[str, Table], directory: Path) -> List[Path]:
+    """
+    Write time bins to a given directory.
+
+    Arguments
+    ---------
+    all_time_bins : Dict of {str, Table}
+        Parsed time bins for all temperature ypes.
+    directory : Path
+        A path to directory to place output file / files.
+
+    Returns
+    -------
+    list of Path
+        Paths of all output files.
+
+    """
+    output_paths = []
+    for temperature, time_bins in all_time_bins.items():
+        filename = f"Distribution - {temperature}.csv"
+        path = Path(directory, filename)
+        with open(path, mode="w", newline="", encoding="utf-8") as csv_file:
+            writer = csv.writer(csv_file)
+            writer.writerows(time_bins)
+        output_paths.append(path)
+    return output_paths

main.py

@@ -4,6 +4,7 @@
 
 from db_temperature_distribution.logger import Logger
 from db_temperature_distribution.parser import process_time_bins
+from db_temperature_distribution.writer import write_tables
 
 if __name__ == "__main__":
     energyplus_folder = os.path.expandvars(r"%LOCALAPPDATA%\DesignBuilder\EnergyPlus")
@@ -37,7 +38,8 @@
     args = parser.parse_args()
     html_path = Path(args.source_path)
     with Logger(show_dialogs=not args.no_dialogs) as logger:
-        output_paths = process_time_bins(html_path, Path(args.dest_dir))
+        parsed_time_bins = process_time_bins(html_path)
+        output_paths = write_tables(parsed_time_bins, Path(args.dest_dir))
         file_list = "\t-".join(map(str, output_paths))
         message = f"Temperature distribution time bins are stored in:\n{file_list}"
         logger.print_message("Success!", message)

tests/test_db_temperature_distribution.py

@@ -7,6 +7,7 @@
     NoTemperatureDistribution,
     process_time_bins,
 )
+from db_temperature_distribution.writer import write_tables
 
 
 def read_csv(path):
@@ -16,12 +17,17 @@ def read_csv(path):
 
 
 @pytest.fixture(scope="module", autouse=True)
-def parse_timebins(html_path, test_tempdir):
-    return process_time_bins(html_path, test_tempdir)
+def parse_timebins(html_path):
+    return process_time_bins(html_path)
 
 
-def test_file_paths(parse_timebins):
-    for path in parse_timebins:
+@pytest.fixture(scope="module", autouse=True)
+def write_timebins(parse_timebins, test_tempdir):
+    return write_tables(parse_timebins, test_tempdir)
+
+
+def test_file_paths(write_timebins):
+    for path in write_timebins:
         assert path.exists()
 
 
@@ -39,6 +45,6 @@ def test_parsed_timebins(filename, expected_outputs, test_tempdir):
     assert content == expected_outputs[filename]
 
 
-def test_missing_timebins(html_path_no_bins, test_tempdir):
+def test_missing_timebins(html_path_no_bins):
     with pytest.raises(NoTemperatureDistribution):
-        process_time_bins(html_path_no_bins, test_tempdir)
+        process_time_bins(html_path_no_bins)