throw for invalid argument format-verison, fallback to latest for invalid discovered format-versions

Author: FynnBe

src/bioimageio/spec/_description.py

@@ -145,8 +145,10 @@ def dump_description(
  for a given **type** and **format_version**."""
 
 
-def _get_rd_class(typ: Any, format_version: Any):
-    return get_rd_class_impl(typ, format_version, DESCRIPTIONS_MAP)
+def _get_rd_class(typ: Any, format_version: Any, fallback_to_latest: bool):
+    return get_rd_class_impl(
+        typ, format_version, DESCRIPTIONS_MAP, fallback_to_latest=fallback_to_latest
+    )
 
 
 @overload

src/bioimageio/spec/_description_impl.py

@@ -4,6 +4,7 @@
 from typing import Any, Callable, List, Literal, Mapping, Optional, Type, TypeVar, Union
 
 from ._internal.common_nodes import InvalidDescr, ResourceDescrBase
+from ._internal.field_validation import issue_warning
 from ._internal.io import BioimageioYamlContentView
 from ._internal.types import FormatVersionPlaceholder
 from ._internal.validation_context import ValidationContext, get_validation_context
@@ -23,6 +24,7 @@ def get_rd_class_impl(
     typ: Any,
     format_version: Any,
     descriptions_map: Mapping[Optional[str], Mapping[str, Type[ResourceDescrT]]],
+    fallback_to_latest: bool,
 ) -> Type[ResourceDescrT]:
     """get the resource description class for the given type and format version"""
     assert None in descriptions_map
@@ -46,10 +48,20 @@ def get_rd_class_impl(
 
     descr_versions = descriptions_map[typ]
     if use_format_version not in descr_versions:
-        raise ValueError(
-            f"Unsupported format version '{format_version}' for type '{typ}'. "
-            + f"Supported format versions are: {', '.join(sorted(fv for fv in descr_versions))}"
-        )
+        if fallback_to_latest:
+            issue_warning(
+                "Unsupported format version '{value}' for type '{typ}'.",
+                value=format_version,
+                field="format_version",
+                log_depth=3,
+                msg_context={"typ": typ},
+            )
+            use_format_version = "latest"
+        else:
+            raise ValueError(
+                f"Unsupported format version '{format_version}' for type '{typ}'."
+                + " Supported format versions are: {', '.join(sorted(fv for fv in descr_versions))}"
+            )
 
     return descr_versions[use_format_version]
 
@@ -60,7 +72,7 @@ def build_description_impl(
     *,
     context: Optional[ValidationContext] = None,
     format_version: Union[FormatVersionPlaceholder, str] = DISCOVER,
-    get_rd_class: Callable[[Any, Any], Type[ResourceDescrT]],
+    get_rd_class: Callable[[Any, Any, bool], Type[ResourceDescrT]],
 ) -> Union[ResourceDescrT, InvalidDescr]:
     context = context or get_validation_context()
     errors: List[ErrorEntry] = []
@@ -101,17 +113,19 @@ def build_description_impl(
         return ret
 
     typ = content["type"]
-    rd_class = get_rd_class(typ, content["format_version"])
+    # check format_version argument before loading as 'discover'
+    # to throw an exception for an invalid format_version early
+    if str(format_version).lower() != DISCOVER:
+        as_rd_class = get_rd_class(typ, format_version, False)
+    else:
+        as_rd_class = None
+    # always load with discovered format_version first
+    rd_class = get_rd_class(typ, content["format_version"], True)
     rd = rd_class.load(content, context=context)
 
-    if str(format_version).lower() not in (
-        DISCOVER,
-        rd_class.implemented_format_version,
-        ".".join(map(str, rd_class.implemented_format_version_tuple[:2])),
-    ):
+    if as_rd_class is not None and as_rd_class is not rd_class:
         # load with requested format_version
         discover_details = rd.validation_summary.details
-        as_rd_class = get_rd_class(typ, format_version)
         rd = as_rd_class.load(content, context=context)
         assert rd.validation_summary is not None
         rd.validation_summary.details[:0] = discover_details