Skip to content

Add overloads to TarFile.__init__ to prevent both name and fileobj being None #14889

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add overloads to TarFile.__init__ to prevent both name and fileobj being None #14889

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
72 changes: 72 additions & 0 deletions stdlib/tarfile.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,43 @@ class TarFile:
extraction_filter: _FilterFunction | None
if sys.version_info >= (3, 13):
stream: bool
@overload
def __init__(
self,
name: StrOrBytesPath, # name is required (not None)
mode: Literal["r", "a", "w", "x"] = "r",
fileobj: _Fileobj | None = None,
format: int | None = None,
tarinfo: type[TarInfo] | None = None,
dereference: bool | None = None,
ignore_zeros: bool | None = None,
encoding: str | None = None,
errors: str = "surrogateescape",
pax_headers: Mapping[str, str] | None = None,
debug: int | None = None,
errorlevel: int | None = None,
copybufsize: int | None = None,
stream: bool = False,
) -> None: ...
@overload
def __init__(
self,
name: None = None,
mode: Literal["r", "a", "w", "x"] = "r",
*,
fileobj: _Fileobj, # fileobj is required when name is None
format: int | None = None,
tarinfo: type[TarInfo] | None = None,
dereference: bool | None = None,
ignore_zeros: bool | None = None,
encoding: str | None = None,
errors: str = "surrogateescape",
pax_headers: Mapping[str, str] | None = None,
debug: int | None = None,
errorlevel: int | None = None,
copybufsize: int | None = None,
stream: bool = False,
) -> None: ...
def __init__(
self,
name: StrOrBytesPath | None = None,
Expand All @@ -152,6 +189,41 @@ class TarFile:
stream: bool = False,
) -> None: ...
else:
@overload
def __init__(
self,
name: StrOrBytesPath, # name is required (not None)
mode: Literal["r", "a", "w", "x"] = "r",
fileobj: _Fileobj | None = None,
format: int | None = None,
tarinfo: type[TarInfo] | None = None,
dereference: bool | None = None,
ignore_zeros: bool | None = None,
encoding: str | None = None,
errors: str = "surrogateescape",
pax_headers: Mapping[str, str] | None = None,
debug: int | None = None,
errorlevel: int | None = None,
copybufsize: int | None = None,
) -> None: ...
@overload
def __init__(
self,
name: None = None,
mode: Literal["r", "a", "w", "x"] = "r",
*,
fileobj: _Fileobj, # fileobj is required when name is None
format: int | None = None,
tarinfo: type[TarInfo] | None = None,
dereference: bool | None = None,
ignore_zeros: bool | None = None,
encoding: str | None = None,
errors: str = "surrogateescape",
pax_headers: Mapping[str, str] | None = None,
debug: int | None = None,
errorlevel: int | None = None,
copybufsize: int | None = None,
) -> None: ...
def __init__(
self,
name: StrOrBytesPath | None = None,
Expand Down
Loading