allow absolute file paths

Author: FynnBe

bioimageio/spec/_internal/types/__init__.py

@@ -8,10 +8,10 @@
 from typing_extensions import Annotated
 
 from bioimageio.spec._internal.constants import DOI_REGEX, SI_UNIT_REGEX
+from bioimageio.spec._internal.types._file_source import FileSource as FileSource
+from bioimageio.spec._internal.types._file_source import RelativeFilePath as RelativeFilePath
 from bioimageio.spec._internal.types._generated_spdx_license_type import DeprecatedLicenseId as DeprecatedLicenseId
 from bioimageio.spec._internal.types._generated_spdx_license_type import LicenseId as LicenseId
-from bioimageio.spec._internal.types._relative_path import FileSource as FileSource
-from bioimageio.spec._internal.types._relative_path import RelativeFilePath as RelativeFilePath
 from bioimageio.spec._internal.types._version import Version as Version
 from bioimageio.spec._internal.types.field_validation import (
     AfterValidator,

bioimageio/spec/_internal/types/_relative_path.py renamed to bioimageio/spec/_internal/types/_file_source.py

@@ -5,22 +5,34 @@
 from typing import Any, Union
 from urllib.parse import urljoin
 
-from pydantic import AnyUrl, DirectoryPath, FilePath, GetCoreSchemaHandler, HttpUrl, ValidationInfo
+from annotated_types import Predicate
+from pydantic import (
+    AnyUrl,
+    DirectoryPath,
+    FilePath,
+    GetCoreSchemaHandler,
+    HttpUrl,
+    ValidationInfo,
+)
 from pydantic_core import core_schema
+from typing_extensions import Annotated
 
 
 class RelativePath:
     path: PurePosixPath
 
     def __init__(self, path: Union[str, Path, RelativePath]) -> None:
         super().__init__()
-        self.path = (
-            path.path
-            if isinstance(path, RelativePath)
-            else PurePosixPath(path.as_posix())
-            if isinstance(path, Path)
-            else PurePosixPath(Path(path).as_posix())
-        )
+        if isinstance(path, RelativePath):
+            self.path = path.path
+        else:
+            if not isinstance(path, Path):
+                path = Path(path)
+
+            if path.is_absolute():
+                raise ValueError(f"{path} is an absolute path.")
+
+            self.path = PurePosixPath(path.as_posix())
 
     @property
     def __members(self):
@@ -68,6 +80,9 @@ def _validate(cls, value: Union[pathlib.Path, str], info: ValidationInfo):
             raise ValueError(f"{value} looks like a URL, not a relative path")
 
         ret = cls(value)
+        if ret.path.is_absolute():
+            raise ValueError(f"{value} is an absolute path.")
+
         root = (info.context or {}).get("root")
         if root is not None:
             ret._check_exists(root)
@@ -87,4 +102,6 @@ def _check_exists(self, root: Union[DirectoryPath, AnyUrl]) -> None:
             raise ValueError(f"{p} does not point to an existing directory")
 
 
-FileSource = Union[HttpUrl, RelativeFilePath]  # todo: move to types/__init__
+AbsoluteFilePath = Annotated[FilePath, Predicate(Path.is_absolute)]
+
+FileSource = Union[HttpUrl, AbsoluteFilePath, RelativeFilePath]

bioimageio/spec/_internal/types/field_validation.py

@@ -15,7 +15,7 @@
 
 from bioimageio.spec._internal.constants import SLOTS
 
-from ._relative_path import FileSource, RelativePath
+from ._file_source import FileSource, RelativePath
 
 
 @dataclasses.dataclass(frozen=True, **SLOTS)

tests/test_shared/test_types.py

@@ -5,17 +5,27 @@
 import pytest
 
 from bioimageio.spec._internal.types import Datetime, SiUnit
-from bioimageio.spec._internal.types.field_validation import RelativePath
+from bioimageio.spec._internal.types._file_source import RelativePath
 from tests.utils import check_type
 
 
-def test_relative_path():
-    p = RelativePath(__file__)
-    p2 = RelativePath(Path(__file__))
+@pytest.mark.parametrize("path", ["a.test", "there/b", "./here/or/there/c"])
+def test_relative_path(path: str):
+    p = RelativePath(path)
+    p2 = RelativePath(Path(path))
     assert p == p2
-    p3 = RelativePath(Path(__file__).as_posix())
+    p3 = RelativePath(Path(path).as_posix())
     assert p == p3
 
+    with pytest.raises(ValueError):
+        _ = RelativePath(Path(path).absolute())
+
+    with pytest.raises(ValueError):
+        _ = RelativePath(str(Path(path).absolute()))
+
+    with pytest.raises(ValueError):
+        _ = RelativePath(Path(path).absolute().as_posix())
+
 
 @pytest.mark.parametrize("value", ["lx·s", "kg/m^2·s^-2"])
 def test_si_unit(value: str):