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

1from typing import TYPE_CHECKING, ClassVar, Literal, Optional 

2 

3from .._internal.common_nodes import Node 

4from .._internal.io_basics import AbsoluteFilePath as AbsoluteFilePath 

5from .._internal.url import HttpUrl as HttpUrl 

6from ..generic.v0_2 import VALID_COVER_IMAGE_EXTENSIONS as VALID_COVER_IMAGE_EXTENSIONS 

7from ..generic.v0_2 import AttachmentsDescr as AttachmentsDescr 

8from ..generic.v0_2 import Author as Author 

9from ..generic.v0_2 import BadgeDescr as BadgeDescr 

10from ..generic.v0_2 import CiteEntry as CiteEntry 

11from ..generic.v0_2 import Doi as Doi 

12from ..generic.v0_2 import GenericDescrBase, ResourceId 

13from ..generic.v0_2 import LinkedResource as LinkedResource 

14from ..generic.v0_2 import Maintainer as Maintainer 

15from ..generic.v0_2 import OrcidId as OrcidId 

16from ..generic.v0_2 import RelativeFilePath as RelativeFilePath 

17from ..generic.v0_2 import Uploader as Uploader 

18from ..generic.v0_2 import Version as Version 

19 

20 

21class DatasetId(ResourceId): 

22 pass 

23 

24 

25class DatasetDescr(GenericDescrBase): 

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

27 processing. 

28 """ 

29 

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

31 if TYPE_CHECKING: 

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

33 else: 

34 type: Literal["dataset"] 

35 

36 id: Optional[DatasetId] = None 

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

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

39 

40 source: Optional[HttpUrl] = None 

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

42 

43 

44class LinkedDataset(Node): 

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

46 

47 id: DatasetId 

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

49 

50 version_number: Optional[int] = None 

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