mercurial-scm/hg: mercurial/windows.py comparison

comparison mercurial/windows.py @ 49812:58dff81ffba1

typing: add type hints to the common posix/windows platform functions These are done in sync because some platforms have empty implementations, and it isn't obvious what the types should be without examining the other. We want the types aligned, so @overload definitions that differ aren't generated. The only differences here are the few methods that unconditionally raise an error are marked as `NoReturn`, which doesn't seem to bother pytype. A couple of the posix module functions needed to be updated with a modern ternary operator, because pytype seems to want to use the type of the second object in the old `return x and y` style.

author	Matt Harbison <matt_harbison@yahoo.com>
date	Fri, 16 Dec 2022 00:54:39 -0500
parents	c43b283a19c3
children	464fe8b8f474

comparison

equal deleted inserted replaced

-:0a91aba258e0
+:58dff81ffba1
 import sys
 import winreg  # pytype: disable=import-error
 from typing import (
 BinaryIO,
+Iterable,
+Iterator,
+List,
+NoReturn,
+Optional,
+Sequence,
+Union,
 )
 from .i18n import _
 from .pycompat import getattr
 from . import (
 # may be wrapped by win32mbcs extension
 listdir = osutil.listdir
-def get_password():
+def get_password() -> bytes:
 """Prompt for password with echo off, using Windows getch().
 This shouldn't be called directly- use ``ui.getpass()`` instead, which
 checks if the session is interactive first.
 """
 if not win32.lasterrorwaspipeerror(inst):
 raise
 raise IOError(errno.EPIPE, 'Broken pipe')
-def openhardlinks():
+def openhardlinks() -> bool:
 return True
-def parsepatchoutput(output_line):
+def parsepatchoutput(output_line: bytes) -> bytes:
 """parses the output produced by patch and returns the filename"""
 pf = output_line[14:]
 if pf[0] == b'`':
 pf = pf[1:-1]  # Remove the quotes
 return pf
-def sshargs(sshcmd, host, user, port):
+def sshargs(
+sshcmd: bytes, host: bytes, user: Optional[bytes], port: Optional[bytes]
+) -> bytes:
 '''Build argument list for ssh or Plink'''
 pflag = b'plink' in sshcmd.lower() and b'-P' or b'-p'
 args = user and (b"%s@%s" % (user, host)) or host
 if args.startswith(b'-') or args.startswith(b'/'):
 raise error.Abort(
 if port:
 args = b'%s %s %s' % (pflag, shellquote(port), args)
 return args
-def setflags(f, l, x):
+def setflags(f: bytes, l: bool, x: bool) -> None:
 pass
-def copymode(src, dst, mode=None, enforcewritable=False):
+def copymode(
+src: bytes,
+dst: bytes,
+mode: Optional[bytes] = None,
+enforcewritable: bool = False,
+) -> None:
 pass
-def checkexec(path):
+def checkexec(path: bytes) -> bool:
 return False
-def checklink(path):
+def checklink(path: bytes) -> bool:
 return False
-def setbinary(fd):
+def setbinary(fd) -> None:
 # When run without console, pipes may expose invalid
 # fileno(), usually set to -1.
 fno = getattr(fd, 'fileno', None)
 if fno is not None and fno() >= 0:
 msvcrt.setmode(fno(), os.O_BINARY)  # pytype: disable=module-attr
-def pconvert(path):
+def pconvert(path: bytes) -> bytes:
 return path.replace(pycompat.ossep, b'/')
-def localpath(path):
+def localpath(path: bytes) -> bytes:
 return path.replace(b'/', b'\\')
 def normpath(path):
 return pconvert(os.path.normpath(path))
-def normcase(path):
+def normcase(path: bytes) -> bytes:
 return encoding.upper(path)  # NTFS compares via upper()
 DRIVE_RE_B = re.compile(b'^[a-z]:')
 DRIVE_RE_S = re.compile('^[a-z]:')
 # quote we've appended to the end)
 _quotere = None
 _needsshellquote = None
-def shellquote(s):
+def shellquote(s: bytes) -> bytes:
 r"""
 >>> shellquote(br'C:\Users\xyz')
 '"C:\\Users\\xyz"'
 >>> shellquote(br'C:\Users\xyz/mixed')
 '"C:\\Users\\xyz/mixed"'
 if s.startswith(b'"') and s.endswith(b'"'):
 return s[1:-1]
 return s
-def shellsplit(s):
+def shellsplit(s: bytes) -> List[bytes]:
 """Parse a command string in cmd.exe way (best-effort)"""
 return pycompat.maplist(_unquote, pycompat.shlexsplit(s, posix=False))
 # if you change this stub into a real check, please try to implement the
 # username and groupname functions above, too.
-def isowner(st):
+def isowner(st: os.stat_result) -> bool:
 return True
-def findexe(command):
+def findexe(command: bytes) -> Optional[bytes]:
 """Find executable for command searching like cmd.exe does.
 If command is a basename then PATH is searched for command.
 PATH isn't searched if command is an absolute or relative path.
 An extension from PATHEXT is found and added if not present.
 If command isn't found None is returned."""
 pathext = encoding.environ.get(b'PATHEXT', b'.COM;.EXE;.BAT;.CMD')
 pathexts = [ext for ext in pathext.lower().split(pycompat.ospathsep)]
 if os.path.splitext(command)[1].lower() in pathexts:
 pathexts = [b'']
-def findexisting(pathcommand):
+def findexisting(pathcommand: bytes) -> Optional[bytes]:
 """Will append extension (if needed) and return existing file"""
 for ext in pathexts:
 executable = pathcommand + ext
 if os.path.exists(executable):
 return executable
 _wantedkinds = {stat.S_IFREG, stat.S_IFLNK}
-def statfiles(files):
+def statfiles(files: Sequence[bytes]) -> Iterator[Optional[os.stat_result]]:
 """Stat each file in files. Yield each stat, or None if a file
 does not exist or has a type we don't care about.
 Cluster and cache stat per directory to minimize number of OS stat calls."""
 dircache = {}  # dirname -> filename -> status | None if file does not exist
 dmap = {}
 cache = dircache.setdefault(dir, dmap)
 yield cache.get(base, None)
-def username(uid=None):
+def username(uid: Optional[int] = None) -> Optional[bytes]:
 """Return the name of the user with the given uid.
 If uid is None, return the name of the current user."""
 if not uid:
 try:
 # which exists on Windows.
 pass
 return None
-def groupname(gid=None):
+def groupname(gid: Optional[int] = None) -> Optional[bytes]:
 """Return the name of the group with the given gid.
 If gid is None, return the name of the current group."""
 return None
 def gethgcmd():
 return [encoding.strtolocal(arg) for arg in [sys.executable] + sys.argv[:1]]
-def groupmembers(name):
+def groupmembers(name: bytes) -> List[bytes]:
 # Don't support groups on Windows for now
 raise KeyError
-def isexec(f):
+def isexec(f: bytes) -> bool:
 return False
 class cachestat:
 def __init__(self, path):
 def cacheable(self):
 return False
-def lookupreg(key, valname=None, scope=None):
+def lookupreg(
+key: bytes,
+valname: Optional[bytes] = None,
+scope: Optional[Union[int, Iterable[int]]] = None,
+) -> Optional[bytes]:
 """Look up a key/value name in the Windows registry.
 valname: value name. If unspecified, the default value for the key
 is used.
 scope: optionally specify scope for registry lookup, this can be
 expandglobs = True
-def statislink(st):
+def statislink(st: Optional[os.stat_result]) -> bool:
 '''check whether a stat result is a symlink'''
 return False
-def statisexec(st):
+def statisexec(st: Optional[os.stat_result]) -> bool:
 '''check whether a stat result is an executable file'''
 return False
 def poll(fds):
 # see posix.py for description
 raise NotImplementedError()
-def readpipe(pipe):
+def readpipe(pipe) -> bytes:
 """Read all available data from a pipe."""
 chunks = []
 while True:
 size = win32.peekpipe(pipe)
 if not size:
 chunks.append(s)
 return b''.join(chunks)
-def bindunixsocket(sock, path):
+def bindunixsocket(sock, path: bytes) -> NoReturn:
 raise NotImplementedError('unsupported platform')

Mercurial > public > mercurial-scm > hg

comparison mercurial/windows.py @ 49812:58dff81ffba1