Skip to content

Update stub for tarfile #1389

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
matthiaskramm merged 1 commit into from
Jun 9, 2017
+17 −9
Merged

Update stub for tarfile #1389

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
26 changes: 17 additions & 9 deletions stdlib/2and3/tarfile.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@ from typing import (
Callable, IO, Iterable, Iterator, List, Mapping, Optional, Type,
Union,
)
import os
import sys
from types import TracebackType


if sys.version_info >= (3, 6):
_Path = Union[bytes, str, os.PathLike]
elif sys.version_info >= (3,):
_Path = Union[bytes, str]
else:
_Path = Union[str, unicode]

ENCODING = ... # type: str

USTAR_FORMAT = ... # type: int
Expand All @@ -30,7 +38,7 @@ if sys.version_info < (3,):
TAR_PLAIN = ... # type: int
TAR_GZIPPED = ... # type: int

def open(name: Optional[str] = ..., mode: str = ...,
def open(name: Optional[_Path] = ..., mode: str = ...,
Copy link
Copy Markdown
Member

@JelleZijlstra JelleZijlstra Jun 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think AnyStr makes sense here, because this is the only argument to the function (AnyStr is a typevar, and it should be used to constrain multiple arguments or an argument and the return value to be the same typE). I think this function can just take Union[bytes, str] as an argument; same for most others below.

Copy link
Copy Markdown
Contributor Author

@ymyzk ymyzk Jun 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay. I misunderstood use of AnyStr.

fileobj: Optional[IO[bytes]] = ..., bufsize: int = ...,
*, format: Optional[int] = ..., tarinfo: Optional[TarInfo] = ...,
dereference: Optional[bool] = ...,
Expand All @@ -43,7 +51,7 @@ def open(name: Optional[str] = ..., mode: str = ...,


class TarFile(Iterable[TarInfo]):
name = ... # type: Optional[str]
name = ... # type: Optional[_Path]
mode = ... # type: str
fileobj = ... # type: Optional[IO[bytes]]
format = ... # type: Optional[int]
Expand All @@ -57,7 +65,7 @@ class TarFile(Iterable[TarInfo]):
errorlevel = ... # type: Optional[int]
if sys.version_info < (3,):
posix = ... # type: bool
def __init__(self, name: Optional[str] = ..., mode: str = ...,
def __init__(self, name: Optional[_Path] = ..., mode: str = ...,
fileobj: Optional[IO[bytes]] = ...,
format: Optional[int] = ..., tarinfo: Optional[TarInfo] = ...,
dereference: Optional[bool] = ...,
Expand All @@ -74,7 +82,7 @@ class TarFile(Iterable[TarInfo]):
exc_tb: Optional[TracebackType]) -> bool: ...
def __iter__(self) -> Iterator[TarInfo]: ...
@classmethod
def open(cls, name: Optional[str] = ..., mode: str = ...,
def open(cls, name: Optional[_Path] = ..., mode: str = ...,
fileobj: Optional[IO[bytes]] = ..., bufsize: int = ...,
*, format: Optional[int] = ..., tarinfo: Optional[TarInfo] = ...,
dereference: Optional[bool] = ...,
Expand All @@ -93,22 +101,22 @@ class TarFile(Iterable[TarInfo]):
def list(self, verbose: bool = ...) -> None: ...
def next(self) -> Optional[TarInfo]: ...
if sys.version_info >= (3, 5):
def extractall(self, path: str = ...,
def extractall(self, path: _Path = ...,
members: Optional[List[TarInfo]] = ...,
*, numeric_owner: bool = ...) -> None: ...
else:
def extractall(self, path: str = ...,
def extractall(self, path: _Path = ...,
members: Optional[List[TarInfo]] = ...) -> None: ...
if sys.version_info >= (3, 5):
def extract(self, member: Union[str, TarInfo], path: str = ...,
def extract(self, member: Union[str, TarInfo], path: _Path = ...,
set_attrs: bool = ...,
*, numeric_owner: bool = ...) -> None: ...
elif sys.version_info >= (3,):
def extract(self, member: Union[str, TarInfo], path: str = ...,
def extract(self, member: Union[str, TarInfo], path: _Path = ...,
set_attrs: bool = ...) -> None: ...
else:
def extract(self, member: Union[str, TarInfo],
path: str = ...) -> None: ...
path: _Path = ...) -> None: ...
def extractfile(self,
member: Union[str, TarInfo]) -> Optional[IO[bytes]]: ...
if sys.version_info >= (3,):
Expand Down