Coverage for bioimageio/spec/notebook/v0_3.py: 100%

1from typing import TYPE_CHECKING, ClassVar, Literal, Optional 

2 

3from .._internal.io import FileDescr as FileDescr 

4from .._internal.io_basics import Sha256 as Sha256 

5from .._internal.url import HttpUrl as HttpUrl 

6from ..generic.v0_3 import VALID_COVER_IMAGE_EXTENSIONS as VALID_COVER_IMAGE_EXTENSIONS 

7from ..generic.v0_3 import Author as Author 

8from ..generic.v0_3 import BadgeDescr as BadgeDescr 

9from ..generic.v0_3 import BioimageioConfig as BioimageioConfig 

10from ..generic.v0_3 import CiteEntry as CiteEntry 

11from ..generic.v0_3 import Config as Config 

12from ..generic.v0_3 import DeprecatedLicenseId as DeprecatedLicenseId 

13from ..generic.v0_3 import Doi as Doi 

14from ..generic.v0_3 import GenericDescrBase, LinkedResourceBase 

15from ..generic.v0_3 import LicenseId as LicenseId 

16from ..generic.v0_3 import LinkedResource as LinkedResource 

17from ..generic.v0_3 import Maintainer as Maintainer 

18from ..generic.v0_3 import OrcidId as OrcidId 

19from ..generic.v0_3 import RelativeFilePath as RelativeFilePath 

20from ..generic.v0_3 import ResourceId as ResourceId 

21from ..generic.v0_3 import Uploader as Uploader 

22from ..generic.v0_3 import Version as Version 

23from .v0_2 import NotebookSource as NotebookSource 

24 

25 

26class NotebookId(ResourceId): 

27 pass 

28 

29 

30class NotebookDescr(GenericDescrBase): 

31 """Bioimage.io description of a Jupyter notebook.""" 

32 

33 implemented_type: ClassVar[Literal["notebook"]] = "notebook" 

34 if TYPE_CHECKING: 

35 type: Literal["notebook"] = "notebook" 

36 else: 

37 type: Literal["notebook"] 

38 

39 id: Optional[NotebookId] = None 

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

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

42 

43 parent: Optional[NotebookId] = None 

44 """The description from which this one is derived""" 

45 

46 source: NotebookSource 

47 """The Jupyter notebook""" 

48 

49 

50class LinkedNotebook(LinkedResourceBase): 

51 """Reference to a bioimage.io notebook.""" 

52 

53 id: NotebookId 

54 """A valid notebook `id` from the bioimage.io collection."""