feat: model mapping (#192)

expose the model mapping so consumers can ask which models are available without using dir()

Author: wpbonelli

autotest/test_models.py

@@ -29,11 +29,22 @@ def temp_cache_dir(tmpdir, monkeypatch):
     return temp_dir
 
 
-def test_registry_loaded():
+def test_registry():
     assert models.FETCHER.registry is not None, "Registry was not loaded"
     assert len(models.FETCHER.registry) > 0, "Registry is empty"
 
 
+def test_model_map(models_toml):
+    assert models.model_map()
+    for model_name, files in models_toml.items():
+        assert model_name in models.model_map().keys(), (
+            f"Model {model_name} not found in model map"
+        )
+        assert files == models.model_map()[model_name], (
+            f"Files for model {model_name} do not match"
+        )
+
+
 def test_generated_functions_exist(models_toml):
     for model_name in models_toml.keys():
         assert hasattr(models, model_name), (

modflow_devtools/models.py

@@ -37,7 +37,7 @@
 
 def _generate_function(model_name, files) -> callable:
     def model_function():
-        return [FETCHER.fetch(file) for file in files]
+        return [Path(FETCHER.fetch(file)) for file in files]
 
     model_function.__name__ = model_name
     return model_function
@@ -49,10 +49,15 @@ def _attach_functions(models):
     else:
         with Path(models).open("rb") as f:
             models = tomli.load(f)
+    globals()["_models"] = models
     for name, files in models.items():
         globals()[name] = _generate_function(name, files)
 
 
+def model_map() -> dict[str, list[Path]]:
+    return globals().get("_models", {})
+
+
 try:
     with pkg_resources.open_binary(DATA_ANCHOR, MODELMAP_NAME) as f:
         _attach_functions(f)