#348 cleanup and add error thrown test

hydrolib/core/dflowfm/tim/models.py

@@ -11,7 +11,7 @@ class TimModel(ParsableFileModel):
     """Class representing a tim (*.tim) file.
 
     Attributes:
-        data: Dict
+        data: Dictionary with keys \"comment\" & time as numeric and value as List of floats".\n
         serializer_config: TimSerializerConfig
     """
 

hydrolib/core/dflowfm/tim/parser.py

@@ -8,8 +8,8 @@
 class TimParser:
     """
     A parser for .tim files.
-    Full line comments are supported.
-    Partial comments will raise an error.
+    Full line comments at the start of the file are supported by * and #.
+    No other comments are supported.
     """
 
     @staticmethod
@@ -25,11 +25,16 @@ def parse(filepath: Path) -> Dict:
         """
         data = {}
         data["comments"] = [str]
+        savecomments = True
         with filepath.open() as file:
             for line in file.readlines():
                 if TimParser._line_is_comment(line):
-                    data["comments"].append(line.lstrip("#*"))
-                    continue
+                    if savecomments:
+                        data["comments"].append(line.lstrip("#*"))
+                        continue
+                    raise ValueError(f"Error parsing tim file '{filepath}', comments in between data not supported.")
+
+                savecomments = False
 
                 try:
                     TimParser._add_timeseries(line, data)

hydrolib/core/dflowfm/tim/serializer.py

@@ -25,6 +25,7 @@ def serialize(
             path (Path): The path to the destination file.
             data (Dict): The data to be serialized.
             config (TimSerializerConfig): The serialization configuration.
+            save_settings (ModelSaveSettings): The model save settings.
         """
         path.parent.mkdir(parents=True, exist_ok=True)
 

tests/data/input/tim/triple_data_for_timeseries_with_comments.tim

@@ -1,6 +1,5 @@
 #comments
+*this is another comment
 10 1.232 2.343 3.454
 20 4.565 5.676 6.787
-30 1.5 2.6 3.7
-* 40 1.5 2.6 3.7
-# 50 1.5 2.6 3.7
+30 1.5 2.6 3.7

tests/data/input/tim/triple_data_for_timeseries_with_comments_between_data.tim

@@ -0,0 +1,6 @@
+#comments
+10 1.232 2.343 3.454
+20 4.565 5.676 6.787
+30 1.5 2.6 3.7
+* 40 1.5 2.6 3.7
+# 50 1.5 2.6 3.7

tests/dflowfm/test_tim.py

@@ -163,8 +163,7 @@ class TestTimParser:
                     "comments": [
                         str,
                         "comments\n",
-                        " 40 1.5 2.6 3.7\n",
-                        " 50 1.5 2.6 3.7",
+                        "this is another comment\n",
                     ],
                     10: [1.232, 2.343, 3.454],
                     20: [4.565, 5.676, 6.787],
@@ -216,10 +215,31 @@ def test_parse_data(self, expected_output, input_path):
             ),
         ],
     )
-    def test_parse_data_throws_exception(self, input_path):
+    def test_parse_data_throws_exception_error_parsing_tim_file(self, input_path):
         with pytest.raises(ValueError) as error:
             TimParser.parse(input_path)
         found_msg = error.value.args[0]
 
         expected_error_msg = f"Error parsing tim file '{input_path}'."
         assert found_msg == expected_error_msg
+
+    @pytest.mark.parametrize(
+        "input_path",
+        [
+            pytest.param(
+                Path(
+                    test_input_dir
+                    / "tim"
+                    / "triple_data_for_timeseries_with_comments_between_data.tim"
+                ),
+                id="triple_data_for_timeseries_with_comments_between_data",
+            ),
+        ],
+    )
+    def test_parse_data_throws_exception_error_parsing_tim_file_comments_between_data_not_supported(self, input_path):
+        with pytest.raises(ValueError) as error:
+            TimParser.parse(input_path)
+        found_msg = error.value.args[0]
+
+        expected_error_msg = f"Error parsing tim file '{input_path}', comments in between data not supported."
+        assert found_msg == expected_error_msg