Skip to content

Use protocols for gzip and _compression #5170

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
JelleZijlstra merged 3 commits into from
Apr 8, 2021
Merged

Use protocols for gzip and _compression #5170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64738a6
Use protocols for gzip and _compression
srittau Apr 1, 2021
1ffb43c
Fix
srittau Apr 1, 2021
24ad8bf
Allow str as mode parameter in last overload
srittau Apr 1, 2021
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
9 changes: 7 additions & 2 deletions stdlib/_compression.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
from _typeshed import WriteableBuffer
from io import BufferedIOBase, RawIOBase
from typing import Any, Callable, Tuple, Type, Union
from typing import Any, Callable, Protocol, Tuple, Type, Union

BUFFER_SIZE: Any

class _Reader(Protocol):
def read(self, __n: int) -> bytes: ...
def seekable(self) -> bool: ...
def seek(self, __n: int) -> Any: ...

class BaseStream(BufferedIOBase): ...

class DecompressReader(RawIOBase):
def __init__(
self,
fp: RawIOBase,
fp: _Reader,
decomp_factory: Callable[..., object],
trailing_error: Union[Type[Exception], Tuple[Type[Exception], ...]] = ...,
**decomp_args: Any,
Expand Down
92 changes: 80 additions & 12 deletions stdlib/gzip.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,46 @@ import _compression
import sys
import zlib
from _typeshed import AnyPath, ReadableBuffer
from typing import IO, Optional, TextIO, Union, overload
from io import FileIO
from typing import Any, Optional, Protocol, TextIO, Union, overload
from typing_extensions import Literal

_OpenBinaryMode = Literal["r", "rb", "a", "ab", "w", "wb", "x", "xb"]
_ReadBinaryMode = Literal["r", "rb"]
_WriteBinaryMode = Literal["a", "ab", "w", "wb", "x", "xb"]
_OpenTextMode = Literal["rt", "at", "wt", "xt"]

READ: Literal[1]
WRITE: Literal[2]

class _ReadableFileobj(Protocol):
def read(self, __n: int) -> bytes: ...
def seek(self, __n: int) -> Any: ...
# The following attributes and methods are optional:
# name: str
# mode: str
# def fileno() -> int: ...

class _WritableFileobj(Protocol):
def write(self, __b: bytes) -> Any: ...
def flush(self) -> Any: ...
# The following attributes and methods are optional:
# name: str
# mode: str
# def fileno() -> int: ...

@overload
def open(
filename: Union[AnyPath, _ReadableFileobj],
mode: _ReadBinaryMode = ...,
compresslevel: int = ...,
encoding: None = ...,
errors: None = ...,
newline: None = ...,
) -> GzipFile: ...
@overload
def open(
filename: Union[AnyPath, IO[bytes]],
mode: _OpenBinaryMode = ...,
filename: Union[AnyPath, _WritableFileobj],
mode: _WriteBinaryMode,
compresslevel: int = ...,
encoding: None = ...,
errors: None = ...,
Expand All @@ -27,7 +58,7 @@ def open(
) -> TextIO: ...
@overload
def open(
filename: Union[AnyPath, IO[bytes]],
filename: Union[AnyPath, _ReadableFileobj, _WritableFileobj],
mode: str,
compresslevel: int = ...,
encoding: Optional[str] = ...,
Expand All @@ -36,8 +67,8 @@ def open(
) -> Union[GzipFile, TextIO]: ...

class _PaddedFile:
file: IO[bytes]
def __init__(self, f: IO[bytes], prepend: bytes = ...) -> None: ...
file: _ReadableFileobj
def __init__(self, f: _ReadableFileobj, prepend: bytes = ...) -> None: ...
def read(self, size: int) -> bytes: ...
def prepend(self, prepend: bytes = ...) -> None: ...
def seek(self, off: int) -> int: ...
Expand All @@ -47,17 +78,54 @@ if sys.version_info >= (3, 8):
class BadGzipFile(OSError): ...

class GzipFile(_compression.BaseStream):
myfileobj: Optional[IO[bytes]]
mode: str
myfileobj: Optional[FileIO]
mode: Literal[1, 2]
name: str
compress: zlib._Compress
fileobj: IO[bytes]
fileobj: Union[_ReadableFileobj, _WritableFileobj]
@overload
def __init__(
self,
filename: Optional[AnyPath],
mode: _ReadBinaryMode,
compresslevel: int = ...,
fileobj: Optional[_ReadableFileobj] = ...,
mtime: Optional[float] = ...,
) -> None: ...
@overload
def __init__(
self,
*,
mode: _ReadBinaryMode,
compresslevel: int = ...,
fileobj: Optional[_ReadableFileobj] = ...,
mtime: Optional[float] = ...,
) -> None: ...
@overload
def __init__(
self,
filename: Optional[AnyPath],
mode: _WriteBinaryMode,
compresslevel: int = ...,
fileobj: Optional[_WritableFileobj] = ...,
mtime: Optional[float] = ...,
) -> None: ...
@overload
def __init__(
self,
*,
mode: _WriteBinaryMode,
compresslevel: int = ...,
fileobj: Optional[_WritableFileobj] = ...,
mtime: Optional[float] = ...,
) -> None: ...
@overload
def __init__(
self,
filename: Optional[AnyPath] = ...,
mode: Optional[str] = ...,
compresslevel: int = ...,
fileobj: Optional[IO[bytes]] = ...,
fileobj: Union[_ReadableFileobj, _WritableFileobj, None] = ...,
Comment on lines 126 to +128

@Akuli Akuli Apr 2, 2021 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This overload allows basically anything for mode and fileobj, including invalid combinations, such as "w" with a readable file object. Ideally there would be a way to say "use this overload only if mode is not a Literal", but I don't think there's anything like that.

mtime: Optional[float] = ...,
) -> None: ...

@srittau srittau Apr 1, 2021

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible to add more overloads to check filename/fileobj, but that could be done in a separate PR.

@property
Expand All @@ -82,7 +150,7 @@ class GzipFile(_compression.BaseStream):
def readline(self, size: Optional[int] = ...) -> bytes: ...

class _GzipReader(_compression.DecompressReader):
def __init__(self, fp: IO[bytes]) -> None: ...
def __init__(self, fp: _ReadableFileobj) -> None: ...
def read(self, size: int = ...) -> bytes: ...

if sys.version_info >= (3, 8):
Expand Down