Skip to content

mailbox: improve bytes handling #9083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 8, 2022
Merged

mailbox: improve bytes handling #9083

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9eb4a07
mailbox: improve bytes handling
JelleZijlstra Nov 4, 2022
2bb31fd
Update stdlib/mailbox.pyi
JelleZijlstra Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 17 additions & 22 deletions stdlib/mailbox.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import email.message
import io
import sys
from _typeshed import Self, StrOrBytesPath
from _typeshed import Self, StrPath, SupportsNoArgReadline, SupportsRead
from abc import ABCMeta, abstractmethod
from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence
from types import TracebackType
Expand Down Expand Up @@ -32,7 +33,10 @@ __all__ = [

_T = TypeVar("_T")
_MessageT = TypeVar("_MessageT", bound=Message)
_MessageData: TypeAlias = email.message.Message | bytes | str | IO[str] | IO[bytes]

class _SupportsReadAndReadline(SupportsRead[bytes], SupportsNoArgReadline[bytes], Protocol): ...

_MessageData: TypeAlias = email.message.Message | bytes | str | io.StringIO | _SupportsReadAndReadline

class _HasIteritems(Protocol):
def iteritems(self) -> Iterator[tuple[str, _MessageData]]: ...
Expand All @@ -43,13 +47,12 @@ class _HasItems(Protocol):
linesep: bytes

class Mailbox(Generic[_MessageT]):

_path: bytes | str # undocumented
_path: str # undocumented
_factory: Callable[[IO[Any]], _MessageT] | None # undocumented
@overload
def __init__(self, path: StrOrBytesPath, factory: Callable[[IO[Any]], _MessageT], create: bool = ...) -> None: ...
def __init__(self, path: StrPath, factory: Callable[[IO[Any]], _MessageT], create: bool = ...) -> None: ...
@overload
def __init__(self, path: StrOrBytesPath, factory: None = ..., create: bool = ...) -> None: ...
def __init__(self, path: StrPath, factory: None = ..., create: bool = ...) -> None: ...
@abstractmethod
def add(self, message: _MessageData) -> str: ...
@abstractmethod
Expand Down Expand Up @@ -105,7 +108,7 @@ class Maildir(Mailbox[MaildirMessage]):

colon: str
def __init__(
self, dirname: StrOrBytesPath, factory: Callable[[IO[Any]], MaildirMessage] | None = ..., create: bool = ...
self, dirname: StrPath, factory: Callable[[IO[Any]], MaildirMessage] | None = ..., create: bool = ...
) -> None: ...
def add(self, message: _MessageData) -> str: ...
def remove(self, key: str) -> None: ...
Expand Down Expand Up @@ -146,19 +149,13 @@ class _mboxMMDF(_singlefileMailbox[_MessageT]):
def get_string(self, key: str, from_: bool = ...) -> str: ...

class mbox(_mboxMMDF[mboxMessage]):
def __init__(
self, path: StrOrBytesPath, factory: Callable[[IO[Any]], mboxMessage] | None = ..., create: bool = ...
) -> None: ...
def __init__(self, path: StrPath, factory: Callable[[IO[Any]], mboxMessage] | None = ..., create: bool = ...) -> None: ...

class MMDF(_mboxMMDF[MMDFMessage]):
def __init__(
self, path: StrOrBytesPath, factory: Callable[[IO[Any]], MMDFMessage] | None = ..., create: bool = ...
) -> None: ...
def __init__(self, path: StrPath, factory: Callable[[IO[Any]], MMDFMessage] | None = ..., create: bool = ...) -> None: ...

class MH(Mailbox[MHMessage]):
def __init__(
self, path: StrOrBytesPath, factory: Callable[[IO[Any]], MHMessage] | None = ..., create: bool = ...
) -> None: ...
def __init__(self, path: StrPath, factory: Callable[[IO[Any]], MHMessage] | None = ..., create: bool = ...) -> None: ...
def add(self, message: _MessageData) -> str: ...
def remove(self, key: str) -> None: ...
def __setitem__(self, key: str, message: _MessageData) -> None: ...
Expand All @@ -173,17 +170,15 @@ class MH(Mailbox[MHMessage]):
def unlock(self) -> None: ...
def close(self) -> None: ...
def list_folders(self) -> list[str]: ...
def get_folder(self, folder: StrOrBytesPath) -> MH: ...
def add_folder(self, folder: StrOrBytesPath) -> MH: ...
def remove_folder(self, folder: StrOrBytesPath) -> None: ...
def get_folder(self, folder: StrPath) -> MH: ...
def add_folder(self, folder: StrPath) -> MH: ...
def remove_folder(self, folder: StrPath) -> None: ...
def get_sequences(self) -> dict[str, list[int]]: ...
def set_sequences(self, sequences: Mapping[str, Sequence[int]]) -> None: ...
def pack(self) -> None: ...

class Babyl(_singlefileMailbox[BabylMessage]):
def __init__(
self, path: StrOrBytesPath, factory: Callable[[IO[Any]], BabylMessage] | None = ..., create: bool = ...
) -> None: ...
def __init__(self, path: StrPath, factory: Callable[[IO[Any]], BabylMessage] | None = ..., create: bool = ...) -> None: ...
def get_message(self, key: str) -> BabylMessage: ...
def get_bytes(self, key: str) -> bytes: ...
def get_file(self, key: str) -> IO[bytes]: ...
Expand Down