floodmodeller-api 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

floodmodeller_api/__init__.py

@@ -6,4 +6,4 @@ from .logs import LF1, LF2
 from .util import read_file
 from .version import __version__
 from .xml2d import XML2D
-from .zzn import ZZN
+from .zz import ZZN, ZZX

floodmodeller_api/_base.py

@@ -33,8 +33,8 @@ from .util import FloodModellerAPIError, handle_exception
 class FMFile(Jsonable):
     """Base class for all Flood Modeller File types"""
 
-    _filetype: str | None = None
-    _suffix: str | None = None
+    _filetype: str
+    _suffix: str
     MAX_DIFF = 25
 
     def __init__(self, filepath: str | Path | None = None, **kwargs):
@@ -42,16 +42,16 @@ class FMFile(Jsonable):
             self._filepath = Path(filepath)
             # * Add check or fix for path lengths greater than DOS standard length of 260 characters
 
-            if not self._filepath.suffix.lower() == self._suffix:
-                raise TypeError(
-                    f"Given filepath does not point to a {self._filetype} file. Please point to the full path for a {self._filetype} file",
-                )
+            if self._filepath.suffix.lower() != self._suffix:
+                msg = f"Given filepath does not point to a {self._filetype} file. Please point to the full path for a {self._filetype} file"
+                raise TypeError(msg)
             if not self._filepath.exists():
-                raise FileNotFoundError(
+                msg = (
                     f"{self._filetype} file does not exist! If you are wanting to create a new {self._filetype}, initiate the class without a given "
                     f"filepath to create a new blank {self._filetype} or point the filepath of an existing {self._filetype} to use as a template, "
-                    f"then use the .save() method to save to a new filepath",
+                    f"then use the .save() method to save to a new filepath"
                 )
+                raise FileNotFoundError(msg)
             # If the file is not a ZZN file, then perform a backup
             # This performs a conditional back up, only copying the file if an equivalent copy doesn't already exist
             if self._filetype != "ZZN":
@@ -60,6 +60,17 @@ class FMFile(Jsonable):
                 # Add the file object as a property to expose the restore method
                 self.file = file
 
+    @property
+    def filepath(self) -> Path:
+        if not hasattr(self, "_filepath"):
+            msg = "Object has no filepath."
+            raise AttributeError(msg)
+        return self._filepath
+
+    @property
+    def filetype(self) -> str:
+        return self._filetype
+
     def __repr__(self):
         filepath = "<in_memory>" if not hasattr(self, "_filepath") else self._filepath
         return f"<floodmodeller_api Class: {self._filetype}(filepath={filepath})>"
@@ -73,9 +84,8 @@ class FMFile(Jsonable):
     def _update(self):
         """Updates the existing self._filetype based on any altered attributes"""
         if self._filepath is None:
-            raise UserWarning(
-                f"{self._filetype} must be saved to a specific filepath before update() can be called.",
-            )
+            msg = f"{self._filetype} must be saved to a specific filepath before update() can be called."
+            raise UserWarning(msg)
 
         string = self._write()
         with open(self._filepath, "w") as _file:
@@ -84,10 +94,9 @@ class FMFile(Jsonable):
 
     def _save(self, filepath):
         filepath = Path(filepath).absolute()
-        if not filepath.suffix.lower() == self._suffix:
-            raise TypeError(
-                f'Given filepath does not point to a filepath suffixed "{self._suffix}". Please point to the full path to save the {self._filetype} file',
-            )
+        if filepath.suffix.lower() != self._suffix:
+            msg = f'Given filepath does not point to a filepath suffixed "{self._suffix}". Please point to the full path to save the {self._filetype} file'
+            raise TypeError(msg)
 
         if not filepath.parent.exists():
             Path.mkdir(filepath.parent)
@@ -102,7 +111,8 @@ class FMFile(Jsonable):
     @handle_exception(when="compare")
     def _diff(self, other, force_print=False):
         if self._filetype != other._filetype:
-            raise TypeError("Cannot compare objects of different filetypes")
+            msg = "Cannot compare objects of different filetypes"
+            raise TypeError(msg)
         diff = self._get_diff(other)
         if diff[0]:
             print("No difference, files are equivalent")

floodmodeller_api/backup.py

@@ -195,7 +195,8 @@ class File(BackupControl):
         self.path = Path(path)
         # Check  if the file exists
         if not self.path.exists():
-            raise OSError("File not found!")
+            msg = "File not found!"
+            raise OSError(msg)
         self.ext = self.path.suffix
         self.dttm_str = datetime.now().strftime("%Y-%m-%d-%H-%M-%S")
         self._generate_file_id()
@@ -232,7 +233,7 @@ class File(BackupControl):
         copy(self.path, backup_filepath)
         # Log an entry to the csv to make it easy to find the file
         # TODO: Only log file_id and poath, don't log duplicate lines. Needs to be fast so it doesn't slow FMFile down
-        log_str = f"{str(self.path)},{self.file_id},{self.dttm_str}\n"
+        log_str = f"{self.path!s},{self.file_id},{self.dttm_str}\n"
         with open(self.backup_csv_path, "a") as f:
             f.write(log_str)
 

floodmodeller_api/dat.py

@@ -253,13 +253,11 @@ class DAT(FMFile):
             Union[Unit, list[Unit], None]: Either a singular unit or list of units with ds_label matching, if none exist returns none.
         """
 
-        _ds_list = []
-        for item in self._all_units:
-            try:
-                if item.ds_label == current_unit.name:
-                    _ds_list.append(item)
-            except AttributeError:
-                continue
+        _ds_list = [
+            item
+            for item in self._all_units
+            if hasattr(item, "ds_label") and item.ds_label == current_unit.name
+        ]
 
         if len(_ds_list) == 0:
             return None
@@ -295,7 +293,7 @@ class DAT(FMFile):
     def _read(self) -> None:
         # Read DAT data
         with open(self._filepath) as dat_file:
-            self._raw_data: list[str] = [line.rstrip("\n") for line in dat_file.readlines()]
+            self._raw_data: list[str] = [line.rstrip("\n") for line in dat_file]
 
         # Generate DAT structure
         self._update_dat_struct()
@@ -414,9 +412,8 @@ class DAT(FMFile):
                 if name != unit.name:
                     # Check if new name already exists as a label
                     if unit.name in unit_group:
-                        raise Exception(
-                            f'Error: Cannot update label "{name}" to "{unit.name}" because "{unit.name}" already exists in the Network {unit_group_name} group',
-                        )
+                        msg = f'Error: Cannot update label "{name}" to "{unit.name}" because "{unit.name}" already exists in the Network {unit_group_name} group'
+                        raise Exception(msg)
                     unit_group[unit.name] = unit
                     del unit_group[name]
                     # Update label in ICs
@@ -528,7 +525,8 @@ class DAT(FMFile):
             elif unit_type in units.UNSUPPORTED_UNIT_TYPES:
                 self._process_unsupported_unit(unit_type, unit_data)
             elif unit_type not in ("GENERAL", "GISINFO"):
-                raise Exception(f"Unexpected unit type encountered: {unit_type}")
+                msg = f"Unexpected unit type encountered: {unit_type}"
+                raise Exception(msg)
 
     def _initialize_collections(self):
         # Initialize unit collections
@@ -564,9 +562,8 @@ class DAT(FMFile):
     def _add_unit_to_group(self, unit_group, unit_type, unit_name, unit_data):
         # Raise exception if a duplicate label is encountered
         if unit_name in unit_group:
-            raise Exception(
-                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] = eval(
@@ -720,7 +717,8 @@ class DAT(FMFile):
         """
         # catch if not valid unit
         if not isinstance(unit, Unit):
-            raise TypeError("unit isn't a unit")
+            msg = "unit isn't a unit"
+            raise TypeError(msg)
 
         # remove from all units
         index = self._all_units.index(unit)
@@ -768,17 +766,17 @@ class DAT(FMFile):
         # catch errors
         provided_params = sum(arg is not None for arg in (add_before, add_after, add_at))
         if provided_params == 0:
-            raise SyntaxError(
-                "No positional argument given. Please provide either add_before, add_at or add_after",
-            )
+            msg = "No positional argument given. Please provide either add_before, add_at or add_after"
+            raise SyntaxError(msg)
         if provided_params > 1:
-            raise SyntaxError("Only one of add_at, add_before, or add_after required")
+            msg = "Only one of add_at, add_before, or add_after required"
+            raise SyntaxError(msg)
         if not isinstance(unit, Unit):
-            raise TypeError("unit isn't a unit")
+            msg = "unit isn't a unit"
+            raise TypeError(msg)
         if add_at is None and not (isinstance(add_before, Unit) or isinstance(add_after, Unit)):
-            raise TypeError(
-                "add_before or add_after argument must be a Flood Modeller Unit type",
-            )
+            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":
@@ -786,9 +784,8 @@ class DAT(FMFile):
             unit_group_name = units.SUPPORTED_UNIT_TYPES[unit._unit]["group"]
             unit_group = getattr(self, unit_group_name)
             if unit.name in unit_group:
-                raise NameError(
-                    "Name already appears in unit group. Cannot have two units with same name in same group",
-                )
+                msg = "Name already appears in unit group. Cannot have two units with same name in same group"
+                raise NameError(msg)
 
         # positional argument
         if add_at is not None:
@@ -796,7 +793,8 @@ class DAT(FMFile):
             if insert_index < 0:
                 insert_index += len(self._all_units) + 1
                 if insert_index < 0:
-                    raise Exception(f"invalid add_at index: {add_at}")
+                    msg = f"invalid add_at index: {add_at}"
+                    raise Exception(msg)
         else:
             check_unit = add_before or add_after
             for index, thing in enumerate(self._all_units):
@@ -805,9 +803,10 @@ class DAT(FMFile):
                     insert_index += 1 if add_after else 0
                     break
             else:
-                raise Exception(
-                    f"{check_unit} not found in dat network, so cannot be used to add before/after",
+                msg = (
+                    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)

floodmodeller_api/diff.py

@@ -59,8 +59,8 @@ def check_item_with_dataframe_equal(  # noqa: C901, PLR0912
                 row_diffs = []
                 for row in rows:
                     for col in df_diff.columns:
-                        if True not in df_diff.loc[row, col].duplicated().values:
-                            vals = df_diff.loc[row, col].values
+                        if True not in df_diff.loc[row, col].duplicated().to_numpy():
+                            vals = df_diff.loc[row, col].to_numpy()
                             row_diffs.append(
                                 f"    Row: {row}, Col: '{col}' - left: {vals[0]}, right: {vals[1]}",
                             )
@@ -96,7 +96,7 @@ def check_dict_with_dataframe_equal(dict_a, dict_b, name, diff, special_types):
                 )
                 if not _result:
                     result = False
-            except KeyError as ke:
+            except KeyError as ke:  # noqa: PERF203
                 result = False
                 diff.append((name, f"Key: '{ke.args[0]}' missing in other"))
                 continue

floodmodeller_api/hydrology_plus/hydrology_plus_export.py

@@ -51,7 +51,8 @@ class HydrologyPlusExport(FMFile):
         with self._filepath.open("r") as file:
             header = file.readline().strip(" ,\n\r")
             if header != "Flood Modeller Hydrology+ hydrograph file":
-                raise ValueError("Input file is not the correct format for Hydrology+ export data.")
+                msg = "Input file is not the correct format for Hydrology+ export data."
+                raise ValueError(msg)
 
         self._data_file = pd.read_csv(self._filepath)
         self._metadata = self._get_metadata()
@@ -85,20 +86,21 @@ class HydrologyPlusExport(FMFile):
             return next(col for col in self.data.columns if col.lower().startswith(event.lower()))
 
         if not (return_period and storm_duration and scenario):
-            raise ValueError(
+            msg = (
                 "Missing required inputs to find event, if no event string is passed then a "
                 "return_period, storm_duration and scenario are needed. You provided: "
-                f"{return_period=}, {storm_duration=}, {scenario=}",
+                f"{return_period=}, {storm_duration=}, {scenario=}"
             )
+            raise ValueError(msg)
         for column in self.data.columns:
             s, sd, rp, *_ = column.split(" - ")
             if s == scenario and float(sd) == storm_duration and float(rp) == return_period:
                 return column
-        else:
-            raise ValueError(
-                "No matching event was found based on "
-                f"{return_period=}, {storm_duration=}, {scenario=}",
-            )
+        msg = (
+            "No matching event was found based on "
+            f"{return_period=}, {storm_duration=}, {scenario=}"
+        )
+        raise ValueError(msg)
 
     def get_event_flow(
         self,
@@ -197,11 +199,10 @@ class HydrologyPlusExport(FMFile):
         elif isinstance(template_ief, (Path, str)):
             template_ief = IEF(template_ief)
 
-        generated_iefs = []
-        for column in self.data.columns:
-            generated_iefs.append(self.generate_ief(node_label, template_ief, event=column))
-
-        return generated_iefs
+        return [
+            self.generate_ief(node_label, template_ief, event=column)
+            for column in self.data.columns
+        ]
 
     def generate_ief(  # noqa: PLR0913
         self,

floodmodeller_api/ied.py

@@ -61,7 +61,7 @@ class IED(FMFile):
     def _read(self):
         # Read IED data
         with open(self._filepath) as ied_file:
-            self._raw_data = [line.rstrip("\n") for line in ied_file.readlines()]
+            self._raw_data = [line.rstrip("\n") for line in ied_file]
 
         # Generate IED structure
         self._update_ied_struct()
@@ -87,10 +87,11 @@ class IED(FMFile):
                 if name != unit.name:
                     # Check if new name already exists as a label
                     if unit.name in unit_group:
-                        raise Exception(
+                        msg = (
                             f'Error: Cannot update label "{name}" to "{unit.name}" because '
-                            f'"{unit.name}" already exists in the Network {unit_group_name} group',
+                            f'"{unit.name}" already exists in the Network {unit_group_name} group'
                         )
+                        raise Exception(msg)
                     unit_group[unit.name] = unit
                     del unit_group[name]
 
@@ -180,9 +181,8 @@ 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:
-                    raise Exception(
-                        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] = eval(f'units.{block["Type"]}({unit_data})')
 
                 self._all_units.append(unit_group[unit_name])

floodmodeller_api/ief.py

@@ -17,7 +17,6 @@ address: Jacobs UK Limited, Flood Modeller, Cottons Centre, Cottons Lane, London
 from __future__ import annotations
 
 import csv
-import os
 import subprocess
 import time
 from io import StringIO
@@ -34,7 +33,7 @@ from .ief_flags import flags
 from .logs import LF1, create_lf
 from .to_from_json import Jsonable
 from .util import handle_exception
-from .zzn import ZZN
+from .zz import ZZN
 
 
 def try_numeric(value: str) -> str | int | float:
@@ -82,7 +81,7 @@ class IEF(FMFile):
     def _read(self):
         # Read IEF data
         with open(self._filepath) as ief_file:
-            raw_data = [line.rstrip("\n") for line in ief_file.readlines()]
+            raw_data = [line.rstrip("\n") for line in ief_file]
         # Clean data and add as class properties
         # Create a list to store the properties which are to be saved in IEF, so as to ignore any temp properties.
         prev_comment = None
@@ -170,7 +169,7 @@ 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}{str(event_data[key])}\n"
+                        ief_string += f";{key}\nEventData{eq}{event_data[key]!s}\n"
                         break
                 event_index += 1
 
@@ -181,7 +180,7 @@ class IEF(FMFile):
 
             else:
                 # writes property and value to ief string
-                ief_string += f"{prop}{eq}{str(getattr(self, prop))}\n"
+                ief_string += f"{prop}{eq}{getattr(self, prop)!s}\n"
 
         return ief_string
 
@@ -279,10 +278,11 @@ class IEF(FMFile):
     def _update_eventdata_info(self):  # noqa: C901
         if not isinstance(self.eventdata, dict):
             # If attribute not a dict, adds the value as a single entry in list
-            raise AttributeError(
+            msg = (
                 "The 'EventData' attribute should be a dictionary with keys defining the event"
-                " names and values referencing the IED files",
+                " names and values referencing the IED files"
             )
+            raise AttributeError(msg)
 
         # Number of 'EventData' flags in ief
         event_properties = self._ief_properties.count("EventData")
@@ -328,11 +328,12 @@ class IEF(FMFile):
         try:
             self.NoOfFlowTimeSeries = sum([ftp.count_series() for ftp in self.flowtimeprofiles])
         except FileNotFoundError as err:
-            raise UserWarning(
+            msg = (
                 "Failed to read csv referenced in flowtimeprofile, file either does not exist or is"
                 "unable to be found due to relative path from IEF file. NoOfFlowTimeSeries has not"
-                "been updated.",
-            ) from err
+                "been updated."
+            )
+            raise UserWarning(msg) from err
 
         end_index = None
         start_index = (
@@ -471,9 +472,8 @@ class IEF(FMFile):
         self._range_function = range_function
         self._range_settings = range_settings if range_settings else {}
         if self._filepath is None:
-            raise UserWarning(
-                "IEF must be saved to a specific filepath before simulate() can be called.",
-            )
+            msg = "IEF must be saved to a specific filepath before simulate() can be called."
+            raise UserWarning(msg)
         if precision.upper() == "DEFAULT":
             precision = "SINGLE"  # Defaults to single...
             for attr in dir(self):
@@ -489,9 +489,8 @@ class IEF(FMFile):
         else:
             _enginespath = enginespath
             if not Path(_enginespath).exists():
-                raise Exception(
-                    f"Flood Modeller non-default engine path not found! {str(_enginespath)}",
-                )
+                msg = f"Flood Modeller non-default engine path not found! {_enginespath!s}"
+                raise Exception(msg)
 
         if precision.upper() == "SINGLE":
             isis32_fp = str(Path(_enginespath, "ISISf32.exe"))
@@ -499,14 +498,15 @@ class IEF(FMFile):
             isis32_fp = str(Path(_enginespath, "ISISf32_DoubleP.exe"))
 
         if not Path(isis32_fp).exists():
-            raise Exception(f"Flood Modeller engine not found! Expected location: {isis32_fp}")
+            msg = f"Flood Modeller engine not found! Expected location: {isis32_fp}"
+            raise Exception(msg)
 
         run_command = f'"{isis32_fp}" -sd "{self._filepath}"'
 
         if method.upper() == "WAIT":
             print("Executing simulation...")
             # execute simulation
-            process = Popen(run_command, cwd=os.path.dirname(self._filepath))
+            process = Popen(run_command, cwd=Path(self._filepath).parent)
 
             # progress bar based on log files
             steady = self.RunType == "Steady"
@@ -526,7 +526,7 @@ class IEF(FMFile):
         elif method.upper() == "RETURN_PROCESS":
             print("Executing simulation...")
             # execute simulation
-            return Popen(run_command, cwd=os.path.dirname(self._filepath))
+            return Popen(run_command, cwd=Path(self._filepath).parent)
 
         return None
 
@@ -553,7 +553,8 @@ class IEF(FMFile):
         result_path = self._get_result_filepath(suffix="zzn")
 
         if not result_path.exists():
-            raise FileNotFoundError("Simulation results file (zzn) not found")
+            msg = "Simulation results file (zzn) not found"
+            raise FileNotFoundError(msg)
 
         return ZZN(result_path)
 
@@ -565,7 +566,8 @@ class IEF(FMFile):
         """
 
         if not self._log_path.exists():
-            raise FileNotFoundError("Log file (LF1) not found")
+            msg = "Log file (LF1) not found"
+            raise FileNotFoundError(msg)
 
         steady = self.RunType == "Steady"
         return LF1(self._log_path, steady)
@@ -616,7 +618,8 @@ class IEF(FMFile):
             exy_path = self._filepath.with_suffix(".exy")
 
         if not exy_path.exists():
-            raise FileNotFoundError("Simulation results error log (.exy) not found")
+            msg = "Simulation results error log (.exy) not found"
+            raise FileNotFoundError(msg)
 
         exy_data = pd.read_csv(exy_path, names=["node", "timestep", "severity", "code", "summary"])
         exy_data["type"] = exy_data["code"].apply(
@@ -678,9 +681,8 @@ class FlowTimeProfile(Jsonable):
             self.profile = kwargs.get("profile", "")
             self.comment = kwargs.get("comment", "")
         else:
-            raise ValueError(
-                "You must provide either a single raw string argument or keyword arguments.",
-            )
+            msg = "You must provide either a single raw string argument or keyword arguments."
+            raise ValueError(msg)
 
         base_path = Path(kwargs.get("ief_filepath", ""))
         self._csvfile = (base_path / self.csv_filepath.strip('"')).resolve()

floodmodeller_api/inp.py

@@ -60,7 +60,7 @@ class INP(FMFile):
     def _read(self):
         # Read INP file
         with open(self._filepath) as inp_file:
-            self._raw_data = [line.rstrip("\n") for line in inp_file.readlines()]
+            self._raw_data = [line.rstrip("\n") for line in inp_file]
 
         # Generate INP file structure
         self._update_inp_struct()
@@ -129,9 +129,8 @@ class INP(FMFile):
         return "\n".join(self._raw_data) + "\n"
 
     def _create_from_blank(self):
-        raise NotImplementedError(
-            "Creating new 1D urban models (INP files) is not yet supported by floodmodeller_api, only existing models can be read",
-        )
+        msg = "Creating new 1D urban models (INP files) is not yet supported by floodmodeller_api, only existing models can be read"
+        raise NotImplementedError(msg)
 
     def _get_section_definitions(self):
         """Internal method used to get section definitions for each supported unit type and general parameters."""

floodmodeller_api/logs/lf.py

@@ -70,7 +70,7 @@ class LF(FMFile):
     def _read(self, force_reread: bool = False, suppress_final_step: bool = False):
         # Read LF file
         with open(self._filepath) as lf_file:
-            self._raw_data = [line.rstrip("\n") for line in lf_file.readlines()]
+            self._raw_data = [line.rstrip("\n") for line in lf_file]
 
         # Force rereading from start of file
         if force_reread is True:
@@ -140,17 +140,12 @@ class LF(FMFile):
     def _get_index(self):
         """Finds key and dataframe for variable that is the index"""
 
-        for key in self._data_to_extract:
-            try:
-                self._data_to_extract[key]["is_index"]
-                index_key = key
-                index_df = self._extracted_data[key].data.get_value()
-                return index_key, index_df
-
-            except KeyError:
-                pass
+        for k, v in self._data_to_extract.items():
+            if "is_index" in v:
+                return k, self._extracted_data[k].data.get_value()
 
-        raise Exception("No index variable found")
+        msg = "No index variable found"
+        raise Exception(msg)
 
     def _set_attributes(self):
         """Makes each Parser value an attribute; "last" values in dictionary"""
@@ -198,12 +193,10 @@ class LF(FMFile):
             if v["data_type"] == "all" and (include_tuflow or "tuflow" not in k)
         }
 
-        df = pd.concat(data_type_all, axis=1)
-        df.columns = df.columns.droplevel()
-
-        df.sort_index(inplace=True)
+        lf_df = pd.concat(data_type_all, axis=1)
+        lf_df.columns = lf_df.columns.droplevel()
 
-        return df
+        return lf_df.sort_index()
 
     def _sync_cols(self):
         """Ensures Parser values (of type "all") have an entry each iteration"""