[zstd] Improve typing for zstd_dict parameter (#15113)

This commit is contained in:
Rogdham
2025-12-08 15:02:30 +01:00
committed by GitHub
parent 5d41fd6800
commit 3e74d5c181
4 changed files with 25 additions and 15 deletions
+7 -2
View File
@@ -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
@@ -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: ...
+7 -2
View File
@@ -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
+6 -6
View File
@@ -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__(
@@ -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]
@@ -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,
@@ -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,
@@ -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,
@@ -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,
+5 -5
View File
@@ -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
@@ -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
@@ -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
@@ -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 = ...,
@@ -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 = ...,