v2.pyi 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. # -*- coding: utf-8 -*-
  2. # imageio is distributed under the terms of the (new) BSD License.
  3. from typing import Dict, Literal, Union, List, overload
  4. import numpy as np
  5. from .core.imopen import imopen
  6. from .core import RETURN_BYTES, Array
  7. from .typing import ImageResource, ArrayLike
  8. from .core.format import Format
  9. MEMTEST_DEFAULT_MIM = "256MB"
  10. MEMTEST_DEFAULT_MVOL = "1GB"
  11. def to_nbytes(arg: float = None, default=None) -> float: ...
  12. def help(name=None) -> None: ...
  13. def decypher_format_arg(format_name: Union[str, None]) -> Dict[str, str]: ...
  14. def get_reader(
  15. uri: ImageResource, format: Format = None, mode: str = "?", **kwargs
  16. ) -> Format.Reader: ...
  17. def get_writer(
  18. uri: ImageResource, format: Format = None, mode: str = "?", **kwargs
  19. ) -> Format.Writer: ...
  20. def imread(uri: ImageResource, format: Format = None, **kwargs) -> Array: ...
  21. @overload
  22. def imwrite(
  23. uri: Literal["<bytes>"], im: ArrayLike, format: Format = None, **kwargs
  24. ) -> bytes: ...
  25. @overload
  26. def imwrite(
  27. uri: ImageResource, im: ArrayLike, format: Format = None, **kwargs
  28. ) -> None: ...
  29. def mimread(
  30. uri: ImageResource, format: Format = None, memtest=MEMTEST_DEFAULT_MIM, **kwargs
  31. ) -> List[Array]: ...
  32. @overload
  33. def mimwrite(
  34. uri: Literal["<bytes>"], ims: List[ArrayLike], format: Format = None, **kwargs
  35. ) -> bytes: ...
  36. @overload
  37. def mimwrite(
  38. uri: ImageResource, ims: List[ArrayLike], format: Format = None, **kwargs
  39. ) -> None: ...
  40. def volread(uri: ImageResource, format: Format = None, **kwargs) -> Array: ...
  41. @overload
  42. def volwrite(
  43. uri: Literal["<bytes>"], im: ArrayLike, format: Format = None, **kwargs
  44. ) -> bytes: ...
  45. @overload
  46. def volwrite(
  47. uri: ImageResource, im: ArrayLike, format: Format = None, **kwargs
  48. ) -> None: ...
  49. def mvolread(
  50. uri: ImageResource,
  51. format: Format = None,
  52. memtest: float = MEMTEST_DEFAULT_MVOL,
  53. **kwargs,
  54. ) -> List[Array]: ...
  55. @overload
  56. def mvolwrite(
  57. uri: Literal["<bytes>"], ims: List[ArrayLike], format: Format = None, **kwargs
  58. ) -> bytes: ...
  59. @overload
  60. def mvolwrite(
  61. uri: ImageResource, ims: List[ArrayLike], format: Format = None, **kwargs
  62. ) -> None: ...
  63. # aliases
  64. read = get_reader
  65. save = get_writer
  66. imsave = imwrite
  67. mimsave = mimwrite
  68. volsave = volwrite
  69. mvolsave = mvolwrite