refactor: generalize exchange detection (#100)

check for "X-X" pattern to find like-model exchanges without hardcoding exchange names

Author: wpbonelli

modflowapi/extensions/apiexchange.py

@@ -1,11 +1,10 @@
 from .apimodel import ApiMbase
-from .pakbase import ListPackage
 
 
 class ApiExchange(ApiMbase):
     """
-    ApiExchange class for GWF-GWF packages and container to access the
-    simulation level GWF-GWF, MVR, and GNC packages
+    ApiExchange class for exchange packages (e.g. GWF-GWF, GWT-GWT) and
+    container to access simulation level exchange, MVR, and GNC packages
 
     Parameters
     ----------
@@ -16,9 +15,4 @@ class ApiExchange(ApiMbase):
     """
 
     def __init__(self, mf6, name):
-        pkg_types = {
-            "gwf-gwf": ListPackage,
-            "gwt-gwt": ListPackage,
-            "gwe-gwe": ListPackage,
-        }
-        super().__init__(mf6, name, pkg_types)
+        super().__init__(mf6, name)

modflowapi/extensions/apimodel.py

@@ -1,5 +1,6 @@
 import numpy as np
 
+from ..util import is_exg
 from .datamodel import get_package_type, gridshape
 from .pakbase import AdvancedPackage, ArrayPackage, ListPackage, package_factory
 
@@ -15,7 +16,8 @@ class ApiMbase:
     name : str
         modflow model name. ex. "GWF_1", "GWF-GWF_1"
     pkg_types : None, dict
-        optional dictionary of package types and ApiPackage class types
+        optional dictionary of package types and ApiPackage class types,
+        used to override the default package class selection
     """
 
     def __init__(self, mf6, name, pkg_types=None):
@@ -56,11 +58,9 @@ def _set_package_names(self):
             if addr.endswith("PACKAGE_TYPE") and tmp[0] == self.name:
                 pak_types[tmp[1]] = self.mf6.get_value(addr)[0]
             elif tmp[0] == self.name and len(tmp) == 2:
-                if tmp[0].startswith("GWF-GWF"):
-                    pak_types[tmp[0]] = "GWF-GWF"
-                    pak_types.pop("dis", None)
-                elif tmp[0].startswith("GWT-GWT"):
-                    pak_types[tmp[0]] = "GWT-GWT"
+                pkg_type = tmp[0].rsplit("_", 1)[0]
+                if is_exg(pkg_type):
+                    pak_types[tmp[0]] = pkg_type
                     pak_types.pop("dis", None)
 
         self._pak_type = list(pak_types.values())
@@ -72,18 +72,15 @@ def _create_package_list(self):
         """
         for ix, pkg_name in enumerate(self._pkg_names):
             pkg_type = self._pak_type[ix].lower()
-            if self._pkg_types is None:
-                basepackage = get_package_type(pkg_type)
+            if self._pkg_types is not None and pkg_type in self._pkg_types:
+                basepackage = self._pkg_types[pkg_type]
+            elif is_exg(pkg_type):
+                basepackage = ListPackage
             else:
-                if pkg_type in self._pkg_types:
-                    basepackage = self._pkg_types[pkg_type]
-                else:
-                    basepackage = AdvancedPackage
+                basepackage = get_package_type(pkg_type)
 
             package = package_factory(pkg_type, basepackage)
-            adj_pkg_name = "".join(pkg_type.split("-"))
-
-            if adj_pkg_name.lower() in ("gwfgwf", "gwtgwt"):
+            if is_exg(pkg_type):
                 adj_pkg_name = ""
             else:
                 adj_pkg_name = pkg_name

modflowapi/extensions/apisimulation.py

@@ -1,5 +1,6 @@
 import numpy as np
 
+from ..util import is_exg
 from .apiexchange import ApiExchange
 from .apimodel import ApiMbase, ApiModel
 from .pakbase import ApiSlnPackage, ListPackage, ScalarPackage, package_factory
@@ -49,7 +50,7 @@ def __getattr__(self, item):
             return super().__getattribute__(item)
 
     def __repr__(self):
-        s = self.__doc__
+        s = self.__doc__ or ""
         s += f"Number of models: {len(self._models)}:\n"
         for name, obj in self._models.items():
             s += f"\t{name} : {type(obj)}\n"
@@ -147,7 +148,7 @@ def model_names(self):
     @property
     def exchange_names(self):
         """
-        Returns a list of exchange GWF-GWF names
+        Returns a list of exchange names (e.g. "GWF-GWF_1")
         """
         if self._exchanges.keys():
             return list(self._exchanges.keys())
@@ -240,13 +241,13 @@ def get_model(self, model_id=None):
 
     def get_exchange(self, exchange_name=None):
         """
-        Get a GWF-GWF "model" and all associated simulation level package
-        data (ex. GNC, MVR)
+        Get an exchange and all associated simulation level package data
+        (ex. GNC, MVR)
 
         Parameters
         ----------
         exchange_name : str
-            name of the GWF-GWF exchange package
+            name of the exchange package (e.g. "GWF-GWF_1")
 
         Returns
         -------
@@ -367,10 +368,10 @@ def load(mf6):
         # get the exchanges
         exchange_names = []
         for variable in variables:
-            if variable.startswith("GWF-GWF") or variable.startswith("GWT-GWT"):
-                exchange_name = variable.split("/")[0]
-                if exchange_name not in exchange_names:
-                    exchange_names.append(exchange_name)
+            exchange_name = variable.split("/")[0]
+            name = exchange_name.rsplit("_", 1)[0]
+            if is_exg(name) and exchange_name not in exchange_names:
+                exchange_names.append(exchange_name)
 
         # sim_packages: tdis, gwf-gwf, sln
         exchanges = {}

modflowapi/modflowapi.py

@@ -1,3 +1,5 @@
+from os import PathLike
+
 from xmipy import XmiWrapper
 
 from .util import amend_libmf6_path
@@ -16,8 +18,8 @@ class ModflowApi(XmiWrapper):
 
     def __init__(
         self,
-        lib_path: str,
-        lib_dependency: str = None,
+        lib_path: str | PathLike,
+        lib_dependency: str | None = None,
         working_directory: str = ".",
         timing: bool = False,
         logger_level: int | str = 0,

modflowapi/util.py

@@ -1,8 +1,9 @@
+from os import PathLike
 from pathlib import Path
 from platform import system
 
 
-def amend_libmf6_path(path) -> str:
+def amend_libmf6_path(path: str | PathLike) -> str:
     ext = Path(path).suffix
     path = str(path)
     os = system().lower()
@@ -19,3 +20,8 @@ def amend_libmf6_path(path) -> str:
     elif os == "darwin" and not ext:
         path += ".dylib"
     return path
+
+
+def is_exg(pkg_type: str):
+    parts = pkg_type.split("-")
+    return len(parts) == 2 and parts[0] == parts[1]