make python 2 and 3 os stubs identical

In preparation for merging.

I avoided making other changes to the bugs but added some TODOs for missing
stuff that I noticed.

Author: JelleZijlstra

stdlib/2/os/__init__.pyi

@@ -1,6 +1,10 @@
+# Stubs for os
+# Ron Murawski <[email protected]>
+
 # created from https://docs.python.org/2/library/os.html
 
 from builtins import OSError as error
+from io import TextIOWrapper as _TextIOWrapper
 import sys
 from typing import (
     Mapping, MutableMapping, Dict, List, Any, Tuple, Iterator, overload, Union, AnyStr,
@@ -11,11 +15,21 @@ from mypy_extensions import NoReturn
 
 _T = TypeVar('_T')
 
+# ----- os variables -----
+
+if sys.version_info >= (3, 2):
+    supports_bytes_environ: bool
+
+if sys.version_info >= (3, 3):
+    supports_dir_fd: Set[Callable[..., Any]]
+    supports_fd: Set[Callable[..., Any]]
+    supports_effective_ids: Set[Callable[..., Any]]
+    supports_follow_symlinks: Set[Callable[..., Any]]
+
 SEEK_SET: int
 SEEK_CUR: int
 SEEK_END: int
 
-# More constants, copied from stdlib/3/os/__init__.pyi
 O_RDONLY: int
 O_WRONLY: int
 O_RDWR: int
@@ -65,6 +79,8 @@ class _Environ(MutableMapping[AnyStr, AnyStr], Generic[AnyStr]):
     def copy(self) -> Dict[AnyStr, AnyStr]: ...
 
 environ: _Environ[str]
+if sys.version_info >= (3, 2):
+    environb: _Environ[bytes]
 
 confstr_names: Dict[str, int]  # Unix only
 pathconf_names: Dict[str, int]  # Unix only
@@ -86,6 +102,8 @@ EX_TEMPFAIL: int  # Unix only
 EX_PROTOCOL: int  # Unix only
 EX_NOPERM: int    # Unix only
 EX_CONFIG: int    # Unix only
+EX_NOTFOUND: int  # Unix only
+
 P_NOWAIT: int
 P_NOWAITO: int
 P_WAIT: int
@@ -99,11 +117,118 @@ WCONTINUED: int  # some Unix systems
 WUNTRACED: int  # Unix only
 
 TMP_MAX: int  # Undocumented, but used by tempfile
-_PathType = Union[bytes, Text]
-_StatVFS = NamedTuple('_StatVFS', [('f_bsize', int), ('f_frsize', int), ('f_blocks', int),
-                                   ('f_bfree', int), ('f_bavail', int), ('f_files', int),
-                                   ('f_ffree', int), ('f_favail', int), ('f_flag', int),
-                                   ('f_namemax', int)])
+
+# ----- os classes (structures) -----
+if sys.version_info >= (3, 6):
+    from builtins import _PathLike as PathLike  # See comment in builtins
+
+_PathType = path._PathType
+
+if sys.version_info >= (3, 6):
+    class DirEntry(PathLike[AnyStr]):
+        # This is what the scandir interator yields
+        # The constructor is hidden
+
+        name: AnyStr
+        path: AnyStr
+        def inode(self) -> int: ...
+        def is_dir(self, follow_symlinks: bool = ...) -> bool: ...
+        def is_file(self, follow_symlinks: bool = ...) -> bool: ...
+        def is_symlink(self) -> bool: ...
+        def stat(self) -> stat_result: ...
+
+        def __fspath__(self) -> AnyStr: ...
+elif sys.version_info >= (3, 5):
+    class DirEntry(Generic[AnyStr]):
+        # This is what the scandir interator yields
+        # The constructor is hidden
+
+        name: AnyStr
+        path: AnyStr
+        def inode(self) -> int: ...
+        def is_dir(self, follow_symlinks: bool = ...) -> bool: ...
+        def is_file(self, follow_symlinks: bool = ...) -> bool: ...
+        def is_symlink(self) -> bool: ...
+        def stat(self) -> stat_result: ...
+
+
+class stat_result:
+    # For backward compatibility, the return value of stat() is also
+    # accessible as a tuple of at least 10 integers giving the most important
+    # (and portable) members of the stat structure, in the order st_mode,
+    # st_ino, st_dev, st_nlink, st_uid, st_gid, st_size, st_atime, st_mtime,
+    # st_ctime. More items may be added at the end by some implementations.
+
+    st_mode: int  # protection bits,
+    st_ino: int  # inode number,
+    st_dev: int  # device,
+    st_nlink: int  # number of hard links,
+    st_uid: int  # user id of owner,
+    st_gid: int  # group id of owner,
+    st_size: int  # size of file, in bytes,
+    st_atime: float  # time of most recent access,
+    st_mtime: float  # time of most recent content modification,
+    st_ctime: float  # platform dependent (time of most recent metadata change on Unix, or the time of creation on Windows)
+
+    if sys.version_info >= (3, 3):
+        st_atime_ns: int  # time of most recent access, in nanoseconds
+        st_mtime_ns: int  # time of most recent content modification in nanoseconds
+        st_ctime_ns: int  # platform dependent (time of most recent metadata change on Unix, or the time of creation on Windows) in nanoseconds
+
+    # not documented
+    def __init__(self, tuple: Tuple[int, ...]) -> None: ...
+
+    # On some Unix systems (such as Linux), the following attributes may also
+    # be available:
+    st_blocks: int  # number of blocks allocated for file
+    st_blksize: int  # filesystem blocksize
+    st_rdev: int  # type of device if an inode device
+    st_flags: int  # user defined flags for file
+
+    # On other Unix systems (such as FreeBSD), the following attributes may be
+    # available (but may be only filled out if root tries to use them):
+    st_gen: int  # file generation number
+    st_birthtime: int  # time of file creation
+
+    # On Mac OS systems, the following attributes may also be available:
+    st_rsize: int
+    st_creator: int
+    st_type: int
+
+class statvfs_result:  # Unix only
+    f_bsize: int
+    f_frsize: int
+    f_blocks: int
+    f_bfree: int
+    f_bavail: int
+    f_files: int
+    f_ffree: int
+    f_favail: int
+    f_flag: int
+    f_namemax: int
+
+# ----- os function stubs -----
+if sys.version_info >= (3, 6):
+    def fsencode(filename: Union[str, bytes, PathLike]) -> bytes: ...
+elif sys.version_info >= (3, 2):
+    def fsencode(filename: Union[str, bytes]) -> bytes: ...
+
+if sys.version_info >= (3, 6):
+    def fsdecode(filename: Union[str, bytes, PathLike]) -> str: ...
+elif sys.version_info >= (3, 2):
+    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: ...
+
+if sys.version_info >= (3, 2):
+    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
 def getegid() -> int: ...  # Unix only
 def geteuid() -> int: ...  # Unix only
@@ -139,20 +264,28 @@ def uname() -> Tuple[str, str, str, str, str]: ...  # Unix only
 def getenv(key: Text) -> Optional[str]: ...
 @overload
 def getenv(key: Text, default: _T) -> Union[str, _T]: ...
+if sys.version_info >= (3, 2):
+    def getenvb(key: bytes, default: bytes = ...) -> bytes: ...
 def putenv(key: Union[bytes, Text], value: Union[bytes, Text]) -> None: ...
 def unsetenv(key: Union[bytes, Text]) -> None: ...
 
-def fdopen(fd: int, *args, **kwargs) -> IO[Any]: ...
+if sys.version_info >= (3, 0):
+    def fdopen(fd: int, mode: str = ..., buffering: int = ..., encoding: str = ...,
+               errors: str = ..., newline: str = ..., closefd: bool = ...) -> IO[Any]: ...
+else:
+    def fdopen(fd: int, mode: str = ..., bufsize: int = ...) -> IO[Any]: ...
 def close(fd: int) -> None: ...
 def closerange(fd_low: int, fd_high: int) -> None: ...
+if sys.version_info >= (3, 0):
+    def device_encoding(fd: int) -> Optional[str]: ...
 def dup(fd: int) -> int: ...
 def dup2(fd: int, fd2: int) -> None: ...
 def fchmod(fd: int, mode: int) -> None: ...  # Unix only
 def fchown(fd: int, uid: int, gid: int) -> None: ...  # Unix only
 def fdatasync(fd: int) -> None: ...  # Unix only, not Mac
 def fpathconf(fd: int, name: Union[str, int]) -> int: ...  # Unix only
 def fstat(fd: int) -> Any: ...
-def fstatvfs(fd: int) -> _StatVFS: ...  # Unix only
+def fstatvfs(fd: int) -> statvfs_result: ...  # Unix only
 def fsync(fd: int) -> None: ...
 def ftruncate(fd: int, length: int) -> None: ...  # Unix only
 def isatty(fd: int) -> bool: ...  # Unix only
@@ -169,7 +302,10 @@ def access(path: _PathType, mode: int) -> bool: ...
 def chdir(path: _PathType) -> None: ...
 def fchdir(fd: int) -> None: ...
 def getcwd() -> str: ...
-def getcwdu() -> unicode: ...
+if sys.version_info >= (3, 0):
+    def getcwdb() -> bytes: ...
+else:
+    def getcwdu() -> unicode: ...
 def chflags(path: _PathType, flags: int) -> None: ...  # Unix only
 def chroot(path: _PathType) -> None: ...  # Unix only
 def chmod(path: _PathType, mode: int) -> None: ...
@@ -178,36 +314,73 @@ def lchflags(path: _PathType, flags: int) -> None: ...  # Unix only
 def lchmod(path: _PathType, mode: int) -> None: ...  # Unix only
 def lchown(path: _PathType, uid: int, gid: int) -> None: ...  # Unix only
 def link(src: _PathType, link_name: _PathType) -> None: ...
-def listdir(path: AnyStr) -> List[AnyStr]: ...
+
+# TODO: support PathLike and fd arguments
+if sys.version_info >= (3, 2):
+    @overload
+    def listdir(path: str = ...) -> List[str]: ...
+    @overload
+    def listdir(path: bytes) -> List[bytes]: ...
+else:
+    def listdir(path: AnyStr) -> List[AnyStr]: ...
+
 def lstat(path: _PathType) -> Any: ...
 def mkfifo(path: _PathType, mode: int = ...) -> None: ...  # Unix only
 def mknod(filename: _PathType, mode: int = ..., device: int = ...) -> None: ...
 def major(device: int) -> int: ...
 def minor(device: int) -> int: ...
 def makedev(major: int, minor: int) -> int: ...
 def mkdir(path: _PathType, mode: int = ...) -> None: ...
-def makedirs(path: _PathType, mode: int = ...) -> None: ...
+if sys.version_info >= (3, 2):
+    def makedirs(path: _PathType, mode: int = ...,
+                 exist_ok: bool = ...) -> None: ...
+else:
+    def makedirs(path: _PathType, mode: int = ...) -> None: ...
 def pathconf(path: _PathType, name: Union[str, int]) -> int: ...  # Unix only
 def readlink(path: AnyStr) -> AnyStr: ...
 def remove(path: _PathType) -> None: ...
 def removedirs(path: _PathType) -> None: ...
 def rename(src: _PathType, dst: _PathType) -> None: ...
 def renames(old: _PathType, new: _PathType) -> None: ...
+if sys.version_info >= (3, 3):
+    def replace(src: _PathType, dst: _PathType) -> None: ...
 def rmdir(path: _PathType) -> None: ...
+if sys.version_info >= (3, 5):
+    @overload
+    def scandir(path: str = ...) -> Iterator[DirEntry[str]]: ...
+    @overload
+    def scandir(path: bytes) -> Iterator[DirEntry[bytes]]: ...
+# This cannot return stat_result because of the issues discussed in
+# https://github.com/python/typeshed/pull/1103
 def stat(path: _PathType) -> Any: ...
 @overload
 def stat_float_times(newvalue: bool = ...) -> None: ...
 @overload
 def stat_float_times() -> bool: ...
-def statvfs(path: _PathType) -> _StatVFS: ...  # Unix only
-def symlink(source: _PathType, link_name: _PathType) -> None: ...
+def statvfs(path: _PathType) -> statvfs_result: ...  # Unix only
+# TODO add dir_fd argument
+if sys.version_info >= (3, 0):
+    def symlink(source: _PathType, link_name: _PathType,
+                target_is_directory: bool = ...) -> None:
+        ...  # final argument in Windows only
+else:
+    def symlink(source: _PathType, link_name: _PathType) -> None: ...
 def unlink(path: _PathType) -> None: ...
-def utime(path: _PathType, times: Optional[Tuple[float, float]]) -> None: ...
+# TODO: add ns, dir_fd, follow_symlinks argument
+if sys.version_info >= (3, 0):
+    def utime(path: _PathType, times: Optional[Tuple[float, float]] = ...) -> None: ...
+else:
+    def utime(path: _PathType, times: Optional[Tuple[float, float]]) -> None: ...
 
-# TODO onerror: function from OSError to void
-def walk(top: AnyStr, topdown: bool = ..., onerror: Any = ...,
-         followlinks: bool = ...) -> Iterator[Tuple[AnyStr, List[AnyStr],
-                                                    List[AnyStr]]]: ...
+if sys.version_info >= (3, 6):
+    def walk(top: Union[AnyStr, PathLike[AnyStr]], topdown: bool = ...,
+             onerror: Optional[Callable[[OSError], Any]] = ...,
+             followlinks: bool = ...) -> Iterator[Tuple[AnyStr, List[AnyStr],
+                                                        List[AnyStr]]]: ...
+else:
+    def walk(top: AnyStr, topdown: bool = ..., onerror: Optional[Callable[[OSError], Any]] = ...,
+             followlinks: bool = ...) -> Iterator[Tuple[AnyStr, List[AnyStr],
+                                                        List[AnyStr]]]: ...
 
 def abort() -> NoReturn: ...
 # These are defined as execl(file, *args) but the first *arg is mandatory.
@@ -232,11 +405,19 @@ def forkpty() -> Tuple[int, int]: ...  # some flavors of Unix
 def kill(pid: int, sig: int) -> None: ...
 def killpg(pgid: int, sig: int) -> None: ...  # Unix only
 def nice(increment: int) -> int: ...  # Unix only
-# TODO: plock, popen*, P_*
-def popen(command: str, *args, **kwargs) -> Optional[IO[Any]]: ...
-def popen2(cmd: str, *args, **kwargs) -> Tuple[IO[Any], IO[Any]]: ...
-def popen3(cmd: str, *args, **kwargs) -> Tuple[IO[Any], IO[Any], IO[Any]]: ...
-def popen4(cmd: str, *args, **kwargs) -> Tuple[IO[Any], IO[Any]]: ...
+def plock(op: int) -> None: ...  # Unix only ???op is int?
+
+if sys.version_info >= (3, 0):
+    class popen(_TextIOWrapper):
+        # TODO 'b' modes or bytes command not accepted?
+        def __init__(self, command: str, mode: str = ...,
+                     bufsize: int = ...) -> None: ...
+        def close(self) -> Any: ...  # may return int
+else:
+    def popen(command: str, *args, **kwargs) -> Optional[IO[Any]]: ...
+    def popen2(cmd: str, *args, **kwargs) -> Tuple[IO[Any], IO[Any]]: ...
+    def popen3(cmd: str, *args, **kwargs) -> Tuple[IO[Any], IO[Any], IO[Any]]: ...
+    def popen4(cmd: str, *args, **kwargs) -> Tuple[IO[Any], IO[Any]]: ...
 
 def spawnl(mode: int, path: _PathType, arg0: Union[bytes, Text], *args: Union[bytes, Text]) -> int: ...
 def spawnle(mode: int, path: _PathType, arg0: Union[bytes, Text],
@@ -272,10 +453,34 @@ def getloadavg() -> Tuple[float, float, float]: ...  # Unix only
 def sysconf(name: Union[str, int]) -> int: ...  # Unix only
 def urandom(n: int) -> bytes: ...
 
-def tmpfile() -> IO[Any]: ...
-def tmpnam() -> str: ...
-def tempnam(dir: str = ..., prefix: str = ...) -> str: ...
+if sys.version_info >= (3, 0):
+    def sched_getaffinity(id: int) -> Set[int]: ...
+if sys.version_info >= (3, 3):
+    class waitresult:
+        si_pid: int
+    def waitid(idtype: int, id: int, options: int) -> waitresult: ...
+
+if sys.version_info < (3, 0):
+    def tmpfile() -> IO[Any]: ...
+    def tmpnam() -> str: ...
+    def tempnam(dir: str = ..., prefix: str = ...) -> str: ...
 
 P_ALL: int
 WEXITED: int
 WNOWAIT: int
+
+if sys.version_info >= (3, 3):
+    def sync() -> None: ...  # Unix only
+
+    def truncate(path: Union[_PathType, int], length: int) -> None: ...  # Unix only up to version 3.4
+
+    def fwalk(top: AnyStr = ..., topdown: bool = ...,
+              onerror: Callable = ..., *, follow_symlinks: bool = ...,
+              dir_fd: int = ...) -> Iterator[Tuple[AnyStr, List[AnyStr],
+                                             List[AnyStr], int]]: ...  # Unix only
+
+    terminal_size = NamedTuple('terminal_size', [('columns', int), ('lines', int)])
+    def get_terminal_size(fd: int = ...) -> terminal_size: ...
+
+if sys.version_info >= (3, 4):
+    def cpu_count() -> Optional[int]: ...