Merge pull request #508 from bioimage-io/add_get_resolved_source_path

add get_resolved_source_path

Author: FynnBe

bioimageio/spec/shared/__init__.py

@@ -8,9 +8,10 @@
     BIOIMAGEIO_COLLECTION_ERROR,
     BIOIMAGEIO_SITE_CONFIG,
     BIOIMAGEIO_SITE_CONFIG_ERROR,
-    RDF_NAMES,
     DownloadCancelled,
+    RDF_NAMES,
     _resolve_json_from_url,
+    get_resolved_source_path,
     resolve_local_source,
     resolve_rdf_source,
     resolve_rdf_source_and_type,

bioimageio/spec/shared/_resolve_source.py

@@ -332,6 +332,22 @@ def _resolve_source_list(
     ]
 
 
+def get_resolved_source_path(
+    source: typing.Union[
+        raw_nodes.URI, str, pathlib.Path, raw_nodes.ResolvedImportableSourceFile, raw_nodes.ImportableSourceFile
+    ],
+    root_path: typing.Union[os.PathLike, URI],
+    pbar=None,
+) -> pathlib.Path:
+    resolved = resolve_source(source, root_path=root_path, pbar=pbar)
+    if isinstance(resolved, os.PathLike):
+        return pathlib.Path(resolved)
+    elif isinstance(resolved, raw_nodes.ResolvedImportableSourceFile):
+        return resolved.source_file
+    else:
+        raise NotImplementedError(type(resolved))
+
+
 def resolve_local_sources(
     sources: typing.Sequence[typing.Union[str, os.PathLike, raw_nodes.URI]],
     root_path: os.PathLike,

tests/test_shared/test_resolve_source.py

@@ -0,0 +1,32 @@
+import os
+from pathlib import Path
+from typing import Optional
+
+import pytest
+
+from bioimageio.spec.shared.raw_nodes import URI
+
+
+def mock_download(uri: URI, output: Optional[os.PathLike] = None, pbar=None):
+    return Path(__file__).resolve()
+
+
+@pytest.mark.parametrize(
+    "src",
+    [
+        "https://example.com/fake",
+        Path(__file__),
+        __file__,
+        URI("https://example.com/fake"),
+    ],
+)
+def test_get_resolved_source_path(src):
+    from bioimageio.spec.shared import get_resolved_source_path
+
+    import bioimageio.spec
+
+    bioimageio.spec.shared._resolve_source._download_url = mock_download
+    res = get_resolved_source_path(src, root_path=Path(__file__).parent)
+    assert isinstance(res, Path)
+    assert res.exists()
+    assert res == Path(__file__).resolve()