Skip to content

[zstd] Improve typing for zstd_dict parameter #15113

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
srittau merged 1 commit into from
Dec 8, 2025
Merged

[zstd] Improve typing for zstd_dict parameter #15113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/_zstd.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,10 @@ class ZstdCompressor:
FLUSH_BLOCK: Final = 1
FLUSH_FRAME: Final = 2
def __new__(
cls, level: int | None = None, options: Mapping[int, int] | None = None, zstd_dict: ZstdDict | None = None
cls,
level: int | None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
) -> Self: ...
def compress(
self, /, data: ReadableBuffer, mode: _ZstdCompressorContinue | _ZstdCompressorFlushBlock | _ZstdCompressorFlushFrame = 0
Expand All @@ -58,7 +61,9 @@ class ZstdCompressor:

@final
class ZstdDecompressor:
def __new__(cls, zstd_dict: ZstdDict | None = None, options: Mapping[int, int] | None = None) -> Self: ...
def __new__(
cls, zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None, options: Mapping[int, int] | None = None
) -> Self: ...
def decompress(self, /, data: ReadableBuffer, max_length: int = -1) -> bytes: ...
@property
def eof(self) -> bool: ...
Expand Down
9 changes: 7 additions & 2 deletions stdlib/compression/zstd/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,14 @@ def get_frame_info(frame_buffer: ReadableBuffer) -> FrameInfo: ...
def train_dict(samples: Iterable[ReadableBuffer], dict_size: int) -> ZstdDict: ...
def finalize_dict(zstd_dict: ZstdDict, /, samples: Iterable[ReadableBuffer], dict_size: int, level: int) -> ZstdDict: ...
def compress(
data: ReadableBuffer, level: int | None = None, options: Mapping[int, int] | None = None, zstd_dict: ZstdDict | None = None
data: ReadableBuffer,
level: int | None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
) -> bytes: ...
def decompress(
data: ReadableBuffer, zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None, options: Mapping[int, int] | None = None
) -> bytes: ...
def decompress(data: ReadableBuffer, zstd_dict: ZstdDict | None = None, options: Mapping[int, int] | None = None) -> bytes: ...
@final
class CompressionParameter(enum.IntEnum):
compression_level = _zstd.ZSTD_c_compressionLevel
Expand Down
12 changes: 6 additions & 6 deletions stdlib/compression/zstd/_zstdfile.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class ZstdFile(_streams.BaseStream):
*,
level: None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
) -> None: ...
@overload
def __init__(
Expand All @@ -47,7 +47,7 @@ class ZstdFile(_streams.BaseStream):
*,
level: int | None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
) -> None: ...
def write(self, data: ReadableBuffer, /) -> int: ...
def flush(self, mode: _ZstdCompressorFlushBlock | _ZstdCompressorFlushFrame = 1) -> bytes: ... # type: ignore[override]
Expand All @@ -71,7 +71,7 @@ def open(
*,
level: None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
encoding: str | None = None,
errors: str | None = None,
newline: str | None = None,
Expand All @@ -84,7 +84,7 @@ def open(
*,
level: int | None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
encoding: str | None = None,
errors: str | None = None,
newline: str | None = None,
Expand All @@ -97,7 +97,7 @@ def open(
*,
level: None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
encoding: str | None = None,
errors: str | None = None,
newline: str | None = None,
Expand All @@ -110,7 +110,7 @@ def open(
*,
level: int | None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
encoding: str | None = None,
errors: str | None = None,
newline: str | None = None,
Expand Down
10 changes: 5 additions & 5 deletions stdlib/tarfile.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ class TarFile:
errorlevel: int | None = ...,
level: None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
) -> Self: ...

@overload
Expand Down Expand Up @@ -355,7 +355,7 @@ class TarFile:
debug: int | None = ...,
errorlevel: int | None = ...,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
) -> Self: ...
@overload
@classmethod
Expand All @@ -376,7 +376,7 @@ class TarFile:
debug: int | None = ...,
errorlevel: int | None = ...,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
) -> Self: ...

@overload
Expand Down Expand Up @@ -611,7 +611,7 @@ class TarFile:
fileobj: IO[bytes] | None = None,
level: None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
*,
format: int | None = ...,
tarinfo: type[TarInfo] | None = ...,
Expand All @@ -631,7 +631,7 @@ class TarFile:
fileobj: IO[bytes] | None = None,
level: int | None = None,
options: Mapping[int, int] | None = None,
zstd_dict: ZstdDict | None = None,
zstd_dict: ZstdDict | tuple[ZstdDict, int] | None = None,
*,
format: int | None = ...,
tarinfo: type[TarInfo] | None = ...,
Expand Down