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

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

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

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

@@ -63,6 +63,8 @@ class DAT(FMFile):
 
         self._get_general_parameters()
         self._get_unit_definitions()
+        if self._gxy_data:
+            self._get_unit_locations()
 
     def update(self) -> None:
         """Updates the existing DAT based on any altered attributes"""
@@ -529,6 +531,33 @@ class DAT(FMFile):
                 msg = f"Unexpected unit type encountered: {unit_type}"
                 raise Exception(msg)
 
+    def _get_unit_locations(self):
+        # use gxy data to assign locations to units.
+        gxy_lines = self._gxy_data.splitlines()
+        line = 0
+        gxy_dict = {}
+        while True:
+            header = gxy_lines[line][1:-1].split("_", 2)
+
+            # header format for a unit is [TYPE_SUBTYPE_NAME], so simple check that our header is a unit is check split length is 3
+            if len(header) != 3:  # noqa: PLR2004
+                break
+
+            x = float(gxy_lines[line + 1][2:].strip())
+            y = float(gxy_lines[line + 2][2:].strip())
+
+            # key should match ._unique_name attributes
+            gxy_dict[f"{header[0]}_{header[2]}"] = (x, y)
+
+            line += 4
+
+        for unit in self._all_units:
+            if unit.unit in ("COMMENT",):
+                break
+
+            if unit.unique_name in gxy_dict:
+                unit.set_cached_location_from_gxy(gxy_dict.pop(unit.unique_name))
+
     def _initialize_collections(self) -> None:
         # Initialize unit collections
         self.sections: dict[str, units.TSections] = {}
@@ -552,8 +581,11 @@ class DAT(FMFile):
         else:
             # Check to see whether unit type has associated subtypes so that unit name can be correctly assigned
             unit_name = self._get_unit_name(unit_type, unit_data)
-            # Create instance of unit and add to relevant group
+
+            # fetch the relevant group that the unit belongs in
             unit_group = getattr(self, units.SUPPORTED_UNIT_TYPES[unit_type]["group"])
+
+            # Create instance of unit and add to group
             self._add_unit_to_group(unit_group, unit_type, unit_name, unit_data)
 
     def _get_unit_name(self, unit_type, unit_data):
@@ -571,12 +603,17 @@ class DAT(FMFile):
     ) -> None:
         # Raise exception if a duplicate label is encountered
         if unit_name in unit_group:
-            msg = f'Duplicate label ({unit_name}) encountered within category: {units.SUPPORTED_UNIT_TYPES[unit_type]["group"]}'
+            msg = f"Duplicate label ({unit_name}) encountered within category: {units.SUPPORTED_UNIT_TYPES[unit_type]['group']}"
             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] = getattr(units, unit_type_safe)(unit_data, self._label_len)
-        self._all_units.append(unit_group[unit_name])
+
+        # Get class object from unit type and instantiate unit with block data & length.
+        unit = getattr(units, unit_type_safe)(unit_data, self._label_len)
+
+        # Add unit to group, and to all units list.
+        unit_group[unit_name] = unit
+        self._all_units.append(unit)
 
     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

{floodmodeller_api-0.5.3.post2 → floodmodeller_api-0.5.5}/floodmodeller_api/hydrology_plus/hydrology_plus_export.py

@@ -97,8 +97,7 @@ class HydrologyPlusExport(FMFile):
             if s == scenario and float(sd) == storm_duration and float(rp) == return_period:
                 return column
         msg = (
-            "No matching event was found based on "
-            f"{return_period=}, {storm_duration=}, {scenario=}"
+            f"No matching event was found based on {return_period=}, {storm_duration=}, {scenario=}"
         )
         raise ValueError(msg)
 

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

@@ -181,7 +181,7 @@ class IED(FMFile):
                 # Create instance of unit and add to relevant group
                 unit_group = getattr(self, units.SUPPORTED_UNIT_TYPES[block["Type"]]["group"])
                 if unit_name in unit_group:
-                    msg = f'Duplicate label ({unit_name}) encountered within category: {units.SUPPORTED_UNIT_TYPES[block["Type"]]["group"]}'
+                    msg = f"Duplicate label ({unit_name}) encountered within category: {units.SUPPORTED_UNIT_TYPES[block['Type']]['group']}"
                     raise Exception(msg)
                 unit_group[unit_name] = getattr(units, block["Type"])(unit_data)
 

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

@@ -99,15 +99,30 @@ def test_dat_read_doesnt_change_data(test_workspace, tmp_path):
         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"
         dat.save(new_path)
         second_dat = DAT(new_path)
-        assert dat == second_dat, f"dat objects not equal for {datfile=}"
+        assert dat == second_dat, f"dat objects not equal for {datfile=}\n{dat.diff(second_dat)}"
         second_output = second_dat._write()
         assert first_output == second_output, f"dat outputs not equal for {datfile=}"
 
+        gxy_path = datfile.with_suffix(".gxy")
+        if gxy_path.exists():
+            second_gxy_path = new_path.with_suffix(".gxy")
+            assert second_gxy_path.exists(), f"updated .gxy not found when testing {datfile=}"
+
+            # note filecmp.cmp() doesnt work here because input/output data has different eol sequences.
+            assert (
+                gxy_path.read_text() == second_gxy_path.read_text()
+            ), f".gxy file content not identical for  {datfile=}"
+
+        new_path.unlink()
+        if gxy_path.exists():
+            second_gxy_path.unlink()
+
 
 def test_insert_unit_before(units, dat_ex6):
     dat_ex6.insert_unit(units[0], add_before=dat_ex6.sections["P4000"])