[Python] Make sure filepaths are kept for external files. (#2943)

Fixes #2934

Author: evetion

python/ribasim/ribasim/input_base.py

@@ -270,7 +270,7 @@ def _check_filepath(cls, value: Any, info: ValidationInfo) -> dict[str, Any]:
             # Skip loading when lazy (internal/external is False)
             # Otherwise load data and update our values
             # If no filepath is given, assume it is expected to be loaded from the database
-            filepath = value.pop("filepath", None)
+            filepath = value.get("filepath")
             if filepath is None and internal:
                 filepath = cls.default_filepath()
             elif filepath is not None and external:
@@ -280,8 +280,8 @@ def _check_filepath(cls, value: Any, info: ValidationInfo) -> dict[str, Any]:
                 return value
 
             data = cls._load(dir / filepath)
-            data.update(value)
-            return data
+            value.update(data)
+            return value
         else:
             raise ValueError(f"Invalid type of value for FileModel: {type(value)}")
 

python/ribasim/ribasim/model.py

@@ -539,7 +539,7 @@ def _load(cls, filepath: Path | None) -> dict[str, object]:
             with filepath.open("rb") as f:
                 config = tomli.load(f)
 
-            config["filepath"] = filepath
+            config["filepath"] = filepath  # make sure we store the whole filepath
             directory = filepath.parent / config["input_dir"]
             context_file_loading.get()["directory"] = directory
             _init_context_var.get()["directory"] = directory  # type: ignore

python/ribasim/tests/test_input_base.py

@@ -28,7 +28,7 @@ def test_tablename():
     assert cls.tablename() == "Link"
 
 
-def test_filepath_appears_in_toml(tmp_path):
+def test_filepath_appears_in_toml(tmp_path, basic_arrow):
     """Integration test: verify filepath is written to TOML and data to external file."""
     import tomli
 
@@ -81,3 +81,9 @@ def test_filepath_appears_in_toml(tmp_path):
         assert "level" in ds.variables, "level should be in the dataset"
         assert "area" in ds.variables, "area should be in the dataset"
         assert len(ds["level"]) == 3, "Should have 3 profile points"
+
+    # Make sure external files show up in the TOML after reading
+    assert basic_arrow.basin.profile.filepath == Path("profile.arrow")
+    basic_arrow.write(tmp_path / "test_model_arrow" / "ribasim.toml")
+    arrow_model = Model.read(tmp_path / "test_model_arrow" / "ribasim.toml")
+    assert arrow_model.basin.profile.filepath == Path("profile.arrow")