revert models/programs api changes

Author: wpbonelli

modflow_devtools/cli.py

@@ -47,9 +47,9 @@ def _sync_all():
     # Sync Models
     print("=== Models ===")
     try:
-        from modflow_devtools.models import ModelSources
+        from modflow_devtools.models import ModelSourceConfig
 
-        config = ModelSources.load()
+        config = ModelSourceConfig.load()
         config.sync()
         print("Models synced successfully")
     except Exception as e:

modflow_devtools/models/__init__.py

@@ -442,8 +442,8 @@ class DiscoveredModelRegistry:
     url: str
 
 
-class ModelSource(BaseModel):
-    """Model source repository configuration."""
+class ModelSourceRepo(BaseModel):
+    """A single source model repository in the bootstrap file."""
 
     @dataclass
     class SyncResult:
@@ -462,14 +462,18 @@ class SyncStatus:
         cached_refs: list[str]
         missing_refs: list[str]
 
+    repo: str = Field(..., description="Repository in format 'owner/name'")
     name: str = Field(
         ..., description="Name for model addressing (injected from key if not explicit)"
     )
-    repo: str = Field(..., description="Repository in format 'owner/name'")
     refs: list[str] = Field(
         default_factory=list,
         description="Default refs to sync (branches, tags, or commit hashes)",
     )
+    registry_path: str = Field(
+        default=".registry",
+        description="Path to registry directory in repository",
+    )
 
     @field_validator("repo")
     @classmethod
@@ -595,9 +599,9 @@ def sync(
         if not refs:
             if verbose:
                 print(f"No refs configured for source '{source_name}', aborting")
-            return ModelSource.SyncResult()
+            return ModelSourceRepo.SyncResult()
 
-        result = ModelSource.SyncResult()
+        result = ModelSourceRepo.SyncResult()
 
         for ref in refs:
             if not force and _DEFAULT_CACHE.has(source_name, ref):
@@ -658,41 +662,92 @@ def list_synced_refs(self) -> list[str]:
         return [ref for source, ref in cached if source == self.name]
 
 
-class ModelSources(BaseModel):
-    """Configuration for multiple model source repositories."""
+class ModelSourceConfig(BaseModel):
+    """Model source configuration file structure."""
 
-    sources: dict[str, ModelSource] = Field(
-        default_factory=dict, description="Model source repositories"
+    sources: dict[str, ModelSourceRepo] = Field(
+        ..., description="Map of source names to source metadata"
     )
 
     @classmethod
     def load(
         cls,
-        path: str | PathLike | None = None,
-    ) -> "ModelSources":
-        """Load model source configurations from a TOML file."""
-        path = Path(path)
-        if not path.exists():
-            return cls()
-
-        with path.open("rb") as f:
-            data = tomli.load(f)
+        bootstrap_path: str | PathLike | None = None,
+        user_config_path: str | PathLike | None = None,
+    ) -> "ModelSourceConfig":
+        """
+        Load model source configuration.
 
-        sources = {}
-        for name, config in data.get("sources", {}).items():
-            sources[name] = ModelSource(**config)
+        Parameters
+        ----------
+        bootstrap_path : str | PathLike | None
+            Path to bootstrap config file. If None, uses bundled default.
+            If provided, ONLY this file is loaded (no user config overlay unless specified).
+        user_config_path : str | PathLike | None
+            Path to user config file to overlay on top of bootstrap.
+            If None and bootstrap_path is None, attempts to load from default user config location.
 
-        return cls(sources=sources)
+        Returns
+        -------
+        ModelSourceConfig
+            Loaded and merged configuration
+        """
+        # Load base config
+        if bootstrap_path is not None:
+            # Explicit bootstrap path - only load this file
+            with Path(bootstrap_path).open("rb") as f:
+                cfg = tomli.load(f)
+        else:
+            # Use bundled default
+            with _DEFAULT_CONFIG_PATH.open("rb") as f:
+                cfg = tomli.load(f)
+
+            # If no explicit bootstrap path, try to load user config overlay
+            if user_config_path is None:
+                user_config_path = get_user_config_path()
+
+        # Overlay user config if specified or found
+        if user_config_path is not None:
+            user_path = Path(user_config_path)
+            if user_path.exists():
+                with user_path.open("rb") as f:
+                    user_cfg = tomli.load(f)
+                    # Merge user config sources into base config
+                    if "sources" in user_cfg:
+                        if "sources" not in cfg:
+                            cfg["sources"] = {}
+                        cfg["sources"] = cfg["sources"] | user_cfg["sources"]
+
+        # inject source names if not explicitly provided
+        for name, src in cfg.get("sources", {}).items():
+            if "name" not in src:
+                src["name"] = name
+
+        return cls(**cfg)
 
     @classmethod
-    def merge(cls, base: "ModelSources", overlay: "ModelSources") -> "ModelSources":
-        """Merge two source configurations. Overlay takes precedence."""
-        merged = dict(base.sources)
-        merged.update(overlay.sources)
-        return cls(sources=merged)
+    def merge(cls, base: "ModelSourceConfig", overlay: "ModelSourceConfig") -> "ModelSourceConfig":
+        """
+        Merge two configurations, with overlay taking precedence.
+
+        Parameters
+        ----------
+        base : ModelSourceConfig
+            Base configuration
+        overlay : ModelSourceConfig
+            Configuration to overlay on top of base
+
+        Returns
+        -------
+        ModelSourceConfig
+            Merged configuration
+        """
+        merged_sources = base.sources.copy()
+        merged_sources.update(overlay.sources)
+        return cls(sources=merged_sources)
 
     @property
-    def status(self) -> dict[str, ModelSource.SyncStatus]:
+    def status(self) -> dict[str, ModelSourceRepo.SyncStatus]:
         """
         Sync status for all configured model source repositories.
 
@@ -717,7 +772,7 @@ def status(self) -> dict[str, ModelSource.SyncStatus]:
                 else:
                     missing.append(ref)
 
-            status[name] = ModelSource.SyncStatus(
+            status[name] = ModelSourceRepo.SyncStatus(
                 repo=source.repo,
                 configured_refs=refs,
                 cached_refs=cached,
@@ -728,10 +783,10 @@ def status(self) -> dict[str, ModelSource.SyncStatus]:
 
     def sync(
         self,
-        source: str | ModelSource | None = None,
+        source: str | ModelSourceRepo | None = None,
         force: bool = False,
         verbose: bool = False,
-    ) -> dict[str, ModelSource.SyncResult]:
+    ) -> dict[str, ModelSourceRepo.SyncResult]:
         """
         Synchronize registry files from model source(s).
 
@@ -753,7 +808,7 @@ def sync(
         """
 
         if source:
-            if isinstance(source, ModelSource):
+            if isinstance(source, ModelSourceRepo):
                 if source.name not in self.sources:
                     raise ValueError(f"Source '{source.name}' not found in bootstrap")
                 sources = [source]
@@ -1249,7 +1304,7 @@ def _try_best_effort_sync():
 
     try:
         # Try to sync default refs (don't be verbose, don't fail on errors)
-        config = ModelSources.load()
+        config = ModelSourceConfig.load()
         config.sync(verbose=False)
     except Exception:
         # Silently fail - user will get clear error when trying to use registry

modflow_devtools/models/__main__.py

@@ -17,7 +17,7 @@
 
 from . import (
     _DEFAULT_CACHE,
-    ModelSources,
+    ModelSourceConfig,
     _try_best_effort_sync,
 )
 
@@ -47,7 +47,7 @@ def _format_grid(items, prefix=""):
 
 def cmd_sync(args):
     """Sync command handler."""
-    config = ModelSources.load()
+    config = ModelSourceConfig.load()
 
     # If a specific source is provided, sync just that source
     if args.source:
@@ -65,9 +65,9 @@ def cmd_sync(args):
         if source_obj is None:
             # If --repo is provided, create an ad-hoc source
             if args.repo:
-                from . import ModelSource
+                from . import ModelSourceRepo
 
-                source_obj = ModelSource(
+                source_obj = ModelSourceRepo(
                     repo=args.repo,
                     name=args.source,
                     refs=[args.ref] if args.ref else [],
@@ -111,7 +111,7 @@ def cmd_info(args):
     if os.environ.get("MODFLOW_DEVTOOLS_AUTO_SYNC", "").lower() in ("1", "true", "yes"):
         _try_best_effort_sync()
 
-    config = ModelSources.load()
+    config = ModelSourceConfig.load()
     status = config.status
 
     if not status:

modflow_devtools/programs/__init__.py

@@ -836,7 +836,7 @@ def download_archive(
         if github_token:
             headers["Authorization"] = f"token {github_token}"
 
-        response = requests.get(url, headers=headers, stream=True, timeout=30)  # type: ignore
+        response = requests.get(url, headers=headers, stream=True, timeout=30)
         response.raise_for_status()
 
         # Write to temporary file first