floodmodeller-api 0.5.3__tar.gz → 0.5.3.post2__tar.gz

{floodmodeller_api-0.5.3/floodmodeller_api.egg-info → floodmodeller_api-0.5.3.post2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: floodmodeller_api
-Version: 0.5.3
+Version: 0.5.3.post2
 Summary: Extends the functionality of Flood Modeller to python users
 Author: Jacobs
 Author-email: joe.pierce@jacobs.com

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/dat.py

@@ -453,12 +453,14 @@ class DAT(FMFile):
             "losses": [],
             "connectors": [],
             "controls": [],
+            "_unsupported": [],
         }
 
         for block in self._dat_struct:
             # Check for all supported boundary types
-            if block["Type"] not in units.SUPPORTED_UNIT_TYPES:
+            if block["Type"] not in units.ALL_UNIT_TYPES:
                 continue
+            unit_type = block["Type"]
             # clause for when unit has been inserted into the dat file
             if "new_insert" in block:
                 block["start"] = prev_block_end + 1
@@ -474,24 +476,26 @@ class DAT(FMFile):
                 ]
                 prev_block_len = len(unit_data)
 
-                if block["Type"] == "INITIAL CONDITIONS":
+                if unit_type == "INITIAL CONDITIONS":
                     new_unit_data = self.initial_conditions._write()
-                elif block["Type"] == "COMMENT":
+                elif unit_type == "COMMENT":
                     comment = comment_units[comment_tracker]
                     new_unit_data = comment._write()
                     comment_tracker += 1
 
-                elif block["Type"] == "VARIABLES":
+                elif unit_type == "VARIABLES":
                     new_unit_data = self.variables._write()
 
                 else:
-                    if units.SUPPORTED_UNIT_TYPES[block["Type"]]["has_subtype"]:
-                        unit_name = unit_data[2][: self._label_len].strip()
+                    if unit_type in units.SUPPORTED_UNIT_TYPES:
+                        unit_name = self._get_supported_unit_name(unit_type, unit_data)
+                        unit_group_str = units.SUPPORTED_UNIT_TYPES[unit_type]["group"]
                     else:
-                        unit_name = unit_data[1][: self._label_len].strip()
+                        unit_name, _ = self._get_unsupported_unit_name(unit_type, unit_data)
+                        unit_name = f"{unit_name} ({unit_type})"
+                        unit_group_str = "_unsupported"
 
                     # Get unit object
-                    unit_group_str = units.SUPPORTED_UNIT_TYPES[block["Type"]]["group"]
                     unit_group = getattr(self, unit_group_str)
                     if unit_name in unit_group:
                         # block still exists
@@ -571,22 +575,31 @@ class DAT(FMFile):
             raise Exception(msg)
         # Changes done to account for unit types with spaces/dashes eg Flat-V Weir
         unit_type_safe = unit_type.replace(" ", "_").replace("-", "_")
-        unit_group[unit_name] = eval(
-            f"units.{unit_type_safe}({unit_data}, {self._label_len})",
-        )
+        unit_group[unit_name] = getattr(units, unit_type_safe)(unit_data, self._label_len)
         self._all_units.append(unit_group[unit_name])
 
     def _process_unsupported_unit(self, unit_type, unit_data) -> None:
         # Check to see whether unit type has associated subtypes so that unit name can be correctly assigned
         unit_name, subtype = self._get_unsupported_unit_name(unit_type, unit_data)
-        self._unsupported[f"{unit_name} ({unit_type})"] = units.UNSUPPORTED(
+        unit_name_and_type = f"{unit_name} ({unit_type})"
+        if unit_name_and_type in self._unsupported:
+            msg = (
+                f"Duplicate label ({unit_name_and_type}) encountered within category: _unsupported"
+            )
+            raise Exception(msg)
+        self._unsupported[unit_name_and_type] = units.UNSUPPORTED(
             unit_data,
             self._label_len,
             unit_name=unit_name,
             unit_type=unit_type,
             subtype=subtype,
         )
-        self._all_units.append(self._unsupported[f"{unit_name} ({unit_type})"])
+        self._all_units.append(self._unsupported[unit_name_and_type])
+
+    def _get_supported_unit_name(self, unit_type: str, unit_data: list[str]) -> str:
+        if units.SUPPORTED_UNIT_TYPES[unit_type]["has_subtype"]:
+            return unit_data[2][: self._label_len].strip()
+        return unit_data[1][: self._label_len].strip()
 
     def _get_unsupported_unit_name(self, unit_type: str, unit_data: list[str]) -> tuple[str, bool]:
         # Check if the unit type has associated subtypes
@@ -710,6 +723,19 @@ class DAT(FMFile):
 
         return unit_block, in_block
 
+    @property
+    def node_labels(self):
+        all_labels = set()
+        for unit in self._all_units:
+            all_labels.update(unit.all_labels)
+        return all_labels
+
+    def _get_unit_group_name(self, unit: Unit) -> str:
+        unit_type = unit.unit
+        if unit_type in units.SUPPORTED_UNIT_TYPES:
+            return units.SUPPORTED_UNIT_TYPES[unit_type]["group"]
+        return "_unsupported"
+
     @handle_exception(when="remove unit from")
     def remove_unit(self, unit: Unit) -> None:
         """Remove a unit from the dat file.
@@ -734,19 +760,23 @@ class DAT(FMFile):
         # remove from raw data
         del self._raw_data[dat_struct_unit["start"] : dat_struct_unit["end"] + 1]
         # remove from unit group
-        unit_group_name = units.SUPPORTED_UNIT_TYPES[unit._unit]["group"]
+        unit_group_name = self._get_unit_group_name(unit)
         unit_group = getattr(self, unit_group_name)
-        del unit_group[unit.name]
-        # remove from ICs
-        self.initial_conditions.data = self.initial_conditions.data.loc[
-            self.initial_conditions.data["label"] != unit.name
-        ]
+        if unit_group_name == "_unsupported":
+            del unit_group[f"{unit.name} ({unit.unit})"]
+        else:
+            del unit_group[unit.name]
+        # remove from ICs if no more labels
+        if unit.name not in self.node_labels:
+            self.initial_conditions.data = self.initial_conditions.data.loc[
+                self.initial_conditions.data["label"] != unit.name
+            ]
+            self.general_parameters["Node Count"] -= 1
 
         self._update_dat_struct()
-        self.general_parameters["Node Count"] -= 1
 
     @handle_exception(when="insert unit into")
-    def insert_unit(  # noqa: C901, PLR0912
+    def insert_unit(
         self,
         unit: Unit,
         add_before: Unit | None = None,
@@ -769,6 +799,48 @@ class DAT(FMFile):
             NameError: Raised if unit name already appears in unit group.
         """
         # catch errors
+        self._validate_insert_unit_params(unit, add_before, add_after, add_at)
+
+        unit_class = unit._unit
+        if unit_class != "COMMENT":
+            _validate_unit(unit)
+            unit_group_name = self._get_unit_group_name(unit)
+            unit_group = getattr(self, unit_group_name)
+            if unit.name in unit_group:
+                msg = "Name already appears in unit group. Cannot have two units with same name in same group"
+                raise NameError(msg)
+
+        insert_index = self._get_insert_index(add_before, add_after, add_at)
+
+        unit_data = unit._write()
+        if unit._unit != "COMMENT":
+            if unit_group_name == "_unsupported":
+                unit_group[f"{unit.name} ({unit.unit})"] = unit
+            else:
+                unit_group[unit.name] = unit
+        self._dat_struct.insert(
+            insert_index + 1,
+            {"Type": unit_class, "new_insert": unit_data},
+        )  # add to dat struct without unit.name
+
+        if unit._unit != "COMMENT" and unit.name not in self.node_labels:
+            # update the iic's tables
+            iic_data = [unit.name, "y", 00.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
+            self.initial_conditions.data.loc[len(self.initial_conditions.data)] = iic_data  # flaged
+            self.general_parameters["Node Count"] += 1  # flag no update for comments
+
+        self._all_units.insert(insert_index, unit)
+        if not defer_update:
+            self._update_raw_data()
+            self._update_dat_struct()
+
+    def _validate_insert_unit_params(
+        self,
+        unit: Unit,
+        add_before: Unit | None,
+        add_after: Unit | None,
+        add_at: int | None,
+    ):
         provided_params = sum(arg is not None for arg in (add_before, add_after, add_at))
         if provided_params == 0:
             msg = "No positional argument given. Please provide either add_before, add_at or add_after"
@@ -783,15 +855,12 @@ class DAT(FMFile):
             msg = "add_before or add_after argument must be a Flood Modeller Unit type"
             raise TypeError(msg)
 
-        unit_class = unit._unit
-        if unit_class != "COMMENT":
-            _validate_unit(unit)
-            unit_group_name = units.SUPPORTED_UNIT_TYPES[unit._unit]["group"]
-            unit_group = getattr(self, unit_group_name)
-            if unit.name in unit_group:
-                msg = "Name already appears in unit group. Cannot have two units with same name in same group"
-                raise NameError(msg)
-
+    def _get_insert_index(
+        self,
+        add_before: Unit | None,
+        add_after: Unit | None,
+        add_at: int | None,
+    ) -> int:
         # positional argument
         if add_at is not None:
             insert_index = add_at
@@ -812,28 +881,7 @@ class DAT(FMFile):
                     f"{check_unit} not found in dat network, so cannot be used to add before/after"
                 )
                 raise Exception(msg)
-
-        unit_data = unit._write()
-        self._all_units.insert(insert_index, unit)
-        if unit._unit != "COMMENT":
-            unit_group[unit.name] = unit
-        self._dat_struct.insert(
-            insert_index + 1,
-            {"Type": unit_class, "new_insert": unit_data},
-        )  # add to dat struct without unit.name
-
-        if unit._unit != "COMMENT":
-            # update the iic's tables
-            iic_data = [unit.name, "y", 00.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
-            self.initial_conditions.data.loc[len(self.initial_conditions.data)] = iic_data  # flaged
-
-        # update all
-        if unit._unit != "COMMENT":
-            self.general_parameters["Node Count"] += 1  # flag no update for comments
-
-        if not defer_update:
-            self._update_raw_data()
-            self._update_dat_struct()
+        return insert_index
 
     def insert_units(
         self,

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/ied.py

@@ -183,7 +183,7 @@ class IED(FMFile):
                 if unit_name in unit_group:
                     msg = f'Duplicate label ({unit_name}) encountered within category: {units.SUPPORTED_UNIT_TYPES[block["Type"]]["group"]}'
                     raise Exception(msg)
-                unit_group[unit_name] = eval(f'units.{block["Type"]}({unit_data})')
+                unit_group[unit_name] = getattr(units, block["Type"])(unit_data)
 
                 self._all_units.append(unit_group[unit_name])
 

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/ief.py

@@ -18,6 +18,7 @@ from __future__ import annotations
 
 import csv
 import logging
+import re
 import subprocess
 import time
 from io import StringIO
@@ -98,6 +99,8 @@ class IEF(FMFile):
         self._ief_properties: list[str] = []
         self.EventData: dict[str, str] = {}
         self.flowtimeprofiles: list[FlowTimeProfile] = []
+
+        raw_eventdata: list[tuple[str, str]] = []
         for line in raw_data:
             # Handle any comments here (prefixed with ;)
             if line.lstrip().startswith(";"):
@@ -116,7 +119,7 @@ class IEF(FMFile):
                             event_data_title = value
                     else:
                         event_data_title = prev_comment
-                    self.eventdata[event_data_title] = value
+                    raw_eventdata.append((event_data_title, value))
                     self._ief_properties.append("EventData")
 
                 elif prop.upper().startswith("FLOWTIMEPROFILE"):
@@ -134,6 +137,7 @@ class IEF(FMFile):
                 self._ief_properties.append(line)
                 prev_comment = None
 
+        self._eventdata_read_helper(raw_eventdata)
         self._check_formatting(raw_data)
         self._update_ief_properties()  # call this here to ensure ief properties is correct
 
@@ -179,7 +183,10 @@ class IEF(FMFile):
                 # Add multiple EventData if present
                 for idx, key in enumerate(event_data):
                     if idx == event_index:
-                        ief_string += f";{key}\nEventData{eq}{event_data[key]!s}\n"
+                        # we enter this block if we're ready to write the event data
+                        # scrub off any extra bits we've added as part of the make-unique bit of reading.
+                        title = re.sub(r"<\d>$", "", key)
+                        ief_string += f";{title}\nEventData{eq}{event_data[key]!s}\n"
                         break
                 event_index += 1
 
@@ -328,6 +335,16 @@ class IEF(FMFile):
                     if removed == to_remove:
                         break
 
+    def _eventdata_read_helper(self, raw_eventdata: list[tuple[str, str]]) -> None:
+        # now we deal with the event data, and convert it into the dict-based .eventdata
+        for title, ied_path in raw_eventdata:
+            n = 0
+            new_title = title or "<0>"  # set empty string to placeholder
+            while new_title in self.eventdata:
+                new_title = f"{title}<{n}>"
+                n += 1
+            self.eventdata[new_title] = ied_path
+
     def _update_flowtimeprofile_info(self) -> None:
         """Update the flowtimeprofile data stored in ief properties"""
         if not hasattr(self, "flowtimeprofiles") or len(self.flowtimeprofiles) == 0:
@@ -570,7 +587,7 @@ class IEF(FMFile):
 
         return ZZN(result_path)
 
-    def get_log(self):
+    def get_log(self) -> LF1:
         """If log files for the simulation exist, this function returns them as a LF1 class object
 
         Returns:

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/test/test_dat.py

@@ -5,7 +5,7 @@ from unittest.mock import patch
 import pytest
 
 from floodmodeller_api import DAT
-from floodmodeller_api.units import JUNCTION, LATERAL, QTBDY, RESERVOIR
+from floodmodeller_api.units import JUNCTION, LATERAL, QTBDY, RESERVOIR, UNSUPPORTED
 from floodmodeller_api.util import FloodModellerAPIError
 
 
@@ -42,6 +42,28 @@ def dat_ex6(test_workspace):
         yield dat
 
 
+@pytest.fixture()
+def unsupported_dummy_unit():
+    data = [
+        "APITESTDUMMY Dummy unnsupported unit for testing purposes",
+        "LBL001      LBL002",
+        "arbitrary data",
+        "        table01234",
+        "    -0.500     0.000     0.000    0.000091000000.0",
+        "     0.000     1.000     1.000    0.0000 910000000",
+        "     1.000     2.000     2.000    0.000091000000.0",
+        "     2.000     3.000     3.000    0.000091000000.0",
+        "     5.000     3.000     3.000    0.000091000000.0",
+    ]
+    return UNSUPPORTED(
+        data,
+        12,
+        unit_name="LBL001",
+        unit_type="APITESTDUMMY",
+        subtype=False,
+    )
+
+
 def test_changing_section_and_dist_works(dat_fp, data_before):
     """DAT: Test changing and reverting section name and dist to next makes no changes"""
     dat = DAT(dat_fp)
@@ -74,6 +96,9 @@ def test_changing_and_reverting_qtbdy_hydrograph_works(dat_fp, data_before):
 def test_dat_read_doesnt_change_data(test_workspace, tmp_path):
     """DAT: Check all '.dat' files in folder by reading the _write() output into a new DAT instance and checking it stays the same."""
     for datfile in Path(test_workspace).glob("*.dat"):
+        if datfile.name.startswith("duplicate_unit_test"):
+            # Skipping as invalid DAT (duplicate units)
+            continue
         dat = DAT(datfile)
         first_output = dat._write()
         new_path = tmp_path / "tmp.dat"
@@ -380,3 +405,50 @@ def test_encoding(test_workspace: Path, dat_str: str, label: str, tmp_path: Path
 
     assert label in dat_read.sections
     assert label in dat_write.sections  # remains as \xc3\xa5 even for utf8
+
+
+def test_insert_unsupported_unit(tmp_path: Path, unsupported_dummy_unit):
+    new_dat = DAT()
+    new_dat.insert_unit(unsupported_dummy_unit, add_at=-1)
+    assert unsupported_dummy_unit in new_dat._unsupported.values()
+    assert len(new_dat._all_units) == 1
+    filepath = tmp_path / "insert_dummy_test.dat"
+    new_dat.save(filepath)
+
+    dat = DAT(filepath)
+    assert unsupported_dummy_unit in dat._unsupported.values()
+    assert len(dat._all_units) == 1
+
+
+def test_remove_unsupported_unit(test_workspace, unsupported_dummy_unit):
+    dat = DAT(test_workspace / "remove_dummy_test.dat")
+    assert len(dat._all_units) == 1
+    assert len(dat._dat_struct) == 3
+    assert len(dat.initial_conditions.data) == 1
+    assert "LBL001 (APITESTDUMMY)" in dat._unsupported
+    dat.remove_unit(unsupported_dummy_unit)
+    assert len(dat._all_units) == 0
+    assert len(dat._dat_struct) == 2
+    assert len(dat.initial_conditions.data) == 0
+    assert "LBL001 (APITESTDUMMY)" not in dat._unsupported
+    dat._write()
+    assert len(dat._all_units) == 0
+    assert len(dat._dat_struct) == 2
+    assert len(dat.initial_conditions.data) == 0
+    assert "LBL001 (APITESTDUMMY)" not in dat._unsupported
+
+
+def test_duplicate_unit_raises_error(test_workspace):
+    msg = (
+        r"\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+        r"\nAPI Error: Problem encountered when trying to read DAT file .*\."
+        r"\n"
+        r"\nDetails: .*-floodmodeller_api/dat\.py-\d+"
+        r"\nMsg: Duplicate label (.*) encountered within category: .*"
+        r"\n"
+        r"\nFor additional support, go to: https://github\.com/People-Places-Solutions/floodmodeller-api"
+    )
+    with pytest.raises(FloodModellerAPIError, match=msg):
+        DAT(test_workspace / "duplicate_unit_test.dat")
+    with pytest.raises(FloodModellerAPIError, match=msg):
+        DAT(test_workspace / "duplicate_unit_test_unsupported.dat")

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/test/test_data/All Units 4_6.DAT

@@ -715,8 +715,6 @@ YARNELL
      4.000     5.000     6.000     5.000
 GERRBDY
 Gerry46
-GERRBDY
-Gerry46
 #COMMENT
 
 ##CATCHMENT DETAILS

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/test/test_data/All Units 4_6.feb

@@ -715,8 +715,6 @@ YARNELL
      4.000     5.000     6.000     5.000
 GERRBDY
 Gerry46
-GERRBDY
-Gerry46
 #COMMENT
 
 ##CATCHMENT DETAILS

floodmodeller_api-0.5.3.post2/floodmodeller_api/test/test_data/duplicate_unit_test.dat

@@ -0,0 +1,18 @@
+duplicate units for test
+#REVISION#1
+         1     0.750     0.900     0.100     0.001        12
+    10.000     0.010     0.010     0.700     0.100     0.700     0.000
+RAD FILE
+
+END GENERAL
+QTBDY
+qtboundary
+         1     0.000     0.000   seconds    EXTEND    LINEAR     1.000
+    20.000     0.000
+QTBDY
+qtboundary
+         1     0.000     0.000   seconds    EXTEND    LINEAR     1.000
+    20.000     0.000
+GISINFO
+QTBDY 0 478 986 0 0 1
+0 0 0 0 0 0

floodmodeller_api-0.5.3.post2/floodmodeller_api/test/test_data/duplicate_unit_test_unsupported.dat

@@ -0,0 +1,28 @@
+duplicate units for test
+#REVISION#1
+         2     0.750     0.900     0.100     0.001        12
+    10.000     0.010     0.010     0.700     0.100     0.700     0.000
+RAD FILE
+
+END GENERAL
+APITESTDUMMY Dummy unnsupported unit for testing purposes
+LBL001      LBL002
+arbitrary data
+        table01234
+    -0.500     0.000     0.000    0.000091000000.0
+     0.000     1.000     1.000    0.0000 910000000
+     1.000     2.000     2.000    0.000091000000.0
+     2.000     3.000     3.000    0.000091000000.0
+     5.000     3.000     3.000    0.000091000000.0
+APITESTDUMMY Dummy unnsupported unit for testing purposes
+LBL001      LBL002
+arbitrary data
+        table01234
+    -0.500     0.000     0.000    0.000091000000.0
+     0.000     1.000     1.000    0.0000 910000000
+     1.000     2.000     2.000    0.000091000000.0
+     2.000     3.000     3.000    0.000091000000.0
+     5.000     3.000     3.000    0.000091000000.0
+GISINFO
+APITESTDUMMY 0 478 986 0 0 1
+0 0 0 0 0 0

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/test/test_data/encoding_test_cp1252.dat

@@ -715,8 +715,6 @@ YARNELL
      4.000     5.000     6.000     5.000
 GERRBDY
 Gerry46
-GERRBDY
-Gerry46
 #COMMENT
 
 ##CATCHMENT DETAILS

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/test/test_data/encoding_test_utf8.dat

@@ -715,8 +715,6 @@ YARNELL
      4.000     5.000     6.000     5.000
 GERRBDY
 Gerry46
-GERRBDY
-Gerry46
 #COMMENT
 
 ##CATCHMENT DETAILS

floodmodeller_api-0.5.3.post2/floodmodeller_api/test/test_data/multievent.ief

@@ -0,0 +1,43 @@
+[ISIS Event Header]
+Title=Multievent Test IEF
+Datafile=network.dat
+Results=..\Somewhere
+[ISIS Event Details]
+RunType=Unsteady
+InitialConditions=..\initial_conditions.iic
+Start=0
+Finish=360
+InitialTimestep=10
+MinimumTimestep=10
+MaximumTimestep=10
+SaveInterval=900
+;Fluvial Inflow
+EventData=..\network.ied
+;Event Override
+EventData=..\event_override.ied
+;Spill Data
+EventData=..\spill1.ied
+;Spill Data
+EventData=..\spill2.ied
+;
+EventData=..\ied_01.IED
+;
+EventData=..\ied_02.IED
+;
+EventData=..\ied_03.IED
+Dflood=5
+Qtol=0.1
+Minitr=5
+Maxitr=19
+Theta=0.55
+Weight=0.1
+AdaptiveTimestep=1
+RefineBridgeSecProps=0
+SolveDHEqualsZeroAtStart=1
+RulesAtTimeZero=1
+RulesOnFirstIteration=0
+ResetTimesAfterPos=1
+UseFPSModularLimit=1
+LaunchDoublePrecisionVersion=1
+UseRemoteQ=1
+2DFLOW=1

floodmodeller_api-0.5.3.post2/floodmodeller_api/test/test_data/remove_dummy_test.dat

@@ -0,0 +1,19 @@
+
+#REVISION#1
+         1     0.750     0.900     0.100     0.001        12SI
+    10.000     0.010     0.010     0.700     0.100     0.700     0.000
+RAD FILE
+
+END GENERAL
+APITESTDUMMY Dummy unnsupported unit for testing purposes
+LBL001      LBL002
+arbitrary data
+        table01234
+    -0.500     0.000     0.000    0.000091000000.0
+     0.000     1.000     1.000    0.0000 910000000
+     1.000     2.000     2.000    0.000091000000.0
+     2.000     3.000     3.000    0.000091000000.0
+     5.000     3.000     3.000    0.000091000000.0
+INITIAL CONDITIONS
+ label   ?      flow     stage froude no  velocity     umode    ustate         z
+LBL001       y     0.000     0.000     0.000     0.000     0.000     0.000     0.000

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/test/test_ief.py

@@ -18,6 +18,11 @@ def ief(ief_fp: Path) -> IEF:
     return IEF(ief_fp)
 
 
+@pytest.fixture()
+def multievent_ief(test_workspace: Path) -> IEF:
+    return IEF(test_workspace / "multievent.ief")
+
+
 @pytest.fixture()
 def exe_bin(tmpdir) -> Path:
     for exe in ["ISISf32.exe", "ISISf32_DoubleP.exe"]:
@@ -40,6 +45,7 @@ def sleep():
 
 def test_ief_read_doesnt_change_data(test_workspace, tmpdir):
     """IEF: Check all '.ief' files in folder by reading the _write() output into a new IEF instance and checking it stays the same."""
+    # we use this instead of parameterise so it will just automatically test any ief in the test data.
     for ief_file in Path(test_workspace).glob("*.ief"):
         ief = IEF(ief_file)
         first_output = ief._write()
@@ -182,3 +188,64 @@ def test_datafile_path(test_workspace: Path):
     path = Path(ief.Datafile)
     assert path.stem == "UptonP8_Panels"
     assert path.parent == Path("../../networks")
+
+
+def test_unique_events_retained(multievent_ief: IEF):
+    """Tests that the .eventdata attribute retains the same number of items as the original ief"""
+    event_dict = multievent_ief.eventdata
+    assert len(event_dict) == 7
+
+
+@pytest.mark.parametrize(
+    ("sample_eventdata"),
+    [
+        ({}),
+        ({"Fluvial Inflow": "..\\network.ied", "Event Override": "..\\event_override.ied"}),
+        (
+            {
+                "Fluvial Inflow": "..\\network.ied",
+                "Event Override": "..\\event_override.ied",
+                "Spill Data": "..\\spill1.ied",
+                "Spill Data<0>": "..\\spill2.ied",
+                "<0>": "..\\ied_01.IED",
+                "<1>": "..\\ied_02.IED",
+                "<2>": "..\\ied_03.IED",
+                "Added Event": "../added.ied",
+            }
+        ),
+    ],
+)
+def test_adding_eventdata(multievent_ief, sample_eventdata, tmpdir):
+    """Tests modifying, saving and reading eventdata dictionary.
+
+    Compares that the input is equal to the output."""
+    multievent_ief.eventdata = sample_eventdata
+    new_path = Path(tmpdir) / "tmp.ief"
+    multievent_ief.save(new_path)
+
+    new_ief = IEF(new_path)
+    assert new_ief.eventdata == sample_eventdata
+
+
+def test_renaming_eventdata(multievent_ief, tmpdir):
+    """Tests renaming an event, after it has been substituted for a temporary one."""
+
+    mapping = {"<1>": "New Title"}
+
+    multievent_ief.eventdata = {
+        mapping.get(key, key): value for key, value in multievent_ief.eventdata.items()
+    }
+    new_path = Path(tmpdir) / "tmp.ief"
+    multievent_ief.save(new_path)
+
+    new_ief = IEF(new_path)
+
+    assert new_ief.eventdata == {
+        "Fluvial Inflow": "..\\network.ied",
+        "Event Override": "..\\event_override.ied",
+        "Spill Data": "..\\spill1.ied",
+        "Spill Data<0>": "..\\spill2.ied",
+        "<0>": "..\\ied_01.IED",
+        "New Title": "..\\ied_02.IED",
+        "<1>": "..\\ied_03.IED",
+    }

{floodmodeller_api-0.5.3 → floodmodeller_api-0.5.3.post2}/floodmodeller_api/test/test_json.py

@@ -105,6 +105,9 @@ def test_obj_reproduces_from_json_for_all_test_api_files(
 ):
     """JSON:  To test the from_json function,  It should produce the same dat file from a json file"""
     for file in Path(test_workspace).glob(file_extension_glob):
+        if file.name.startswith("duplicate_unit_test"):
+            # Skipping as invalid DAT (duplicate units)
+            continue
         assert api_class(file) == api_class.from_json(api_class(file).to_json())