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 AbsoluteFilePath as AbsoluteFilePath 

5from .._internal.io_basics import Sha256 as Sha256 

6from .._internal.url import HttpUrl as HttpUrl 

7from ..generic.v0_3 import VALID_COVER_IMAGE_EXTENSIONS as VALID_COVER_IMAGE_EXTENSIONS 

8from ..generic.v0_3 import Author as Author 

9from ..generic.v0_3 import BadgeDescr as BadgeDescr 

10from ..generic.v0_3 import BioimageioConfig as BioimageioConfig 

11from ..generic.v0_3 import CiteEntry as CiteEntry 

12from ..generic.v0_3 import Config as Config 

13from ..generic.v0_3 import DeprecatedLicenseId as DeprecatedLicenseId 

14from ..generic.v0_3 import Doi as Doi 

15from ..generic.v0_3 import GenericDescrBase, LinkedResourceBase 

16from ..generic.v0_3 import LicenseId as LicenseId 

17from ..generic.v0_3 import LinkedResource as LinkedResource 

18from ..generic.v0_3 import Maintainer as Maintainer 

19from ..generic.v0_3 import OrcidId as OrcidId 

20from ..generic.v0_3 import RelativeFilePath as RelativeFilePath 

21from ..generic.v0_3 import ResourceId as ResourceId 

22from ..generic.v0_3 import Uploader as Uploader 

23from ..generic.v0_3 import Version as Version 

24from .v0_2 import NotebookSource as NotebookSource 

25 

26 

27class NotebookId(ResourceId): 

28 pass 

29 

30 

31class NotebookDescr(GenericDescrBase): 

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

33 

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

35 if TYPE_CHECKING: 

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

37 else: 

38 type: Literal["notebook"] 

39 

40 id: Optional[NotebookId] = None 

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

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

43 

44 parent: Optional[NotebookId] = None 

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

46 

47 source: NotebookSource 

48 """The Jupyter notebook""" 

49 

50 

51class LinkedNotebook(LinkedResourceBase): 

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

53 

54 id: NotebookId 

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