Skip to content

tarfile improvements #5492

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 6 commits into from
May 19, 2021
Merged

tarfile improvements #5492

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f24b4c8
Remove explicit Iterable super class
srittau May 18, 2021
47fb745
Import from collections.abc
srittau May 18, 2021
c0c64ac
Use protocols for TarFile(fileobj=) and Tarfile.gzopen()
srittau May 18, 2021
51690e8
Use object instead of Any as protocol return types
srittau May 18, 2021
c6b006b
Add missing @overload
srittau May 18, 2021
46dd83c
Update stdlib/tarfile.pyi
srittau May 19, 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
60 changes: 46 additions & 14 deletions stdlib/tarfile.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
import io
import sys
from _typeshed import StrOrBytesPath, StrPath
from collections.abc import Callable, Iterable, Iterator, Mapping
from gzip import _ReadableFileobj as _GzipReadableFileobj, _WritableFileobj as _GzipWritableFileobj
from types import TracebackType
from typing import IO, Callable, Dict, Iterable, Iterator, List, Mapping, Optional, Set, Tuple, Type, Union
from typing import IO, Dict, List, Optional, Protocol, Set, Tuple, Type, Union, overload
from typing_extensions import Literal

class _Fileobj(Protocol):
def read(self, __size: int) -> bytes: ...
def write(self, __b: bytes) -> object: ...
def tell(self) -> int: ...
def seek(self, __pos: int) -> object: ...
def close(self) -> object: ...
# Optional fields:
# name: str | bytes
# mode: Literal["rb", "r+b", "wb", "xb"]

# tar constants
NUL: bytes
Expand Down Expand Up @@ -52,7 +65,7 @@ ENCODING: str
def open(
name: Optional[StrOrBytesPath] = ...,
mode: str = ...,
fileobj: Optional[IO[bytes]] = ...,
fileobj: Optional[IO[bytes]] = ..., # depends on mode
bufsize: int = ...,
*,
format: Optional[int] = ...,
Expand All @@ -70,11 +83,11 @@ def open(
class ExFileObject(io.BufferedReader):
def __init__(self, tarfile: TarFile, tarinfo: TarInfo) -> None: ...

class TarFile(Iterable[TarInfo]):
class TarFile:
OPEN_METH: Mapping[str, str]
name: Optional[StrOrBytesPath]
mode: str
fileobj: Optional[IO[bytes]]
mode: Literal["r", "a", "w", "x"]
fileobj: Optional[_Fileobj]
format: Optional[int]
tarinfo: Type[TarInfo]
dereference: Optional[bool]
Expand All @@ -89,8 +102,8 @@ class TarFile(Iterable[TarInfo]):
def __init__(
self,
name: Optional[StrOrBytesPath] = ...,
mode: str = ...,
fileobj: Optional[IO[bytes]] = ...,
mode: Literal["r", "a", "w", "x"] = ...,
fileobj: Optional[_Fileobj] = ...,
format: Optional[int] = ...,
tarinfo: Optional[Type[TarInfo]] = ...,
dereference: Optional[bool] = ...,
Expand All @@ -112,7 +125,7 @@ class TarFile(Iterable[TarInfo]):
cls,
name: Optional[StrOrBytesPath] = ...,
mode: str = ...,
fileobj: Optional[IO[bytes]] = ...,
fileobj: Optional[IO[bytes]] = ..., # depends on mode
bufsize: int = ...,
*,
format: Optional[int] = ...,
Expand All @@ -129,8 +142,8 @@ class TarFile(Iterable[TarInfo]):
def taropen(
cls,
name: Optional[StrOrBytesPath],
mode: str = ...,
fileobj: Optional[IO[bytes]] = ...,
mode: Literal["r", "a", "w", "x"] = ...,
fileobj: Optional[_Fileobj] = ...,
*,
compresslevel: int = ...,
format: Optional[int] = ...,
Expand All @@ -142,12 +155,31 @@ class TarFile(Iterable[TarInfo]):
debug: Optional[int] = ...,
errorlevel: Optional[int] = ...,
) -> TarFile: ...
@overload
@classmethod
def gzopen(
cls,
name: Optional[StrOrBytesPath],
mode: str = ...,
fileobj: Optional[IO[bytes]] = ...,
mode: Literal["r"] = ...,
fileobj: Optional[_GzipReadableFileobj] = ...,
compresslevel: int = ...,
*,
format: Optional[int] = ...,
tarinfo: Optional[Type[TarInfo]] = ...,
dereference: Optional[bool] = ...,
ignore_zeros: Optional[bool] = ...,
encoding: Optional[str] = ...,
pax_headers: Optional[Mapping[str, str]] = ...,
debug: Optional[int] = ...,
errorlevel: Optional[int] = ...,
) -> TarFile: ...
@overload
@classmethod
def gzopen(
cls,
name: Optional[StrOrBytesPath],
mode: Literal["w", "x"],
fileobj: Optional[_GzipWritableFileobj] = ...,
compresslevel: int = ...,
*,
format: Optional[int] = ...,
Expand All @@ -163,7 +195,7 @@ class TarFile(Iterable[TarInfo]):
def bz2open(
cls,
name: Optional[StrOrBytesPath],
mode: str = ...,
mode: Literal["r", "w", "x"] = ...,
fileobj: Optional[IO[bytes]] = ...,
compresslevel: int = ...,
*,
Expand All @@ -180,7 +212,7 @@ class TarFile(Iterable[TarInfo]):
def xzopen(
cls,
name: Optional[StrOrBytesPath],
mode: str = ...,
mode: Literal["r", "w", "x"] = ...,
fileobj: Optional[IO[bytes]] = ...,
preset: Optional[int] = ...,
*,
Expand Down