Skip to content

Update open, os.fspath, os.fsencode, os.fsdecode, pathlib.PurePath and pathlib.Path stubs due to PEP-519 #991

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
merged 5 commits into from
Mar 21, 2017
Merged

Update open, os.fspath, os.fsencode, os.fsdecode, pathlib.PurePath and pathlib.Path stubs due to PEP-519 #991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
48b271c
Update stub for builtin `open` function due to PEP-519.
sproshev Mar 13, 2017
1086038
Update stubs for `os.path`, `os.fsencode` and `os.fsdecode` functions…
sproshev Mar 13, 2017
e4fdd0e
Update stubs for `pathlib.PurePath` and `pathlib.Path` classes due to…
sproshev Mar 13, 2017
99a1afd
Update input parameter type for `os.fsencode` (+bytes) and `os.fsdeco…
sproshev Mar 18, 2017
89de36a
Update `os.fspath(path: PathLike)` to return `Any` since `Union` retu…
sproshev Mar 21, 2017
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
12 changes: 9 additions & 3 deletions stdlib/3.4/pathlib.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ class PurePath(_PurePathBase):
stem = ... # type: str
if sys.version_info < (3, 5):
def __init__(self, *pathsegments: str) -> None: ...
else:
elif sys.version_info < (3, 6):
def __new__(cls: Type[_P], *args: Union[str, PurePath]) -> _P: ...
else:
def __new__(cls: Type[_P], *args: Union[str, os.PathLike]) -> _P: ...
def __hash__(self) -> int: ...
def __lt__(self, other: PurePath) -> bool: ...
def __le__(self, other: PurePath) -> bool: ...
Expand Down Expand Up @@ -93,8 +95,12 @@ class Path(PurePath):
if sys.version_info >= (3, 5):
@classmethod
def home(cls: Type[_P]) -> _P: ...
def __new__(cls: Type[_P], *args: Union[str, PurePath],
**kwargs: Any) -> _P: ...
if sys.version_info < (3, 6):
def __new__(cls: Type[_P], *args: Union[str, PurePath],
**kwargs: Any) -> _P: ...
Copy link
Member

Choose a reason for hiding this comment

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

Interesting, apparently Path takes arbitrary kwargs and then ignores them. This doesn't appear to be documented. Do you know why this is? I might open a bug against CPython about this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know. I think it is better to open a bug.

Copy link
Member

Choose a reason for hiding this comment

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

http://bugs.python.org/issue29847

else:
def __new__(cls: Type[_P], *args: Union[str, os.PathLike],
**kwargs: Any) -> _P: ...

def absolute(self: _P) -> _P: ...
def expanduser(self: _P) -> _P: ...
Expand Down
4 changes: 2 additions & 2 deletions stdlib/3/builtins.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -795,8 +795,8 @@ def next(i: Iterator[_T], default: _VT) -> Union[_T, _VT]: ...
def oct(i: int) -> str: ... # TODO __index__

if sys.version_info >= (3, 6):
from pathlib import Path
def open(file: Union[str, bytes, int, Path], mode: str = 'r', buffering: int = -1, encoding: str = None,
from os import PathLike
def open(file: Union[str, bytes, int, PathLike], mode: str = 'r', buffering: int = -1, encoding: str = None,
errors: str = None, newline: str = None, closefd: bool = ...) -> IO[Any]: ...
else:
def open(file: Union[str, bytes, int], mode: str = 'r', buffering: int = -1, encoding: str = None,
Expand Down
20 changes: 18 additions & 2 deletions stdlib/3/os/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,24 @@ class statvfs_result: # Unix only
f_namemax = 0

# ----- os function stubs -----
def fsencode(filename: str) -> bytes: ...
def fsdecode(filename: bytes) -> str: ...
if sys.version_info >= (3, 6):
def fsencode(filename: Union[str, bytes, PathLike]) -> bytes: ...
else:
def fsencode(filename: Union[str, bytes]) -> bytes: ...

if sys.version_info >= (3, 6):
def fsdecode(filename: Union[str, bytes, PathLike]) -> str: ...
else:
def fsdecode(filename: Union[str, bytes]) -> str: ...

if sys.version_info >= (3, 6):
@overload
def fspath(path: str) -> str: ...
@overload
def fspath(path: bytes) -> bytes: ...
@overload
def fspath(path: PathLike) -> Any: ...

def get_exec_path(env: Optional[Mapping[str, str]] = ...) -> List[str]: ...
# NOTE: get_exec_path(): returns List[bytes] when env not None
def ctermid() -> str: ... # Unix only
Expand Down