File: format.pyi

package info (click to toggle)
python-imageio 2.37.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,016 kB
  • sloc: python: 26,044; makefile: 138
file content (87 lines) | stat: -rw-r--r-- 3,336 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
from typing import Any, Dict, List, Optional, Union

import numpy as np

from ..typing import ArrayLike
from . import Array
from .request import Request
from ..config import PluginConfig

def _get_config(plugin: str) -> PluginConfig: ...

class Format(object):
    @property
    def doc(self) -> str: ...
    @property
    def name(self) -> str: ...
    @property
    def description(self) -> str: ...
    @property
    def extensions(self) -> List[str]: ...
    @property
    def modes(self) -> str: ...
    def __init__(
        self,
        name: str,
        description: str,
        extensions: Union[str, list, tuple, None] = None,
        modes: str = None,
    ) -> None: ...
    def __repr__(self) -> str: ...
    def __str__(self) -> str: ...
    def get_reader(self, request: Request) -> Reader: ...
    def get_writer(self, request: Request) -> Writer: ...
    def can_read(self, request: Request) -> bool: ...
    def can_write(self, request: Request) -> bool: ...
    def _can_read(self, request: Request) -> bool: ...
    def _can_write(self, request: Request) -> bool: ...

    class _BaseReaderWriter(object):
        @property
        def format(self) -> Format: ...
        @property
        def request(self) -> Request: ...
        @property
        def closed(self) -> bool: ...
        def __init__(self, format: Format, request: Request) -> None: ...
        def __enter__(self) -> Format._BaseReaderWriter: ...
        def __exit__(self, type, value, traceback) -> None: ...
        def __del__(self) -> None: ...
        def close(self) -> None: ...
        def _checkClosed(self, msg=None) -> None: ...
        def _open(self, **kwargs) -> None: ...
        def _close(self) -> None: ...

    class Reader(_BaseReaderWriter):
        def get_length(self) -> int: ...
        def get_data(self, index: int, **kwargs) -> Array: ...
        def get_next_data(self, **kwargs) -> Dict[str, Any]: ...
        def set_image_index(self, index: int, **kwargs) -> None: ...
        def get_meta_data(self, index: int = None) -> Dict[str, Any]: ...
        def iter_data(self) -> Array: ...
        def __iter__(self) -> Array: ...
        def __len__(self) -> int: ...
        def _get_length(self) -> int: ...
        def _get_data(self, index: int) -> Array: ...
        def _get_meta_data(self, index: int) -> Dict[str, Any]: ...

    class Writer(_BaseReaderWriter):
        def append_data(self, im: ArrayLike, meta: Dict[str, Any] = None) -> None: ...
        def set_meta_data(self, meta: Dict[str, Any]) -> None: ...
        def _append_data(self, im: ArrayLike, meta: Dict[str, Any]) -> None: ...
        def _set_meta_data(self, meta: Dict[str, Any]) -> None: ...

class FormatManager(object):
    @property
    def _formats(self) -> List[Format]: ...
    def __repr__(self) -> str: ...
    def __iter__(self) -> Format: ...
    def __len__(self) -> int: ...
    def __str__(self) -> str: ...
    def __getitem__(self, name: str) -> Format: ...
    def sort(self, *names: str) -> None: ...
    def add_format(self, iio_format: Format, overwrite: bool = False) -> None: ...
    def search_read_format(self, request: Request) -> Optional[Format]: ...
    def search_write_format(self, request: Request) -> Optional[Format]: ...
    def get_format_names(self) -> List[str]: ...
    def show(self) -> None: ...