|
| 1 | + |
| 2 | +from typing import Optional, Union, Text, AnyStr, Callable, IO, Any, Iterator, List, Tuple, TypeVar, Protocol, Dict, Sequence, Iterable, Generic, Type, Mapping, overload |
| 3 | +from types import TracebackType |
| 4 | +import sys |
| 5 | +import email |
| 6 | + |
| 7 | +if sys.version_info >= (3, 8): |
| 8 | + from typing import Literal |
| 9 | +else: |
| 10 | + from typing_extensions import Literal |
| 11 | + |
| 12 | +if sys.version_info >= (3, 6): |
| 13 | + from builtins import _PathLike |
| 14 | + _PathType = Union[bytes, Text, _PathLike] |
| 15 | +else: |
| 16 | + _PathType = Union[bytes, Text] |
| 17 | + |
| 18 | +_T = TypeVar("_T") |
| 19 | +_MessageType = TypeVar("_MessageType", bound=Message) |
| 20 | +_MessageData = Union[email.message.Message, bytes, str, IO[str], IO[bytes]] |
| 21 | + |
| 22 | +class HasIteritems(Protocol): |
| 23 | + def iteritems(self) -> Iterator[Tuple[str, Message]]: ... |
| 24 | + |
| 25 | +class HasItems(Protocol): |
| 26 | + def items(self) -> Iterator[Tuple[str, Message]]: ... |
| 27 | + |
| 28 | +linesep: bytes |
| 29 | + |
| 30 | +class Mailbox(Generic[_MessageType]): |
| 31 | + |
| 32 | + _path: Union[bytes, str] # undocumented |
| 33 | + _factory: Optional[Callable[[IO[Any]], _MessageType]] # undocumented |
| 34 | + |
| 35 | + def __init__(self, path: _PathType, factory: Optional[Callable[[IO[Any]], _MessageType]] = ..., create: bool = ...) -> None: ... |
| 36 | + def add(self, message: _MessageType) -> str: ... |
| 37 | + def remove(self, key: str) -> None: ... |
| 38 | + def __delitem__(self, key: str) -> None: ... |
| 39 | + def discard(self, key: str) -> None: ... |
| 40 | + def __setitem__(self, key: str, message: _MessageType) -> None: ... |
| 41 | + @overload |
| 42 | + def get(self, key: str, default: None = ...) -> Optional[_MessageType]: ... |
| 43 | + @overload |
| 44 | + def get(self, key: str, default: _T) -> Union[_MessageType, _T]: ... |
| 45 | + def __getitem__(self, key: str) -> _MessageType: ... |
| 46 | + def get_message(self, key: str) -> _MessageType: ... |
| 47 | + def get_string(self, key: str) -> str: ... |
| 48 | + def get_bytes(self, key: str) -> bytes: ... |
| 49 | + # As '_ProxyFile' doesn't implement the full IO spec, and BytesIO is incompatible with it, get_file return is Any here |
| 50 | + def get_file(self, key: str) -> Any: ... |
| 51 | + def iterkeys(self) -> Iterator[str]: ... |
| 52 | + def keys(self) -> List[str]: ... |
| 53 | + def itervalues(self) -> Iterator[_MessageType]: ... |
| 54 | + def __iter__(self) -> Iterator[_MessageType]: ... |
| 55 | + def values(self) -> List[_MessageType]: ... |
| 56 | + def iteritems(self) -> Iterator[Tuple[str, _MessageType]]: ... |
| 57 | + def items(self) -> List[Tuple[str, _MessageType]]: ... |
| 58 | + def __contains__(self, key: str) -> bool: ... |
| 59 | + def __len__(self) -> int: ... |
| 60 | + def clear(self) -> None: ... |
| 61 | + @overload |
| 62 | + def pop(self, key: str, default: None = ...) -> Optional[_MessageType]: ... |
| 63 | + @overload |
| 64 | + def pop(self, key: str, default: _T = ...) -> Union[_MessageType, _T]: ... |
| 65 | + def popitem(self) -> Tuple[str, _MessageType]: ... |
| 66 | + def update(self, arg: Optional[Union[HasIteritems, HasItems, Iterable[Tuple[str, _MessageType]]]] = ...) -> None: ... |
| 67 | + def flush(self) -> None: ... |
| 68 | + def lock(self) -> None: ... |
| 69 | + def unlock(self) -> None: ... |
| 70 | + def close(self) -> None: ... |
| 71 | + |
| 72 | +class Maildir(Mailbox[MaildirMessage]): |
| 73 | + |
| 74 | + colon: str |
| 75 | + |
| 76 | + def __init__(self, dirname: _PathType, factory: Optional[Callable[[IO[Any]], MaildirMessage]] = ..., create: bool = ...) -> None: ... |
| 77 | + def get_file(self, key: str) -> _ProxyFile[bytes]: ... |
| 78 | + |
| 79 | + def list_folders(self) -> List[str]: ... |
| 80 | + def get_folder(self, folder: Text) -> Maildir: ... |
| 81 | + def add_folder(self, folder: Text) -> Maildir: ... |
| 82 | + def remove_folder(self, folder: Text) -> None: ... |
| 83 | + def clean(self) -> None: ... |
| 84 | + def next(self) -> Optional[str]: ... |
| 85 | + |
| 86 | +class _singlefileMailbox(Mailbox[_MessageType]): ... |
| 87 | + |
| 88 | +class _mboxMMDF(_singlefileMailbox[_MessageType]): |
| 89 | + |
| 90 | + def get_file(self, key: str) -> _PartialFile[bytes]: ... |
| 91 | + |
| 92 | +class mbox(_mboxMMDF[mboxMessage]): |
| 93 | + |
| 94 | + def __init__(self, dirname: _PathType, factory: Optional[Callable[[IO[Any]], mboxMessage]] = ..., create: bool = ...) -> None: ... |
| 95 | + |
| 96 | +class MMDF(_mboxMMDF[MMDFMessage]): |
| 97 | + |
| 98 | + def __init__(self, dirname: _PathType, factory: Optional[Callable[[IO[Any]], MMDFMessage]] = ..., create: bool = ...) -> None: ... |
| 99 | + |
| 100 | +class MH(Mailbox[MHMessage]): |
| 101 | + |
| 102 | + def __init__(self, dirname: _PathType, factory: Optional[Callable[[IO[Any]], MHMessage]] = ..., create: bool = ...) -> None: ... |
| 103 | + def get_file(self, key: str) -> _ProxyFile[bytes]: ... |
| 104 | + |
| 105 | + def list_folders(self) -> List[str]: ... |
| 106 | + def get_folder(self, folder: _PathType) -> MH: ... |
| 107 | + def add_folder(self, folder: _PathType) -> MH: ... |
| 108 | + def remove_folder(self, folder: _PathType) -> None: ... |
| 109 | + def get_sequences(self) -> Dict[str, List[int]]: ... |
| 110 | + def set_sequences(self, sequences: Mapping[str, Sequence[int]]) -> None: ... |
| 111 | + def pack(self) -> None: ... |
| 112 | + |
| 113 | +class Babyl(_singlefileMailbox[BabylMessage]): |
| 114 | + |
| 115 | + def __init__(self, dirname: _PathType, factory: Optional[Callable[[IO[Any]], BabylMessage]] = ..., create: bool = ...) -> None: ... |
| 116 | + |
| 117 | + def get_file(self, key: str) -> IO[bytes]: ... |
| 118 | + def get_labels(self) -> List[str]: ... |
| 119 | + |
| 120 | +class Message(email.message.Message): |
| 121 | + |
| 122 | + def __init__(self, message: Optional[_MessageData] = ...) -> None: ... |
| 123 | + |
| 124 | +class MaildirMessage(Message): |
| 125 | + |
| 126 | + def get_subdir(self) -> str: ... |
| 127 | + def set_subdir(self, subdir: Literal["new", "cur"]) -> None: ... |
| 128 | + def get_flags(self) -> str: ... |
| 129 | + def set_flags(self, flags: Iterable[str]) -> None: ... |
| 130 | + def add_flag(self, flag: str) -> None: ... |
| 131 | + def remove_flag(self, flag: str) -> None: ... |
| 132 | + def get_date(self) -> int: ... |
| 133 | + def set_date(self, date: int) -> None: ... |
| 134 | + def get_info(self) -> str: ... |
| 135 | + def set_info(self, info: str) -> None: ... |
| 136 | + |
| 137 | +class _mboxMMDFMessage(Message): |
| 138 | + |
| 139 | + def get_from(self) -> str: ... |
| 140 | + def set_from(self, from_: str, time_: Optional[Union[bool, Tuple[int, int, int, int, int, int, int, int, int]]] = ...) -> None: ... |
| 141 | + def get_flags(self) -> str: ... |
| 142 | + def set_flags(self, flags: Iterable[str]) -> None: ... |
| 143 | + def add_flag(self, flag: str) -> None: ... |
| 144 | + def remove_flag(self, flag: str) -> None: ... |
| 145 | + |
| 146 | +class mboxMessage(_mboxMMDFMessage): ... |
| 147 | + |
| 148 | +class MHMessage(Message): |
| 149 | + |
| 150 | + def get_sequences(self) -> List[str]: ... |
| 151 | + def set_sequences(self, sequences: Iterable[str]) -> None: ... |
| 152 | + def add_sequence(self, sequence: str) -> None: ... |
| 153 | + def remove_sequence(self, sequence: str) -> None: ... |
| 154 | + |
| 155 | +class BabylMessage(Message): |
| 156 | + |
| 157 | + def get_labels(self) -> List[str]: ... |
| 158 | + def set_labels(self, labels: Iterable[str]) -> None: ... |
| 159 | + def add_label(self, label: str) -> None: ... |
| 160 | + def remove_label(self, label: str) -> None: ... |
| 161 | + def get_visible(self) -> Message: ... |
| 162 | + def set_visible(self, visible: _MessageData) -> None: ... |
| 163 | + def update_visible(self) -> None: ... |
| 164 | + |
| 165 | +class MMDFMessage(_mboxMMDFMessage): ... |
| 166 | + |
| 167 | +class _ProxyFile(Generic[AnyStr]): |
| 168 | + |
| 169 | + def __init__(self, f: IO[AnyStr], pos: Optional[int] = ...) -> None: ... |
| 170 | + def read(self, size: Optional[int] = ...) -> AnyStr: ... |
| 171 | + def read1(self, size: Optional[int] = ...) -> AnyStr: ... |
| 172 | + def readline(self, size: Optional[int] = ...) -> AnyStr: ... |
| 173 | + def readlines(self, sizehint: Optional[int] = ...) -> List[AnyStr]: ... |
| 174 | + def __iter__(self) -> Iterator[AnyStr]: ... |
| 175 | + def tell(self) -> int: ... |
| 176 | + def seek(self, offset: int, whence: int = ...) -> None: ... |
| 177 | + def close(self) -> None: ... |
| 178 | + def __enter__(self) -> _ProxyFile[AnyStr]: ... |
| 179 | + def __exit__(self, exc_type: Optional[Type[BaseException]], exc: Optional[BaseException], tb: Optional[TracebackType]) -> None: ... |
| 180 | + def readable(self) -> bool: ... |
| 181 | + def writable(self) -> bool: ... |
| 182 | + def seekable(self) -> bool: ... |
| 183 | + def flush(self) -> None: ... |
| 184 | + @property |
| 185 | + def closed(self) -> bool: ... |
| 186 | + |
| 187 | +class _PartialFile(_ProxyFile[AnyStr]): |
| 188 | + |
| 189 | + def __init__(self, f: IO[AnyStr], start: Optional[int] = ..., stop: Optional[int] = ...) -> None: ... |
| 190 | + |
| 191 | +class Error(Exception): ... |
| 192 | + |
| 193 | +class NoSuchMailboxError(Error): ... |
| 194 | + |
| 195 | +class NotEmptyError(Error): ... |
| 196 | + |
| 197 | +class ExternalClashError(Error): ... |
| 198 | + |
| 199 | +class FormatError(Error): ... |
0 commit comments