Coverage for src/bioimageio/spec/__init__.py: 100%

1"""bioimageio.spec --- BioImage.IO specifications in Python. 

2 

3This package provides Pydantic data models for BioImage.IO resource descriptions and tools to work with such descriptions. 

4 

5The BioImage.IO resource description format is resource type specific (e.g. models, datasets) and versioned. 

6bioimageio.spec defines and validates these specifications and is backwards compatible with previous format versions. 

7It also provides download/upload to/from the BioImage.IO Model Zoo at https://bioimage.io. 

8 

9Note: 

10 For additional tools to work with BioImage.IO resources in Python, consider using the [bioimageio.core](https://bioimage-io.github.io/core-bioimage-io-python) package. 

11""" 

12 

13# ruff: noqa: E402 

14from loguru import logger 

15from typing_extensions import TypeAlias 

16 

17logger.disable("bioimageio.spec") 

18 

19from . import _version 

20from . import application as application 

21from . import common as common 

22from . import conda_env as conda_env 

23from . import dataset as dataset 

24from . import generic as generic 

25from . import model as model 

26from . import notebook as notebook 

27from . import summary as summary 

28from . import utils as utils 

29from ._description import LatestResourceDescr as LatestResourceDescr 

30from ._description import ResourceDescr as ResourceDescr 

31from ._description import SpecificResourceDescr as SpecificResourceDescr 

32from ._description import build_description as build_description 

33from ._description import dump_description as dump_description 

34from ._description import validate_format as validate_format 

35from ._get_conda_env import get_conda_env as get_conda_env 

36from ._internal import common_nodes, validation_context 

37from ._internal import settings as settings 

38from ._io import load_dataset_description as load_dataset_description 

39from ._io import load_description as load_description 

40from ._io import ( 

41 load_description_and_validate_format_only as load_description_and_validate_format_only, 

42) 

43from ._io import load_model_description as load_model_description 

44from ._io import save_bioimageio_yaml_only as save_bioimageio_yaml_only 

45from ._package import get_package_content as get_package_content 

46from ._package import get_resource_package_content as get_resource_package_content 

47from ._package import save_bioimageio_package as save_bioimageio_package 

48from ._package import ( 

49 save_bioimageio_package_as_folder as save_bioimageio_package_as_folder, 

50) 

51from ._package import ( 

52 save_bioimageio_package_to_stream as save_bioimageio_package_to_stream, 

53) 

54from ._pretty_validation_errors import ( 

55 PRETTY_VALIDATION_ERRORS_IN_IPYNB_ENABLED as PRETTY_VALIDATION_ERRORS_IN_IPYNB_ENABLED, 

56) 

57from ._update import update_format as update_format 

58from ._update import update_hashes as update_hashes 

59from ._upload import upload as upload 

60 

61__version__ = _version.VERSION 

62 

63# reexpose slected objects from submodules 

64AnyApplicationDescr: TypeAlias = application.AnyApplicationDescr 

65AnyDatasetDescr: TypeAlias = dataset.AnyDatasetDescr 

66AnyGenericDescr: TypeAlias = generic.AnyGenericDescr 

67AnyModelDescr: TypeAlias = model.AnyModelDescr 

68AnyNotebookDescr: TypeAlias = notebook.AnyNotebookDescr 

69ApplicationDescr = application.ApplicationDescr 

70BioimageioCondaEnv = conda_env.BioimageioCondaEnv 

71DatasetDescr = dataset.DatasetDescr 

72GenericDescr = generic.GenericDescr 

73get_validation_context = validation_context.get_validation_context 

74InvalidDescr = common_nodes.InvalidDescr 

75ModelDescr = model.ModelDescr 

76NotebookDescr = notebook.NotebookDescr 

77ValidationContext = validation_context.ValidationContext 

78ValidationSummary = summary.ValidationSummary