update xattree and spec field array decorator wrapper to support dtype

wpbonelli · wpbonelli · commit e6c61f3d51e2 · 2025-10-23T13:55:14.000-04:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,6 +13,7 @@
         }
     },
     "python.analysis.typeCheckingMode": "off",
+    "debugpy.debugJustMyCode": false,
     "files.exclude": {
         "**/.git": true,
         "**/.svn": true,
diff --git a/flopy4/mf6/constants.py b/flopy4/mf6/constants.py
@@ -3,3 +3,4 @@
 MF6 = "mf6"
 FILL_DEFAULT = np.nan
 FILL_DNODATA = 1e30
+LENBOUNDNAME = 40
diff --git a/flopy4/mf6/gwf/chd.py b/flopy4/mf6/gwf/chd.py
@@ -7,6 +7,7 @@
 from xattree import xattree
 
 from flopy4.mf6.component import update_maxbound
+from flopy4.mf6.constants import LENBOUNDNAME
 from flopy4.mf6.converter import dict_to_array
 from flopy4.mf6.package import Package
 from flopy4.mf6.spec import array, field, path
@@ -51,6 +52,7 @@ class Chd(Package):
         on_setattr=update_maxbound,
     )
     boundname: Optional[NDArray[np.str_]] = array(
+        dtype=f"<U{LENBOUNDNAME}",
         block="period",
         dims=(
             "nper",
diff --git a/flopy4/mf6/gwf/dis.py b/flopy4/mf6/gwf/dis.py
@@ -64,7 +64,7 @@ class Dis(Package):
         dims=("nlay", "nrow", "ncol"),
         converter=Converter(dict_to_array, takes_self=True, takes_field=True),
     )
-    idomain: Optional[NDArray[np.int32]] = array(
+    idomain: Optional[NDArray[np.int64]] = array(
         block="griddata",
         default=1,
         dims=("nlay", "nrow", "ncol"),
diff --git a/flopy4/mf6/gwf/drn.py b/flopy4/mf6/gwf/drn.py
@@ -7,6 +7,7 @@
 from xattree import xattree
 
 from flopy4.mf6.component import update_maxbound
+from flopy4.mf6.constants import LENBOUNDNAME
 from flopy4.mf6.converter import dict_to_array
 from flopy4.mf6.package import Package
 from flopy4.mf6.spec import array, field, path
@@ -57,6 +58,7 @@ class Drn(Package):
         on_setattr=update_maxbound,
     )
     boundname: Optional[NDArray[np.str_]] = array(
+        dtype=f"<U{LENBOUNDNAME}",
         block="period",
         dims=(
             "nper",
diff --git a/flopy4/mf6/gwf/npf.py b/flopy4/mf6/gwf/npf.py
@@ -50,7 +50,7 @@ class Xt3dOptions:
     export_array_netcdf: bool = field(block="options", default=False)
     dev_no_newton: bool = field(block="options", default=False)
     dev_omega: Optional[float] = field(block="options", default=None)
-    icelltype: NDArray[np.integer] = array(
+    icelltype: NDArray[np.int64] = array(
         block="griddata",
         dims=("nodes",),
         default=0,
diff --git a/flopy4/mf6/gwf/oc.py b/flopy4/mf6/gwf/oc.py
@@ -47,24 +47,28 @@ class Period:
     # TODO: needs coverter and then rename?
     head: Optional[Format] = field(block="options", default=None)
     save_head: Optional[NDArray[np.str_]] = array(
+        dtype=np.dtypes.StringDType(),
         block="period",
         default="all",
         dims=("nper",),
         converter=Converter(dict_to_array, takes_self=True, takes_field=True),
     )
     save_budget: Optional[NDArray[np.str_]] = array(
+        dtype=np.dtypes.StringDType(),
         block="period",
         default="all",
         dims=("nper",),
         converter=Converter(dict_to_array, takes_self=True, takes_field=True),
     )
     print_head: Optional[NDArray[np.str_]] = array(
+        dtype=np.dtypes.StringDType(),
         block="period",
         default="all",
         dims=("nper",),
         converter=Converter(dict_to_array, takes_self=True, takes_field=True),
     )
     print_budget: Optional[NDArray[np.str_]] = array(
+        dtype=np.dtypes.StringDType(),
         block="period",
         default="all",
         dims=("nper",),
diff --git a/flopy4/mf6/gwf/rch.py b/flopy4/mf6/gwf/rch.py
@@ -7,6 +7,7 @@
 from xattree import xattree
 
 from flopy4.mf6.component import update_maxbound
+from flopy4.mf6.constants import LENBOUNDNAME
 from flopy4.mf6.converter import dict_to_array
 from flopy4.mf6.package import Package
 from flopy4.mf6.spec import array, field, path
@@ -51,6 +52,7 @@ class Rch(Package):
         on_setattr=update_maxbound,
     )
     boundname: Optional[NDArray[np.str_]] = array(
+        dtype=f"<U{LENBOUNDNAME}",
         block="period",
         dims=(
             "nper",
diff --git a/flopy4/mf6/gwf/sto.py b/flopy4/mf6/gwf/sto.py
@@ -24,7 +24,7 @@ class Sto(Package):
     export_array_netcdf: bool = field(block="options", default=False)
     dev_original_specific_storage: bool = field(block="options", default=False)
     dev_oldstorageformulation: bool = field(block="options", default=False)
-    iconvert: NDArray[np.int32] = array(
+    iconvert: NDArray[np.int64] = array(
         block="griddata",
         dims=("nodes",),
         default=0,
diff --git a/flopy4/mf6/gwf/wel.py b/flopy4/mf6/gwf/wel.py
@@ -7,6 +7,7 @@
 from xattree import xattree
 
 from flopy4.mf6.component import update_maxbound
+from flopy4.mf6.constants import LENBOUNDNAME
 from flopy4.mf6.converter import dict_to_array
 from flopy4.mf6.package import Package
 from flopy4.mf6.spec import array, field, path
@@ -55,6 +56,7 @@ class Wel(Package):
         on_setattr=update_maxbound,
     )
     boundname: Optional[NDArray[np.str_]] = array(
+        dtype=f"<U{LENBOUNDNAME}",
         block="period",
         dims=(
             "nper",
diff --git a/flopy4/mf6/spec.py b/flopy4/mf6/spec.py
@@ -130,7 +130,7 @@ def coord(
 
 
 def array(
-    cls=None,
+    dtype: np.dtype | str | type | None = None,
     dims=None,
     default=NOTHING,
     validator=None,
@@ -146,7 +146,7 @@ def array(
         metadata = metadata or {}
         metadata["block"] = block
     return flopy_array(
-        cls=cls,
+        dtype=dtype,
         dims=dims,
         default=default,
         validator=validator,
diff --git a/flopy4/mf6/tdis.py b/flopy4/mf6/tdis.py
@@ -29,7 +29,7 @@ class PeriodData:
         dims=("nper",),
         converter=Converter(dict_to_array, takes_self=True, takes_field=True),
     )
-    nstp: NDArray[np.integer] = array(
+    nstp: NDArray[np.int64] = array(
         block="perioddata",
         default=1,
         dims=("nper",),
diff --git a/flopy4/spec.py b/flopy4/spec.py
@@ -5,6 +5,7 @@
 to any field indicating it is not part of the formal spec?
 """
 
+import numpy as np
 from attrs import NOTHING, Attribute
 from xattree import array as xattree_array
 from xattree import coord as xattree_coord
@@ -75,7 +76,7 @@ def coord(
 
 
 def array(
-    cls=None,
+    dtype: np.dtype | str | type | None = None,
     dims=None,
     default=NOTHING,
     validator=None,
@@ -87,7 +88,7 @@ def array(
 ):
     """Define an array field."""
     return xattree_array(
-        cls=cls,
+        dtype=dtype,
         dims=dims,
         default=default,
         validator=validator,
diff --git a/pixi.lock b/pixi.lock
diff --git a/test/test_codec.py b/test/test_codec.py
diff --git a/test/test_component.py b/test/test_component.py

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`}`
`14`	`14`	`},`
`15`	`15`	`"python.analysis.typeCheckingMode": "off",`
	`16`	`+ "debugpy.debugJustMyCode": false,`
`16`	`17`	`"files.exclude": {`
`17`	`18`	`"**/.git": true,`
`18`	`19`	`"**/.svn": true,`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ class Dis(Package):`
`64`	`64`	`dims=("nlay", "nrow", "ncol"),`
`65`	`65`	`converter=Converter(dict_to_array, takes_self=True, takes_field=True),`
`66`	`66`	`)`
`67`		`- idomain: Optional[NDArray[np.int32]] = array(`
	`67`	`+ idomain: Optional[NDArray[np.int64]] = array(`
`68`	`68`	`block="griddata",`
`69`	`69`	`default=1,`
`70`	`70`	`dims=("nlay", "nrow", "ncol"),`