8000 Use `Literal` for `compression` in `zipfile` by Viicos · Pull Request #9346 · python/typeshed · GitHub
[go: up one dir, main page]
Skip to content

Use Literal for compression in zipfile #9346

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 3 commits into from
Dec 14, 2022
Merged

Use Literal for compression in zipfile #9346

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8497729
Use `Literal` for `compression` in `zipfile`
Viicos Dec 10, 2022
1f9f832
Use `Literal` for `zipfile` constants
Viicos Dec 13, 2022
7b33830
Revert changes to very big constants
AlexWaygood Dec 14, 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
8000
Diff view
28 changes: 17 additions & 11 deletions stdlib/zipfile.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ _DateTuple: TypeAlias = tuple[int, int, int, int, int, int]
_ReadWriteMode: TypeAlias = Literal["r", "w"]
_ReadWriteBinaryMode: TypeAlias = Literal["r", "w", "rb", "wb"]
_ZipFileMode: TypeAlias = Literal["r", "w", "x", "a"]
_CompressionMode: TypeAlias = Literal[0, 8, 12, 14]

class BadZipFile(Exception): ...

Expand Down Expand Up @@ -100,7 +101,7 @@ class ZipFile:
fp: IO[bytes] | None
NameToInfo: dict[str, ZipInfo]
start_dir: int # undocumented
compression: int # undocumented
compression: _CompressionMode # undocumented
compresslevel: int | None # undocumented
mode: _ZipFileMode # undocumented
pwd: bytes | None # undocumented
Expand All @@ -110,7 +111,7 @@ class ZipFile:
self,
file: StrPath | IO[bytes],
mode: Literal["r"] = ...,
compression: int = ...,
compression: _CompressionMode = ...,
allowZip64: bool = ...,
compresslevel: int | None = ...,
*,
Expand All @@ -122,7 +123,7 @@ class ZipFile:
self,
file: StrPath | IO[bytes],
mode: _ZipFileMode = ...,
compression: int = ...,
compression: _CompressionMode = ...,
allowZip64: bool = ...,
compresslevel: int | None = ...,
*,
Expand All @@ -134,7 +135,7 @@ class ZipFile:
self,
file: StrPath | IO[bytes],
mode: _ZipFileMode = ...,
compression: int = ...,
compression: _CompressionMode = ...,
allowZip64: bool = ...,
compresslevel: int | None = ...,
*,
Expand All @@ -145,7 +146,7 @@ class ZipFile:
self,
file: StrPath | IO[bytes],
mode: _ZipFileMode = ...,
compression: int = ...,
compression: _CompressionMode = ...,
allowZip64: bool = ...,
compresslevel: int | None = ...,
) -> None: ...
Expand Down Expand Up @@ -184,14 +185,19 @@ class ZipFile:

class PyZipFile(ZipFile):
def __init__(
self, file: str | IO[bytes], mode: _ZipFileMode = ..., compression: int = ..., allowZip64: bool = ..., optimize: int = ...
self,
file: str | IO[bytes],
mode: _ZipFileMode = ...,
compression: _CompressionMode = ...,
allowZip64: bool = ...,
optimize: int = ...,
) -> None: ...
def writepy(self, pathname: str, basename: str = ..., filterfunc: Callable[[str], bool] | None = ...) -> None: ...

class ZipInfo:
filename: str
date_time: _DateTuple
compress_type: int
compress_type: _CompressionMode
comment: bytes
extra: bytes
create_system: int
Expand Down Expand Up @@ -269,10 +275,10 @@ if sys.version_info >= (3, 8):

def is_zipfile(filename: StrOrBytesPath | _SupportsReadSeekTell) -> bool: ...

ZIP_STORED: int
ZIP_DEFLATED: int
ZIP_STORED: Literal[0]
ZIP_DEFLATED: Literal[8]
ZIP64_LIMIT: int
ZIP_FILECOUNT_LIMIT: int
ZIP_MAX_COMMENT: int
ZIP_BZIP2: int
ZIP_LZMA: int
ZIP_BZIP2: Literal[12]
ZIP_LZMA: Literal[14]
0