refactor(dfns): DfnRegistry.spec as method (#330)

Author: wpbonelli

autotest/dfns/test_registry.py

@@ -152,7 +152,7 @@ def test_local_dfn_registry(dfn_dir):
     registry = LocalDfnRegistry(path=dfn_dir)
     assert registry.path == dfn_dir.resolve()
 
-    spec = registry.spec
+    spec = registry.spec()
     assert spec.schema_version == "2.0.0.dev2"
     assert len(spec.components) > 100
     assert "gwf-chd" in spec.components
@@ -194,7 +194,7 @@ def test_remote_dfn_registry_sync():
     path = registry.get_path("gwf-chd")
     assert path.exists()
 
-    spec = registry.spec
+    spec = registry.spec()
     assert "gwf-chd" in spec.components
     assert "sim-nam" in spec.components
 

modflow_devtools/dfns/registry.py

@@ -11,7 +11,8 @@
 import tomli_w
 from pydantic import BaseModel, Field, PrivateAttr
 
-from modflow_devtools.dfns.schema import Dfns
+from modflow_devtools.dfn import schema as dfn
+from modflow_devtools.dfns import schema as dfns
 
 __all__ = [
     "DfnRegistry",
@@ -27,10 +28,7 @@ class DfnRegistry(BaseModel):
 
     model_config = {"arbitrary_types_allowed": True}
 
-    _spec: Dfns | None = PrivateAttr(default=None, init=False)
-
-    @property
-    def spec(self) -> Dfns:
+    def spec(self, schema_version: str = dfns.CURRENT_SCHEMA_VERSION) -> dfns.Dfns | dfn.Dfns:
         raise NotImplementedError
 
     def get_path(self, component: str) -> Path:
@@ -45,11 +43,10 @@ class LocalDfnRegistry(DfnRegistry):
     def model_post_init(self, _) -> None:
         object.__setattr__(self, "path", Path(self.path).expanduser().resolve())
 
-    @property
-    def spec(self) -> Dfns:
-        if self._spec is None:
-            self._spec = Dfns.load(self.path)
-        return self._spec
+    def spec(self, schema_version: str = dfns.CURRENT_SCHEMA_VERSION) -> dfns.Dfns | dfn.Dfns:
+        if schema_version == dfns.CURRENT_SCHEMA_VERSION:
+            return dfns.Dfns.load(self.path)
+        return dfn.Dfn.load_all(self.path, schema_version=schema_version)  # type: ignore
 
     def get_path(self, component: str) -> Path:
         for ext in [".dfn", ".toml"]:
@@ -163,13 +160,12 @@ def cache_path(self) -> Path:
         repo, _ = self.release_id.split("@")
         return RemoteDfnRegistry.base_cache_path() / repo / self.latest_tag()
 
-    @property
-    def spec(self) -> Dfns:
-        if self._spec is None:
-            if not self.cache_path.exists() or not any(self.cache_path.iterdir()):
-                self.sync()
-            self._spec = Dfns.load(self.cache_path)
-        return self._spec
+    def spec(self, schema_version: str = dfns.CURRENT_SCHEMA_VERSION) -> dfns.Dfns | dfn.Dfns:
+        if not self.cache_path.exists() or not any(self.cache_path.iterdir()):
+            self.sync()
+        if schema_version == dfns.CURRENT_SCHEMA_VERSION:
+            return dfns.Dfns.load(self.cache_path)
+        return dfn.Dfn.load_all(self.cache_path, schema_version=schema_version)  # type: ignore
 
     def sync(self, force: bool = False) -> None:
         """Download and extract DFN files for this release to the local cache."""

pyproject.toml

@@ -166,9 +166,11 @@ mf = "modflow_devtools.cli:main"
 
 [tool.hatch.build.targets.sdist]
 only-include = ["modflow_devtools"]
+core-metadata-version = "2.4"
 
 [tool.hatch.build.targets.wheel]
 packages = ["modflow_devtools"]
+core-metadata-version = "2.4"
 
 [tool.hatch.build]
 include = [