tidier converter

Author: wpbonelli

flopy4/mf6/binding.py

@@ -0,0 +1,51 @@
+from attrs import define
+
+from flopy4.mf6.component import Component
+from flopy4.mf6.exchange import Exchange
+from flopy4.mf6.model import Model
+from flopy4.mf6.package import Package
+from flopy4.mf6.solution import Solution
+
+
+@define
+class Binding:
+    """
+    An MF6 component binding: a record representation of the
+    component for writing to a parent component's name file.
+    """
+
+    type: str
+    fname: str
+    terms: tuple[str, ...] | None = None
+
+    def to_tuple(self) -> tuple[str, ...]:
+        if self.terms and any(self.terms):
+            return (self.type, self.fname, *self.terms)
+        else:
+            return (self.type, self.fname)
+
+    @classmethod
+    def from_component(cls, component: Component) -> "Binding":
+        def _get_binding_type(component: Component) -> str:
+            cls_name = component.__class__.__name__
+            if isinstance(component, Exchange):
+                return f"{'-'.join([cls_name[:2], cls_name[3:]]).upper()}6"
+            elif isinstance(component, Solution):
+                return f"{component.slntype}6"
+            else:
+                return f"{cls_name.upper()}6"
+
+        def _get_binding_terms(component: Component) -> tuple[str, ...] | None:
+            if isinstance(component, Exchange):
+                return (component.exgmnamea, component.exgmnameb)  # type: ignore
+            elif isinstance(component, Solution):
+                return tuple(component.models)
+            elif isinstance(component, (Model, Package)):
+                return (component.name,)  # type: ignore
+            return None
+
+        return cls(
+            type=_get_binding_type(component),
+            fname=component.filename or component.default_filename(),
+            terms=_get_binding_terms(component),
+        )

flopy4/mf6/codec/writer/filters.py

@@ -136,13 +136,15 @@ def array2const(value: xr.DataArray) -> Scalar:
         return f"{value.max().item():.8f}"
 
 
-def data2list(value: list | tuple | dict | xr.Dataset | xr.DataArray):
+def data2list(value: list | dict | xr.Dataset | xr.DataArray):
     """
     Yield records (tuples) from data in a `list`, `dict`, `DataArray` or `Dataset`.
     """
 
-    if isinstance(value, (list, tuple)):
+    if isinstance(value, list):
         for rec in value:
+            if not isinstance(rec, tuple):
+                raise ValueError(f"Unsupported record type: {type(rec)}")
             yield rec
         return
 

flopy4/mf6/component.py

@@ -1,12 +1,13 @@
 from abc import ABC
 from collections.abc import MutableMapping
 from pathlib import Path
-from typing import ClassVar
+from typing import Any, ClassVar
 
 import numpy as np
 from attrs import fields
 from modflow_devtools.dfn import Dfn, Field
 from packaging.version import Version
+from xattree import asdict as xattree_asdict
 from xattree import xattree
 
 from flopy4.mf6.constants import FILL_DNODATA, MF6
@@ -197,3 +198,16 @@ def write(self, format: str = MF6) -> None:
         self._write(format=format)
         for child in self.children.values():  # type: ignore
             child.write(format=format)
+
+    def to_dict(self, blocks: bool = False) -> dict[str, Any]:
+        """Convert the component to a dictionary representation."""
+        data = xattree_asdict(self)
+        if blocks:
+            blocks_ = {}
+            for field_name, field_meta in self.data.attrs["metadata"].items():
+                block_name = field_meta["block"]
+                if block_name not in blocks_:
+                    blocks_[block_name] = {}
+                blocks_[block_name][field_name] = data[field_name]
+            return blocks_
+        return data

flopy4/mf6/constants.py

@@ -1,5 +1,6 @@
 import numpy as np
 
 MF6 = "mf6"
+PERIOD = "period"
 FILL_DEFAULT = np.nan
 FILL_DNODATA = 1e30