✨ Return True for is_ngff With Warning Above Max NGFF Version (#577)

This PR Changes `is_ngff` to return True when above the max supported version with a warning logged.

Co-authored-by: Shan Raza <[email protected]>

Author: John-P

tests/test_wsireader.py

@@ -2118,7 +2118,7 @@ def test_ngff_omero_below_min_version(tmp_path):
         wsireader.WSIReader.open(sample_copy)
 
 
-def test_ngff_omero_above_max_version(tmp_path):
+def test_ngff_omero_above_max_version(tmp_path, caplog):
     """Test for FileNotSupported when omero version is above maximum."""
     sample = _fetch_remote_sample("ngff-1")
     # Create a copy of the sample
@@ -2130,8 +2130,10 @@ def test_ngff_omero_above_max_version(tmp_path):
     zattrs["omero"]["version"] = "10.0"
     with open(sample_copy / ".zattrs", "w") as fh:
         json.dump(zattrs, fh, indent=2)
-    with pytest.raises(FileNotSupported):
+    # Check that the warning is logged
+    with caplog.at_level(logging.WARNING):
         wsireader.WSIReader.open(sample_copy)
+    assert "maximum supported version" in caplog.text
 
 
 def test_ngff_multiscales_below_min_version(tmp_path):
@@ -2150,7 +2152,7 @@ def test_ngff_multiscales_below_min_version(tmp_path):
         wsireader.WSIReader.open(sample_copy)
 
 
-def test_ngff_multiscales_above_max_version(tmp_path):
+def test_ngff_multiscales_above_max_version(tmp_path, caplog):
     """Test for FileNotSupported when multiscales version is above maximum."""
     sample = _fetch_remote_sample("ngff-1")
     # Create a copy of the sample
@@ -2162,8 +2164,10 @@ def test_ngff_multiscales_above_max_version(tmp_path):
     zattrs["multiscales"][0]["version"] = "10.0"
     with open(sample_copy / ".zattrs", "w") as fh:
         json.dump(zattrs, fh, indent=2)
-    with pytest.raises(FileNotSupported):
+    # Check that the warning is logged
+    with caplog.at_level(logging.WARNING):
         wsireader.WSIReader.open(sample_copy)
+    assert "maximum supported version" in caplog.text
 
 
 def test_ngff_non_numeric_version(tmp_path, monkeypatch):

tiatoolbox/wsicore/wsireader.py

@@ -165,7 +165,7 @@ def is_ngff(
                 max_version,
                 multiscales_versions,
             )
-            return False
+            return True
 
     if len(multiscales_versions) > 1:
         logger.warning(
@@ -189,7 +189,7 @@ def is_ngff(
             max_version,
             multiscales_versions,
         )
-        return False
+        return True
 
     return is_zarr(path)