Coverage for src/bioimageio/spec/dataset/v0_2.py: 100%

1from __future__ import annotations 

2 

3from typing import TYPE_CHECKING, ClassVar, Literal 

4 

5from .._internal.common_nodes import Node 

6from .._internal.url import HttpUrl as HttpUrl 

7from ..generic.v0_2 import VALID_COVER_IMAGE_EXTENSIONS as VALID_COVER_IMAGE_EXTENSIONS 

8from ..generic.v0_2 import AttachmentsDescr as AttachmentsDescr 

9from ..generic.v0_2 import Author as Author 

10from ..generic.v0_2 import BadgeDescr as BadgeDescr 

11from ..generic.v0_2 import CiteEntry as CiteEntry 

12from ..generic.v0_2 import Doi as Doi 

13from ..generic.v0_2 import GenericDescrBase, ResourceId 

14from ..generic.v0_2 import LinkedResource as LinkedResource 

15from ..generic.v0_2 import Maintainer as Maintainer 

16from ..generic.v0_2 import OrcidId as OrcidId 

17from ..generic.v0_2 import RelativeFilePath as RelativeFilePath 

18from ..generic.v0_2 import Uploader as Uploader 

19from ..generic.v0_2 import Version as Version 

20 

21 

22class DatasetId(ResourceId): 

23 pass 

24 

25 

26class DatasetDescr(GenericDescrBase): 

27 """A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage 

28 processing. 

29 """ 

30 

31 implemented_type: ClassVar[Literal["dataset"]] = "dataset" 

32 if TYPE_CHECKING: 

33 type: Literal["dataset"] = "dataset" 

34 else: 

35 type: Literal["dataset"] 

36 

37 id: DatasetId | None = None 

38 """bioimage.io-wide unique resource identifier 

39 assigned by bioimage.io; version **un**specific.""" 

40 

41 source: HttpUrl | None = None 

42 """"URL to the source of the dataset.""" 

43 

44 

45class LinkedDataset(Node): 

46 """Reference to a bioimage.io dataset.""" 

47 

48 id: DatasetId 

49 """A valid dataset `id` from the bioimage.io collection.""" 

50 

51 version_number: int | None = None 

52 """version number (n-th published version, not the semantic version) of linked dataset"""