pytype: import typing directly

First we no longer needs the pycompat layer, second having the types imported in
all case will allow to use them more directly in type annotation, something
important to upgrade the old "type comment" to proper type annotation.

A lot a stupid assert are needed to keep pyflakes happy. We should be able to
remove most of them once the type comment have been upgraded.

mercurial/branchmap.py

@@ -1,880 +1,883 b''
 # branchmap.py - logic to computes, maintain and stores branchmap for local repo
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import struct
 
 from .node import (
     bin,
     hex,
     nullrev,
 )
+
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Iterable,
+    List,
+    Optional,
+    Set,
+    TYPE_CHECKING,
+    Tuple,
+    Union,
+)
+
 from . import (
     encoding,
     error,
     obsolete,
-    pycompat,
     scmutil,
     util,
 )
+
 from .utils import (
     repoviewutil,
     stringutil,
 )
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Any,
-        Callable,
-        Dict,
-        Iterable,
-        List,
-        Optional,
-        Set,
-        Tuple,
-        Union,
-    )
+# keeps pyflakes happy
+assert [
+    Any,
+    Callable,
+    Dict,
+    Iterable,
+    List,
+    Optional,
+    Set,
+    Tuple,
+    Union,
+]
+
+if TYPE_CHECKING:
     from . import localrepo
 
-    assert any(
-        (
-            Any,
-            Callable,
-            Dict,
-            Iterable,
-            List,
-            Optional,
-            Set,
-            Tuple,
-            Union,
-            localrepo,
-        )
-    )
+    assert [localrepo]
 
 subsettable = repoviewutil.subsettable
 
 calcsize = struct.calcsize
 pack_into = struct.pack_into
 unpack_from = struct.unpack_from
 
 
 class BranchMapCache:
     """mapping of filtered views of repo with their branchcache"""
 
     def __init__(self):
         self._per_filter = {}
 
     def __getitem__(self, repo):
         self.updatecache(repo)
         return self._per_filter[repo.filtername]
 
     def updatecache(self, repo):
         """Update the cache for the given filtered view on a repository"""
         # This can trigger updates for the caches for subsets of the filtered
         # view, e.g. when there is no cache for this filtered view or the cache
         # is stale.
 
         cl = repo.changelog
         filtername = repo.filtername
         bcache = self._per_filter.get(filtername)
         if bcache is None or not bcache.validfor(repo):
             # cache object missing or cache object stale? Read from disk
             bcache = branchcache.fromfile(repo)
 
         revs = []
         if bcache is None:
             # no (fresh) cache available anymore, perhaps we can re-use
             # the cache for a subset, then extend that to add info on missing
             # revisions.
             subsetname = subsettable.get(filtername)
             if subsetname is not None:
                 subset = repo.filtered(subsetname)
                 bcache = self[subset].copy()
                 extrarevs = subset.changelog.filteredrevs - cl.filteredrevs
                 revs.extend(r for r in extrarevs if r <= bcache.tiprev)
             else:
                 # nothing to fall back on, start empty.
                 bcache = branchcache(repo)
 
         revs.extend(cl.revs(start=bcache.tiprev + 1))
         if revs:
             bcache.update(repo, revs)
 
         assert bcache.validfor(repo), filtername
         self._per_filter[repo.filtername] = bcache
 
     def replace(self, repo, remotebranchmap):
         """Replace the branchmap cache for a repo with a branch mapping.
 
         This is likely only called during clone with a branch map from a
         remote.
 
         """
         cl = repo.changelog
         clrev = cl.rev
         clbranchinfo = cl.branchinfo
         rbheads = []
         closed = set()
         for bheads in remotebranchmap.values():
             rbheads += bheads
             for h in bheads:
                 r = clrev(h)
                 b, c = clbranchinfo(r)
                 if c:
                     closed.add(h)
 
         if rbheads:
             rtiprev = max((int(clrev(node)) for node in rbheads))
             cache = branchcache(
                 repo,
                 remotebranchmap,
                 repo[rtiprev].node(),
                 rtiprev,
                 closednodes=closed,
             )
 
             # Try to stick it as low as possible
             # filter above served are unlikely to be fetch from a clone
             for candidate in (b'base', b'immutable', b'served'):
                 rview = repo.filtered(candidate)
                 if cache.validfor(rview):
                     self._per_filter[candidate] = cache
                     cache.write(rview)
                     return
 
     def clear(self):
         self._per_filter.clear()
 
     def write_delayed(self, repo):
         unfi = repo.unfiltered()
         for filtername, cache in self._per_filter.items():
             if cache._delayed:
                 repo = unfi.filtered(filtername)
                 cache.write(repo)
 
 
 def _unknownnode(node):
     """raises ValueError when branchcache found a node which does not exists"""
     raise ValueError('node %s does not exist' % node.hex())
 
 
 def _branchcachedesc(repo):
     if repo.filtername is not None:
         return b'branch cache (%s)' % repo.filtername
     else:
         return b'branch cache'
 
 
 class branchcache:
     """A dict like object that hold branches heads cache.
 
     This cache is used to avoid costly computations to determine all the
     branch heads of a repo.
 
     The cache is serialized on disk in the following format:
 
     <tip hex node> <tip rev number> [optional filtered repo hex hash]
     <branch head hex node> <open/closed state> <branch name>
     <branch head hex node> <open/closed state> <branch name>
     ...
 
     The first line is used to check if the cache is still valid. If the
     branch cache is for a filtered repo view, an optional third hash is
     included that hashes the hashes of all filtered and obsolete revisions.
 
     The open/closed state is represented by a single letter 'o' or 'c'.
     This field can be used to avoid changelog reads when determining if a
     branch head closes a branch or not.
     """
 
     def __init__(
         self,
         repo,
         entries=(),
         tipnode=None,
         tiprev=nullrev,
         filteredhash=None,
         closednodes=None,
         hasnode=None,
     ):
         # type: (localrepo.localrepository, Union[Dict[bytes, List[bytes]], Iterable[Tuple[bytes, List[bytes]]]], bytes,  int, Optional[bytes], Optional[Set[bytes]], Optional[Callable[[bytes], bool]]) -> None
         """hasnode is a function which can be used to verify whether changelog
         has a given node or not. If it's not provided, we assume that every node
         we have exists in changelog"""
         self._repo = repo
         self._delayed = False
         if tipnode is None:
             self.tipnode = repo.nullid
         else:
             self.tipnode = tipnode
         self.tiprev = tiprev
         self.filteredhash = filteredhash
         # closednodes is a set of nodes that close their branch. If the branch
         # cache has been updated, it may contain nodes that are no longer
         # heads.
         if closednodes is None:
             self._closednodes = set()
         else:
             self._closednodes = closednodes
         self._entries = dict(entries)
         # whether closed nodes are verified or not
         self._closedverified = False
         # branches for which nodes are verified
         self._verifiedbranches = set()
         self._hasnode = hasnode
         if self._hasnode is None:
             self._hasnode = lambda x: True
 
     def _verifyclosed(self):
         """verify the closed nodes we have"""
         if self._closedverified:
             return
         for node in self._closednodes:
             if not self._hasnode(node):
                 _unknownnode(node)
 
         self._closedverified = True
 
     def _verifybranch(self, branch):
         """verify head nodes for the given branch."""
         if branch not in self._entries or branch in self._verifiedbranches:
             return
         for n in self._entries[branch]:
             if not self._hasnode(n):
                 _unknownnode(n)
 
         self._verifiedbranches.add(branch)
 
     def _verifyall(self):
         """verifies nodes of all the branches"""
         needverification = set(self._entries.keys()) - self._verifiedbranches
         for b in needverification:
             self._verifybranch(b)
 
     def __iter__(self):
         return iter(self._entries)
 
     def __setitem__(self, key, value):
         self._entries[key] = value
 
     def __getitem__(self, key):
         self._verifybranch(key)
         return self._entries[key]
 
     def __contains__(self, key):
         self._verifybranch(key)
         return key in self._entries
 
     def iteritems(self):
         for k, v in self._entries.items():
             self._verifybranch(k)
             yield k, v
 
     items = iteritems
 
     def hasbranch(self, label):
         """checks whether a branch of this name exists or not"""
         self._verifybranch(label)
         return label in self._entries
 
     @classmethod
     def fromfile(cls, repo):
         f = None
         try:
             f = repo.cachevfs(cls._filename(repo))
             lineiter = iter(f)
             cachekey = next(lineiter).rstrip(b'\n').split(b" ", 2)
             last, lrev = cachekey[:2]
             last, lrev = bin(last), int(lrev)
             filteredhash = None
             hasnode = repo.changelog.hasnode
             if len(cachekey) > 2:
                 filteredhash = bin(cachekey[2])
             bcache = cls(
                 repo,
                 tipnode=last,
                 tiprev=lrev,
                 filteredhash=filteredhash,
                 hasnode=hasnode,
             )
             if not bcache.validfor(repo):
                 # invalidate the cache
                 raise ValueError('tip differs')
             bcache.load(repo, lineiter)
         except (IOError, OSError):
             return None
 
         except Exception as inst:
             if repo.ui.debugflag:
                 msg = b'invalid %s: %s\n'
                 repo.ui.debug(
                     msg
                     % (
                         _branchcachedesc(repo),
                         stringutil.forcebytestr(inst),
                     )
                 )
             bcache = None
 
         finally:
             if f:
                 f.close()
 
         return bcache
 
     def load(self, repo, lineiter):
         """fully loads the branchcache by reading from the file using the line
         iterator passed"""
         for line in lineiter:
             line = line.rstrip(b'\n')
             if not line:
                 continue
             node, state, label = line.split(b" ", 2)
             if state not in b'oc':
                 raise ValueError('invalid branch state')
             label = encoding.tolocal(label.strip())
             node = bin(node)
             self._entries.setdefault(label, []).append(node)
             if state == b'c':
                 self._closednodes.add(node)
 
     @staticmethod
     def _filename(repo):
         """name of a branchcache file for a given repo or repoview"""
         filename = b"branch2"
         if repo.filtername:
             filename = b'%s-%s' % (filename, repo.filtername)
         return filename
 
     def validfor(self, repo):
         """check that cache contents are valid for (a subset of) this repo
 
         - False when the order of changesets changed or if we detect a strip.
         - True when cache is up-to-date for the current repo or its subset."""
         try:
             node = repo.changelog.node(self.tiprev)
         except IndexError:
             # changesets were stripped and now we don't even have enough to
             # find tiprev
             return False
         if self.tipnode != node:
             # tiprev doesn't correspond to tipnode: repo was stripped, or this
             # repo has a different order of changesets
             return False
         tiphash = scmutil.filteredhash(repo, self.tiprev, needobsolete=True)
         # hashes don't match if this repo view has a different set of filtered
         # revisions (e.g. due to phase changes) or obsolete revisions (e.g.
         # history was rewritten)
         return self.filteredhash == tiphash
 
     def _branchtip(self, heads):
         """Return tuple with last open head in heads and false,
         otherwise return last closed head and true."""
         tip = heads[-1]
         closed = True
         for h in reversed(heads):
             if h not in self._closednodes:
                 tip = h
                 closed = False
                 break
         return tip, closed
 
     def branchtip(self, branch):
         """Return the tipmost open head on branch head, otherwise return the
         tipmost closed head on branch.
         Raise KeyError for unknown branch."""
         return self._branchtip(self[branch])[0]
 
     def iteropen(self, nodes):
         return (n for n in nodes if n not in self._closednodes)
 
     def branchheads(self, branch, closed=False):
         self._verifybranch(branch)
         heads = self._entries[branch]
         if not closed:
             heads = list(self.iteropen(heads))
         return heads
 
     def iterbranches(self):
         for bn, heads in self.items():
             yield (bn, heads) + self._branchtip(heads)
 
     def iterheads(self):
         """returns all the heads"""
         self._verifyall()
         return self._entries.values()
 
     def copy(self):
         """return an deep copy of the branchcache object"""
         return type(self)(
             self._repo,
             self._entries,
             self.tipnode,
             self.tiprev,
             self.filteredhash,
             self._closednodes,
         )
 
     def write(self, repo):
         tr = repo.currenttransaction()
         if not getattr(tr, 'finalized', True):
             # Avoid premature writing.
             #
             # (The cache warming setup by localrepo will update the file later.)
             self._delayed = True
             return
         try:
             filename = self._filename(repo)
             with repo.cachevfs(filename, b"w", atomictemp=True) as f:
                 cachekey = [hex(self.tipnode), b'%d' % self.tiprev]
                 if self.filteredhash is not None:
                     cachekey.append(hex(self.filteredhash))
                 f.write(b" ".join(cachekey) + b'\n')
                 nodecount = 0
                 for label, nodes in sorted(self._entries.items()):
                     label = encoding.fromlocal(label)
                     for node in nodes:
                         nodecount += 1
                         if node in self._closednodes:
                             state = b'c'
                         else:
                             state = b'o'
                         f.write(b"%s %s %s\n" % (hex(node), state, label))
             repo.ui.log(
                 b'branchcache',
                 b'wrote %s with %d labels and %d nodes\n',
                 _branchcachedesc(repo),
                 len(self._entries),
                 nodecount,
             )
             self._delayed = False
         except (IOError, OSError, error.Abort) as inst:
             # Abort may be raised by read only opener, so log and continue
             repo.ui.debug(
                 b"couldn't write branch cache: %s\n"
                 % stringutil.forcebytestr(inst)
             )
 
     def update(self, repo, revgen):
         """Given a branchhead cache, self, that may have extra nodes or be
         missing heads, and a generator of nodes that are strictly a superset of
         heads missing, this function updates self to be correct.
         """
         starttime = util.timer()
         cl = repo.changelog
         # collect new branch entries
         newbranches = {}
         getbranchinfo = repo.revbranchcache().branchinfo
         for r in revgen:
             branch, closesbranch = getbranchinfo(r)
             newbranches.setdefault(branch, []).append(r)
             if closesbranch:
                 self._closednodes.add(cl.node(r))
 
         # new tip revision which we found after iterating items from new
         # branches
         ntiprev = self.tiprev
 
         # Delay fetching the topological heads until they are needed.
         # A repository without non-continous branches can skip this part.
         topoheads = None
 
         # If a changeset is visible, its parents must be visible too, so
         # use the faster unfiltered parent accessor.
         parentrevs = repo.unfiltered().changelog.parentrevs
 
         # Faster than using ctx.obsolete()
         obsrevs = obsolete.getrevs(repo, b'obsolete')
 
         for branch, newheadrevs in newbranches.items():
             # For every branch, compute the new branchheads.
             # A branchhead is a revision such that no descendant is on
             # the same branch.
             #
             # The branchheads are computed iteratively in revision order.
             # This ensures topological order, i.e. parents are processed
             # before their children. Ancestors are inclusive here, i.e.
             # any revision is an ancestor of itself.
             #
             # Core observations:
             # - The current revision is always a branchhead for the
             #   repository up to that point.
             # - It is the first revision of the branch if and only if
             #   there was no branchhead before. In that case, it is the
             #   only branchhead as there are no possible ancestors on
             #   the same branch.
             # - If a parent is on the same branch, a branchhead can
             #   only be an ancestor of that parent, if it is parent
             #   itself. Otherwise it would have been removed as ancestor
             #   of that parent before.
             # - Therefore, if all parents are on the same branch, they
             #   can just be removed from the branchhead set.
             # - If one parent is on the same branch and the other is not
             #   and there was exactly one branchhead known, the existing
             #   branchhead can only be an ancestor if it is the parent.
             #   Otherwise it would have been removed as ancestor of
             #   the parent before. The other parent therefore can't have
             #   a branchhead as ancestor.
             # - In all other cases, the parents on different branches
             #   could have a branchhead as ancestor. Those parents are
             #   kept in the "uncertain" set. If all branchheads are also
             #   topological heads, they can't have descendants and further
             #   checks can be skipped. Otherwise, the ancestors of the
             #   "uncertain" set are removed from branchheads.
             #   This computation is heavy and avoided if at all possible.
             bheads = self._entries.get(branch, [])
             bheadset = {cl.rev(node) for node in bheads}
             uncertain = set()
             for newrev in sorted(newheadrevs):
                 if newrev in obsrevs:
                     # We ignore obsolete changesets as they shouldn't be
                     # considered heads.
                     continue
 
                 if not bheadset:
                     bheadset.add(newrev)
                     continue
 
                 parents = [p for p in parentrevs(newrev) if p != nullrev]
                 samebranch = set()
                 otherbranch = set()
                 obsparents = set()
                 for p in parents:
                     if p in obsrevs:
                         # We ignored this obsolete changeset earlier, but now
                         # that it has non-ignored children, we need to make
                         # sure their ancestors are not considered heads. To
                         # achieve that, we will simply treat this obsolete
                         # changeset as a parent from other branch.
                         obsparents.add(p)
                     elif p in bheadset or getbranchinfo(p)[0] == branch:
                         samebranch.add(p)
                     else:
                         otherbranch.add(p)
                 if not (len(bheadset) == len(samebranch) == 1):
                     uncertain.update(otherbranch)
                     uncertain.update(obsparents)
                 bheadset.difference_update(samebranch)
                 bheadset.add(newrev)
 
             if uncertain:
                 if topoheads is None:
                     topoheads = set(cl.headrevs())
                 if bheadset - topoheads:
                     floorrev = min(bheadset)
                     if floorrev <= max(uncertain):
                         ancestors = set(cl.ancestors(uncertain, floorrev))
                         bheadset -= ancestors
             if bheadset:
                 self[branch] = [cl.node(rev) for rev in sorted(bheadset)]
             tiprev = max(newheadrevs)
             if tiprev > ntiprev:
                 ntiprev = tiprev
 
         if ntiprev > self.tiprev:
             self.tiprev = ntiprev
             self.tipnode = cl.node(ntiprev)
 
         if not self.validfor(repo):
             # old cache key is now invalid for the repo, but we've just updated
             # the cache and we assume it's valid, so let's make the cache key
             # valid as well by recomputing it from the cached data
             self.tipnode = repo.nullid
             self.tiprev = nullrev
             for heads in self.iterheads():
                 if not heads:
                     # all revisions on a branch are obsolete
                     continue
                 # note: tiprev is not necessarily the tip revision of repo,
                 # because the tip could be obsolete (i.e. not a head)
                 tiprev = max(cl.rev(node) for node in heads)
                 if tiprev > self.tiprev:
                     self.tipnode = cl.node(tiprev)
                     self.tiprev = tiprev
         self.filteredhash = scmutil.filteredhash(
             repo, self.tiprev, needobsolete=True
         )
 
         duration = util.timer() - starttime
         repo.ui.log(
             b'branchcache',
             b'updated %s in %.4f seconds\n',
             _branchcachedesc(repo),
             duration,
         )
 
         self.write(repo)
 
 
 class remotebranchcache(branchcache):
     """Branchmap info for a remote connection, should not write locally"""
 
     def write(self, repo):
         pass
 
 
 # Revision branch info cache
 
 _rbcversion = b'-v1'
 _rbcnames = b'rbc-names' + _rbcversion
 _rbcrevs = b'rbc-revs' + _rbcversion
 # [4 byte hash prefix][4 byte branch name number with sign bit indicating open]
 _rbcrecfmt = b'>4sI'
 _rbcrecsize = calcsize(_rbcrecfmt)
 _rbcmininc = 64 * _rbcrecsize
 _rbcnodelen = 4
 _rbcbranchidxmask = 0x7FFFFFFF
 _rbccloseflag = 0x80000000
 
 
 class revbranchcache:
     """Persistent cache, mapping from revision number to branch name and close.
     This is a low level cache, independent of filtering.
 
     Branch names are stored in rbc-names in internal encoding separated by 0.
     rbc-names is append-only, and each branch name is only stored once and will
     thus have a unique index.
 
     The branch info for each revision is stored in rbc-revs as constant size
     records. The whole file is read into memory, but it is only 'parsed' on
     demand. The file is usually append-only but will be truncated if repo
     modification is detected.
     The record for each revision contains the first 4 bytes of the
     corresponding node hash, and the record is only used if it still matches.
     Even a completely trashed rbc-revs fill thus still give the right result
     while converging towards full recovery ... assuming no incorrectly matching
     node hashes.
     The record also contains 4 bytes where 31 bits contains the index of the
     branch and the last bit indicate that it is a branch close commit.
     The usage pattern for rbc-revs is thus somewhat similar to 00changelog.i
     and will grow with it but be 1/8th of its size.
     """
 
     def __init__(self, repo, readonly=True):
         assert repo.filtername is None
         self._repo = repo
         self._names = []  # branch names in local encoding with static index
         self._rbcrevs = bytearray()
         self._rbcsnameslen = 0  # length of names read at _rbcsnameslen
         try:
             bndata = repo.cachevfs.read(_rbcnames)
             self._rbcsnameslen = len(bndata)  # for verification before writing
             if bndata:
                 self._names = [
                     encoding.tolocal(bn) for bn in bndata.split(b'\0')
                 ]
         except (IOError, OSError):
             if readonly:
                 # don't try to use cache - fall back to the slow path
                 self.branchinfo = self._branchinfo
 
         if self._names:
             try:
                 data = repo.cachevfs.read(_rbcrevs)
                 self._rbcrevs[:] = data
             except (IOError, OSError) as inst:
                 repo.ui.debug(
                     b"couldn't read revision branch cache: %s\n"
                     % stringutil.forcebytestr(inst)
                 )
         # remember number of good records on disk
         self._rbcrevslen = min(
             len(self._rbcrevs) // _rbcrecsize, len(repo.changelog)
         )
         if self._rbcrevslen == 0:
             self._names = []
         self._rbcnamescount = len(self._names)  # number of names read at
         # _rbcsnameslen
 
     def _clear(self):
         self._rbcsnameslen = 0
         del self._names[:]
         self._rbcnamescount = 0
         self._rbcrevslen = len(self._repo.changelog)
         self._rbcrevs = bytearray(self._rbcrevslen * _rbcrecsize)
         util.clearcachedproperty(self, b'_namesreverse')
 
     @util.propertycache
     def _namesreverse(self):
         return {b: r for r, b in enumerate(self._names)}
 
     def branchinfo(self, rev):
         """Return branch name and close flag for rev, using and updating
         persistent cache."""
         changelog = self._repo.changelog
         rbcrevidx = rev * _rbcrecsize
 
         # avoid negative index, changelog.read(nullrev) is fast without cache
         if rev == nullrev:
             return changelog.branchinfo(rev)
 
         # if requested rev isn't allocated, grow and cache the rev info
         if len(self._rbcrevs) < rbcrevidx + _rbcrecsize:
             return self._branchinfo(rev)
 
         # fast path: extract data from cache, use it if node is matching
         reponode = changelog.node(rev)[:_rbcnodelen]
         cachenode, branchidx = unpack_from(
             _rbcrecfmt, util.buffer(self._rbcrevs), rbcrevidx
         )
         close = bool(branchidx & _rbccloseflag)
         if close:
             branchidx &= _rbcbranchidxmask
         if cachenode == b'\0\0\0\0':
             pass
         elif cachenode == reponode:
             try:
                 return self._names[branchidx], close
             except IndexError:
                 # recover from invalid reference to unknown branch
                 self._repo.ui.debug(
                     b"referenced branch names not found"
                     b" - rebuilding revision branch cache from scratch\n"
                 )
                 self._clear()
         else:
             # rev/node map has changed, invalidate the cache from here up
             self._repo.ui.debug(
                 b"history modification detected - truncating "
                 b"revision branch cache to revision %d\n" % rev
             )
             truncate = rbcrevidx + _rbcrecsize
             del self._rbcrevs[truncate:]
             self._rbcrevslen = min(self._rbcrevslen, truncate)
 
         # fall back to slow path and make sure it will be written to disk
         return self._branchinfo(rev)
 
     def _branchinfo(self, rev):
         """Retrieve branch info from changelog and update _rbcrevs"""
         changelog = self._repo.changelog
         b, close = changelog.branchinfo(rev)
         if b in self._namesreverse:
             branchidx = self._namesreverse[b]
         else:
             branchidx = len(self._names)
             self._names.append(b)
             self._namesreverse[b] = branchidx
         reponode = changelog.node(rev)
         if close:
             branchidx |= _rbccloseflag
         self._setcachedata(rev, reponode, branchidx)
         return b, close
 
     def setdata(self, rev, changelogrevision):
         """add new data information to the cache"""
         branch, close = changelogrevision.branchinfo
 
         if branch in self._namesreverse:
             branchidx = self._namesreverse[branch]
         else:
             branchidx = len(self._names)
             self._names.append(branch)
             self._namesreverse[branch] = branchidx
         if close:
             branchidx |= _rbccloseflag
         self._setcachedata(rev, self._repo.changelog.node(rev), branchidx)
         # If no cache data were readable (non exists, bad permission, etc)
         # the cache was bypassing itself by setting:
         #
         #   self.branchinfo = self._branchinfo
         #
         # Since we now have data in the cache, we need to drop this bypassing.
         if 'branchinfo' in vars(self):
             del self.branchinfo
 
     def _setcachedata(self, rev, node, branchidx):
         """Writes the node's branch data to the in-memory cache data."""
         if rev == nullrev:
             return
         rbcrevidx = rev * _rbcrecsize
         requiredsize = rbcrevidx + _rbcrecsize
         rbccur = len(self._rbcrevs)
         if rbccur < requiredsize:
             # bytearray doesn't allocate extra space at least in Python 3.7.
             # When multiple changesets are added in a row, precise resize would
             # result in quadratic complexity. Overallocate to compensate by
             # use the classic doubling technique for dynamic arrays instead.
             # If there was a gap in the map before, less space will be reserved.
             self._rbcrevs.extend(b'\0' * max(_rbcmininc, requiredsize))
         pack_into(_rbcrecfmt, self._rbcrevs, rbcrevidx, node, branchidx)
         self._rbcrevslen = min(self._rbcrevslen, rev)
 
         tr = self._repo.currenttransaction()
         if tr:
             tr.addfinalize(b'write-revbranchcache', self.write)
 
     def write(self, tr=None):
         """Save branch cache if it is dirty."""
         repo = self._repo
         wlock = None
         step = b''
         try:
             # write the new names
             if self._rbcnamescount < len(self._names):
                 wlock = repo.wlock(wait=False)
                 step = b' names'
                 self._writenames(repo)
 
             # write the new revs
             start = self._rbcrevslen * _rbcrecsize
             if start != len(self._rbcrevs):
                 step = b''
                 if wlock is None:
                     wlock = repo.wlock(wait=False)
                 self._writerevs(repo, start)
 
         except (IOError, OSError, error.Abort, error.LockError) as inst:
             repo.ui.debug(
                 b"couldn't write revision branch cache%s: %s\n"
                 % (step, stringutil.forcebytestr(inst))
             )
         finally:
             if wlock is not None:
                 wlock.release()
 
     def _writenames(self, repo):
         """write the new branch names to revbranchcache"""
         if self._rbcnamescount != 0:
             f = repo.cachevfs.open(_rbcnames, b'ab')
             if f.tell() == self._rbcsnameslen:
                 f.write(b'\0')
             else:
                 f.close()
                 repo.ui.debug(b"%s changed - rewriting it\n" % _rbcnames)
                 self._rbcnamescount = 0
                 self._rbcrevslen = 0
         if self._rbcnamescount == 0:
             # before rewriting names, make sure references are removed
             repo.cachevfs.unlinkpath(_rbcrevs, ignoremissing=True)
             f = repo.cachevfs.open(_rbcnames, b'wb')
         f.write(
             b'\0'.join(
                 encoding.fromlocal(b)
                 for b in self._names[self._rbcnamescount :]
             )
         )
         self._rbcsnameslen = f.tell()
         f.close()
         self._rbcnamescount = len(self._names)
 
     def _writerevs(self, repo, start):
         """write the new revs to revbranchcache"""
         revs = min(len(repo.changelog), len(self._rbcrevs) // _rbcrecsize)
         with repo.cachevfs.open(_rbcrevs, b'ab') as f:
             if f.tell() != start:
                 repo.ui.debug(
                     b"truncating cache/%s to %d\n" % (_rbcrevs, start)
                 )
                 f.seek(start)
                 if f.tell() != start:
                     start = 0
                     f.seek(start)
                 f.truncate()
             end = revs * _rbcrecsize
             f.write(self._rbcrevs[start:end])
         self._rbcrevslen = revs

mercurial/cmdutil.py

@@ -1,4134 +1,4135 b''
 # cmdutil.py - help for command processing in mercurial
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import copy as copymod
 import errno
 import functools
 import os
 import re
 
 from typing import (
     Any,
     AnyStr,
     Dict,
     Iterable,
     Optional,
+    TYPE_CHECKING,
     cast,
 )
 
 from .i18n import _
 from .node import (
     hex,
     nullrev,
     short,
 )
 from .pycompat import (
     open,
 )
 from .thirdparty import attr
 
 from . import (
     bookmarks,
     changelog,
     copies,
     crecord as crecordmod,
     encoding,
     error,
     formatter,
     logcmdutil,
     match as matchmod,
     merge as mergemod,
     mergestate as mergestatemod,
     mergeutil,
     obsolete,
     patch,
     pathutil,
     phases,
     pycompat,
     repair,
     revlog,
     rewriteutil,
     scmutil,
     state as statemod,
     subrepoutil,
     templatekw,
     templater,
     util,
     vfs as vfsmod,
 )
 
 from .utils import (
     dateutil,
     stringutil,
 )
 
 from .revlogutils import (
     constants as revlog_constants,
 )
 
-if pycompat.TYPE_CHECKING:
+if TYPE_CHECKING:
     from . import (
         ui as uimod,
     )
 
 stringio = util.stringio
 
 # templates of common command options
 
 dryrunopts = [
     (b'n', b'dry-run', None, _(b'do not perform actions, just print output')),
 ]
 
 confirmopts = [
     (b'', b'confirm', None, _(b'ask before applying actions')),
 ]
 
 remoteopts = [
     (b'e', b'ssh', b'', _(b'specify ssh command to use'), _(b'CMD')),
     (
         b'',
         b'remotecmd',
         b'',
         _(b'specify hg command to run on the remote side'),
         _(b'CMD'),
     ),
     (
         b'',
         b'insecure',
         None,
         _(b'do not verify server certificate (ignoring web.cacerts config)'),
     ),
 ]
 
 walkopts = [
     (
         b'I',
         b'include',
         [],
         _(b'include names matching the given patterns'),
         _(b'PATTERN'),
     ),
     (
         b'X',
         b'exclude',
         [],
         _(b'exclude names matching the given patterns'),
         _(b'PATTERN'),
     ),
 ]
 
 commitopts = [
     (b'm', b'message', b'', _(b'use text as commit message'), _(b'TEXT')),
     (b'l', b'logfile', b'', _(b'read commit message from file'), _(b'FILE')),
 ]
 
 commitopts2 = [
     (
         b'd',
         b'date',
         b'',
         _(b'record the specified date as commit date'),
         _(b'DATE'),
     ),
     (
         b'u',
         b'user',
         b'',
         _(b'record the specified user as committer'),
         _(b'USER'),
     ),
 ]
 
 commitopts3 = [
     (b'D', b'currentdate', None, _(b'record the current date as commit date')),
     (b'U', b'currentuser', None, _(b'record the current user as committer')),
 ]
 
 formatteropts = [
     (b'T', b'template', b'', _(b'display with template'), _(b'TEMPLATE')),
 ]
 
 templateopts = [
     (
         b'',
         b'style',
         b'',
         _(b'display using template map file (DEPRECATED)'),
         _(b'STYLE'),
     ),
     (b'T', b'template', b'', _(b'display with template'), _(b'TEMPLATE')),
 ]
 
 logopts = [
     (b'p', b'patch', None, _(b'show patch')),
     (b'g', b'git', None, _(b'use git extended diff format')),
     (b'l', b'limit', b'', _(b'limit number of changes displayed'), _(b'NUM')),
     (b'M', b'no-merges', None, _(b'do not show merges')),
     (b'', b'stat', None, _(b'output diffstat-style summary of changes')),
     (b'G', b'graph', None, _(b"show the revision DAG")),
 ] + templateopts
 
 diffopts = [
     (b'a', b'text', None, _(b'treat all files as text')),
     (
         b'g',
         b'git',
         None,
         _(b'use git extended diff format (DEFAULT: diff.git)'),
     ),
     (b'', b'binary', None, _(b'generate binary diffs in git mode (default)')),
     (b'', b'nodates', None, _(b'omit dates from diff headers')),
 ]
 
 diffwsopts = [
     (
         b'w',
         b'ignore-all-space',
         None,
         _(b'ignore white space when comparing lines'),
     ),
     (
         b'b',
         b'ignore-space-change',
         None,
         _(b'ignore changes in the amount of white space'),
     ),
     (
         b'B',
         b'ignore-blank-lines',
         None,
         _(b'ignore changes whose lines are all blank'),
     ),
     (
         b'Z',
         b'ignore-space-at-eol',
         None,
         _(b'ignore changes in whitespace at EOL'),
     ),
 ]
 
 diffopts2 = (
     [
         (b'', b'noprefix', None, _(b'omit a/ and b/ prefixes from filenames')),
         (
             b'p',
             b'show-function',
             None,
             _(
                 b'show which function each change is in (DEFAULT: diff.showfunc)'
             ),
         ),
         (b'', b'reverse', None, _(b'produce a diff that undoes the changes')),
     ]
     + diffwsopts
     + [
         (
             b'U',
             b'unified',
             b'',
             _(b'number of lines of context to show'),
             _(b'NUM'),
         ),
         (b'', b'stat', None, _(b'output diffstat-style summary of changes')),
         (
             b'',
             b'root',
             b'',
             _(b'produce diffs relative to subdirectory'),
             _(b'DIR'),
         ),
     ]
 )
 
 mergetoolopts = [
     (b't', b'tool', b'', _(b'specify merge tool'), _(b'TOOL')),
 ]
 
 similarityopts = [
     (
         b's',
         b'similarity',
         b'',
         _(b'guess renamed files by similarity (0<=s<=100)'),
         _(b'SIMILARITY'),
     )
 ]
 
 subrepoopts = [(b'S', b'subrepos', None, _(b'recurse into subrepositories'))]
 
 debugrevlogopts = [
     (b'c', b'changelog', False, _(b'open changelog')),
     (b'm', b'manifest', False, _(b'open manifest')),
     (b'', b'dir', b'', _(b'open directory manifest')),
 ]
 
 # special string such that everything below this line will be ingored in the
 # editor text
 _linebelow = b"^HG: ------------------------ >8 ------------------------$"
 
 
 def check_at_most_one_arg(
     opts: Dict[AnyStr, Any],
     *args: AnyStr,
 ) -> Optional[AnyStr]:
     """abort if more than one of the arguments are in opts
 
     Returns the unique argument or None if none of them were specified.
     """
 
     def to_display(name: AnyStr) -> bytes:
         return pycompat.sysbytes(name).replace(b'_', b'-')
 
     previous = None
     for x in args:
         if opts.get(x):
             if previous:
                 raise error.InputError(
                     _(b'cannot specify both --%s and --%s')
                     % (to_display(previous), to_display(x))
                 )
             previous = x
     return previous
 
 
 def check_incompatible_arguments(
     opts: Dict[AnyStr, Any],
     first: AnyStr,
     others: Iterable[AnyStr],
 ) -> None:
     """abort if the first argument is given along with any of the others
 
     Unlike check_at_most_one_arg(), `others` are not mutually exclusive
     among themselves, and they're passed as a single collection.
     """
     for other in others:
         check_at_most_one_arg(opts, first, other)
 
 
 def resolve_commit_options(ui: "uimod.ui", opts: Dict[str, Any]) -> bool:
     """modify commit options dict to handle related options
 
     The return value indicates that ``rewrite.update-timestamp`` is the reason
     the ``date`` option is set.
     """
     check_at_most_one_arg(opts, 'date', 'currentdate')
     check_at_most_one_arg(opts, 'user', 'currentuser')
 
     datemaydiffer = False  # date-only change should be ignored?
 
     if opts.get('currentdate'):
         opts['date'] = b'%d %d' % dateutil.makedate()
     elif (
         not opts.get('date')
         and ui.configbool(b'rewrite', b'update-timestamp')
         and opts.get('currentdate') is None
     ):
         opts['date'] = b'%d %d' % dateutil.makedate()
         datemaydiffer = True
 
     if opts.get('currentuser'):
         opts['user'] = ui.username()
 
     return datemaydiffer
 
 
 def check_note_size(opts: Dict[str, Any]) -> None:
     """make sure note is of valid format"""
 
     note = opts.get('note')
     if not note:
         return
 
     if len(note) > 255:
         raise error.InputError(_(b"cannot store a note of more than 255 bytes"))
     if b'\n' in note:
         raise error.InputError(_(b"note cannot contain a newline"))
 
 
 def ishunk(x):
     hunkclasses = (crecordmod.uihunk, patch.recordhunk)
     return isinstance(x, hunkclasses)
 
 
 def isheader(x):
     headerclasses = (crecordmod.uiheader, patch.header)
     return isinstance(x, headerclasses)
 
 
 def newandmodified(chunks):
     newlyaddedandmodifiedfiles = set()
     alsorestore = set()
     for chunk in chunks:
         if isheader(chunk) and chunk.isnewfile():
             newlyaddedandmodifiedfiles.add(chunk.filename())
             alsorestore.update(set(chunk.files()) - {chunk.filename()})
     return newlyaddedandmodifiedfiles, alsorestore
 
 
 def parsealiases(cmd):
     base_aliases = cmd.split(b"|")
     all_aliases = set(base_aliases)
     extra_aliases = []
     for alias in base_aliases:
         if b'-' in alias:
             folded_alias = alias.replace(b'-', b'')
             if folded_alias not in all_aliases:
                 all_aliases.add(folded_alias)
                 extra_aliases.append(folded_alias)
     base_aliases.extend(extra_aliases)
     return base_aliases
 
 
 def setupwrapcolorwrite(ui):
     # wrap ui.write so diff output can be labeled/colorized
     def wrapwrite(orig, *args, **kw):
         label = kw.pop('label', b'')
         for chunk, l in patch.difflabel(lambda: args):
             orig(chunk, label=label + l)
 
     oldwrite = ui.write
 
     def wrap(*args, **kwargs):
         return wrapwrite(oldwrite, *args, **kwargs)
 
     setattr(ui, 'write', wrap)
     return oldwrite
 
 
 def filterchunks(ui, originalhunks, usecurses, testfile, match, operation=None):
     try:
         if usecurses:
             if testfile:
                 recordfn = crecordmod.testdecorator(
                     testfile, crecordmod.testchunkselector
                 )
             else:
                 recordfn = crecordmod.chunkselector
 
             return crecordmod.filterpatch(
                 ui, originalhunks, recordfn, operation
             )
     except crecordmod.fallbackerror as e:
         ui.warn(b'%s\n' % e)
         ui.warn(_(b'falling back to text mode\n'))
 
     return patch.filterpatch(ui, originalhunks, match, operation)
 
 
 def recordfilter(ui, originalhunks, match, operation=None):
     """Prompts the user to filter the originalhunks and return a list of
     selected hunks.
     *operation* is used for to build ui messages to indicate the user what
     kind of filtering they are doing: reverting, committing, shelving, etc.
     (see patch.filterpatch).
     """
     usecurses = crecordmod.checkcurses(ui)
     testfile = ui.config(b'experimental', b'crecordtest')
     oldwrite = setupwrapcolorwrite(ui)
     try:
         newchunks, newopts = filterchunks(
             ui, originalhunks, usecurses, testfile, match, operation
         )
     finally:
         ui.write = oldwrite
     return newchunks, newopts
 
 
 def _record(
     ui,
     repo,
     message,
     match,
     opts,
     commitfunc,
     backupall,
     filterfn,
     pats,
 ):
     """This is generic record driver.
 
     Its job is to interactively filter local changes, and
     accordingly prepare working directory into a state in which the
     job can be delegated to a non-interactive commit command such as
     'commit' or 'qrefresh'.
 
     After the actual job is done by non-interactive command, the
     working directory is restored to its original state.
 
     In the end we'll record interesting changes, and everything else
     will be left in place, so the user can continue working.
     """
     assert repo.currentwlock() is not None
     if not opts.get(b'interactive-unshelve'):
         checkunfinished(repo, commit=True)
     wctx = repo[None]
     merge = len(wctx.parents()) > 1
     if merge:
         raise error.InputError(
             _(b'cannot partially commit a merge ' b'(use "hg commit" instead)')
         )
 
     def fail(f, msg):
         raise error.InputError(b'%s: %s' % (f, msg))
 
     force = opts.get(b'force')
     if not force:
         match = matchmod.badmatch(match, fail)
 
     status = repo.status(match=match)
 
     overrides = {(b'ui', b'commitsubrepos'): True}
 
     with repo.ui.configoverride(overrides, b'record'):
         # subrepoutil.precommit() modifies the status
         tmpstatus = scmutil.status(
             copymod.copy(status.modified),
             copymod.copy(status.added),
             copymod.copy(status.removed),
             copymod.copy(status.deleted),
             copymod.copy(status.unknown),
             copymod.copy(status.ignored),
             copymod.copy(status.clean),  # pytype: disable=wrong-arg-count
         )
 
         # Force allows -X subrepo to skip the subrepo.
         subs, commitsubs, newstate = subrepoutil.precommit(
             repo.ui, wctx, tmpstatus, match, force=True
         )
         for s in subs:
             if s in commitsubs:
                 dirtyreason = wctx.sub(s).dirtyreason(True)
                 raise error.Abort(dirtyreason)
 
     if not force:
         repo.checkcommitpatterns(wctx, match, status, fail)
     diffopts = patch.difffeatureopts(
         ui,
         opts=opts,
         whitespace=True,
         section=b'commands',
         configprefix=b'commit.interactive.',
     )
     diffopts.nodates = True
     diffopts.git = True
     diffopts.showfunc = True
     originaldiff = patch.diff(repo, changes=status, opts=diffopts)
     original_headers = patch.parsepatch(originaldiff)
     match = scmutil.match(repo[None], pats)
 
     # 1. filter patch, since we are intending to apply subset of it
     try:
         chunks, newopts = filterfn(ui, original_headers, match)
     except error.PatchParseError as err:
         raise error.InputError(_(b'error parsing patch: %s') % err)
     except error.PatchApplicationError as err:
         raise error.StateError(_(b'error applying patch: %s') % err)
     opts.update(newopts)
 
     # We need to keep a backup of files that have been newly added and
     # modified during the recording process because there is a previous
     # version without the edit in the workdir. We also will need to restore
     # files that were the sources of renames so that the patch application
     # works.
     newlyaddedandmodifiedfiles, alsorestore = newandmodified(chunks)
     contenders = set()
     for h in chunks:
         if isheader(h):
             contenders.update(set(h.files()))
 
     changed = status.modified + status.added + status.removed
     newfiles = [f for f in changed if f in contenders]
     if not newfiles:
         ui.status(_(b'no changes to record\n'))
         return 0
 
     modified = set(status.modified)
 
     # 2. backup changed files, so we can restore them in the end
 
     if backupall:
         tobackup = changed
     else:
         tobackup = [
             f
             for f in newfiles
             if f in modified or f in newlyaddedandmodifiedfiles
         ]
     backups = {}
     if tobackup:
         backupdir = repo.vfs.join(b'record-backups')
         try:
             os.mkdir(backupdir)
         except FileExistsError:
             pass
     try:
         # backup continues
         for f in tobackup:
             fd, tmpname = pycompat.mkstemp(
                 prefix=os.path.basename(f) + b'.', dir=backupdir
             )
             os.close(fd)
             ui.debug(b'backup %r as %r\n' % (f, tmpname))
             util.copyfile(repo.wjoin(f), tmpname, copystat=True)
             backups[f] = tmpname
 
         fp = stringio()
         for c in chunks:
             fname = c.filename()
             if fname in backups:
                 c.write(fp)
         dopatch = fp.tell()
         fp.seek(0)
 
         # 2.5 optionally review / modify patch in text editor
         if opts.get(b'review', False):
             patchtext = (
                 crecordmod.diffhelptext + crecordmod.patchhelptext + fp.read()
             )
             reviewedpatch = ui.edit(
                 patchtext, b"", action=b"diff", repopath=repo.path
             )
             fp.truncate(0)
             fp.write(reviewedpatch)
             fp.seek(0)
 
         [os.unlink(repo.wjoin(c)) for c in newlyaddedandmodifiedfiles]
         # 3a. apply filtered patch to clean repo  (clean)
         if backups:
             m = scmutil.matchfiles(repo, set(backups.keys()) | alsorestore)
             mergemod.revert_to(repo[b'.'], matcher=m)
 
         # 3b. (apply)
         if dopatch:
             try:
                 ui.debug(b'applying patch\n')
                 ui.debug(fp.getvalue())
                 patch.internalpatch(ui, repo, fp, 1, eolmode=None)
             except error.PatchParseError as err:
                 raise error.InputError(pycompat.bytestr(err))
             except error.PatchApplicationError as err:
                 raise error.StateError(pycompat.bytestr(err))
         del fp
 
         # 4. We prepared working directory according to filtered
         #    patch. Now is the time to delegate the job to
         #    commit/qrefresh or the like!
 
         # Make all of the pathnames absolute.
         newfiles = [repo.wjoin(nf) for nf in newfiles]
         return commitfunc(ui, repo, *newfiles, **pycompat.strkwargs(opts))
     finally:
         # 5. finally restore backed-up files
         try:
             dirstate = repo.dirstate
             for realname, tmpname in backups.items():
                 ui.debug(b'restoring %r to %r\n' % (tmpname, realname))
 
                 if dirstate.get_entry(realname).maybe_clean:
                     # without normallookup, restoring timestamp
                     # may cause partially committed files
                     # to be treated as unmodified
 
                     # XXX-PENDINGCHANGE: We should clarify the context in
                     # which this function is called  to make sure it
                     # already called within a `pendingchange`, However we
                     # are taking a shortcut here in order to be able to
                     # quickly deprecated the older API.
                     with dirstate.changing_parents(repo):
                         dirstate.update_file(
                             realname,
                             p1_tracked=True,
                             wc_tracked=True,
                             possibly_dirty=True,
                         )
 
                 # copystat=True here and above are a hack to trick any
                 # editors that have f open that we haven't modified them.
                 #
                 # Also note that this racy as an editor could notice the
                 # file's mtime before we've finished writing it.
                 util.copyfile(tmpname, repo.wjoin(realname), copystat=True)
                 os.unlink(tmpname)
             if tobackup:
                 os.rmdir(backupdir)
         except OSError:
             pass
 
 
 def dorecord(
     ui, repo, commitfunc, cmdsuggest, backupall, filterfn, *pats, **opts
 ):
     opts = pycompat.byteskwargs(opts)
     if not ui.interactive():
         if cmdsuggest:
             msg = _(b'running non-interactively, use %s instead') % cmdsuggest
         else:
             msg = _(b'running non-interactively')
         raise error.InputError(msg)
 
     # make sure username is set before going interactive
     if not opts.get(b'user'):
         ui.username()  # raise exception, username not provided
 
     func = functools.partial(
         _record,
         commitfunc=commitfunc,
         backupall=backupall,
         filterfn=filterfn,
         pats=pats,
     )
 
     return commit(ui, repo, func, pats, opts)
 
 
 class dirnode:
     """
     Represent a directory in user working copy with information required for
     the purpose of tersing its status.
 
     path is the path to the directory, without a trailing '/'
 
     statuses is a set of statuses of all files in this directory (this includes
     all the files in all the subdirectories too)
 
     files is a list of files which are direct child of this directory
 
     subdirs is a dictionary of sub-directory name as the key and it's own
     dirnode object as the value
     """
 
     def __init__(self, dirpath):
         self.path = dirpath
         self.statuses = set()
         self.files = []
         self.subdirs = {}
 
     def _addfileindir(self, filename, status):
         """Add a file in this directory as a direct child."""
         self.files.append((filename, status))
 
     def addfile(self, filename, status):
         """
         Add a file to this directory or to its direct parent directory.
 
         If the file is not direct child of this directory, we traverse to the
         directory of which this file is a direct child of and add the file
         there.
         """
 
         # the filename contains a path separator, it means it's not the direct
         # child of this directory
         if b'/' in filename:
             subdir, filep = filename.split(b'/', 1)
 
             # does the dirnode object for subdir exists
             if subdir not in self.subdirs:
                 subdirpath = pathutil.join(self.path, subdir)
                 self.subdirs[subdir] = dirnode(subdirpath)
 
             # try adding the file in subdir
             self.subdirs[subdir].addfile(filep, status)
 
         else:
             self._addfileindir(filename, status)
 
         if status not in self.statuses:
             self.statuses.add(status)
 
     def iterfilepaths(self):
         """Yield (status, path) for files directly under this directory."""
         for f, st in self.files:
             yield st, pathutil.join(self.path, f)
 
     def tersewalk(self, terseargs):
         """
         Yield (status, path) obtained by processing the status of this
         dirnode.
 
         terseargs is the string of arguments passed by the user with `--terse`
         flag.
 
         Following are the cases which can happen:
 
         1) All the files in the directory (including all the files in its
         subdirectories) share the same status and the user has asked us to terse
         that status. -> yield (status, dirpath).  dirpath will end in '/'.
 
         2) Otherwise, we do following:
 
                 a) Yield (status, filepath)  for all the files which are in this
                     directory (only the ones in this directory, not the subdirs)
 
                 b) Recurse the function on all the subdirectories of this
                    directory
         """
 
         if len(self.statuses) == 1:
             onlyst = self.statuses.pop()
 
             # Making sure we terse only when the status abbreviation is
             # passed as terse argument
             if onlyst in terseargs:
                 yield onlyst, self.path + b'/'
                 return
 
         # add the files to status list
         for st, fpath in self.iterfilepaths():
             yield st, fpath
 
         # recurse on the subdirs
         for dirobj in self.subdirs.values():
             for st, fpath in dirobj.tersewalk(terseargs):
                 yield st, fpath
 
 
 def tersedir(statuslist, terseargs):
     """
     Terse the status if all the files in a directory shares the same status.
 
     statuslist is scmutil.status() object which contains a list of files for
     each status.
     terseargs is string which is passed by the user as the argument to `--terse`
     flag.
 
     The function makes a tree of objects of dirnode class, and at each node it
     stores the information required to know whether we can terse a certain
     directory or not.
     """
     # the order matters here as that is used to produce final list
     allst = (b'm', b'a', b'r', b'd', b'u', b'i', b'c')
 
     # checking the argument validity
     for s in pycompat.bytestr(terseargs):
         if s not in allst:
             raise error.InputError(_(b"'%s' not recognized") % s)
 
     # creating a dirnode object for the root of the repo
     rootobj = dirnode(b'')
     pstatus = (
         ('modified', b'm'),
         ('added', b'a'),
         ('deleted', b'd'),
         ('clean', b'c'),
         ('unknown', b'u'),
         ('ignored', b'i'),
         ('removed', b'r'),
     )
 
     tersedict = {}
     for attrname, statuschar in pstatus:
         for f in getattr(statuslist, attrname):
             rootobj.addfile(f, statuschar)
         tersedict[statuschar] = []
 
     # we won't be tersing the root dir, so add files in it
     for st, fpath in rootobj.iterfilepaths():
         tersedict[st].append(fpath)
 
     # process each sub-directory and build tersedict
     for subdir in rootobj.subdirs.values():
         for st, f in subdir.tersewalk(terseargs):
             tersedict[st].append(f)
 
     tersedlist = []
     for st in allst:
         tersedict[st].sort()
         tersedlist.append(tersedict[st])
 
     return scmutil.status(*tersedlist)
 
 
 def _commentlines(raw):
     '''Surround lineswith a comment char and a new line'''
     lines = raw.splitlines()
     commentedlines = [b'# %s' % line for line in lines]
     return b'\n'.join(commentedlines) + b'\n'
 
 
 @attr.s(frozen=True)
 class morestatus:
     repo = attr.ib()
     unfinishedop = attr.ib()
     unfinishedmsg = attr.ib()
     activemerge = attr.ib()
     unresolvedpaths = attr.ib()
     _formattedpaths = attr.ib(init=False, default=set())
     _label = b'status.morestatus'
 
     def formatfile(self, path, fm):
         self._formattedpaths.add(path)
         if self.activemerge and path in self.unresolvedpaths:
             fm.data(unresolved=True)
 
     def formatfooter(self, fm):
         if self.unfinishedop or self.unfinishedmsg:
             fm.startitem()
             fm.data(itemtype=b'morestatus')
 
         if self.unfinishedop:
             fm.data(unfinished=self.unfinishedop)
             statemsg = (
                 _(b'The repository is in an unfinished *%s* state.')
                 % self.unfinishedop
             )
             fm.plain(b'%s\n' % _commentlines(statemsg), label=self._label)
         if self.unfinishedmsg:
             fm.data(unfinishedmsg=self.unfinishedmsg)
 
         # May also start new data items.
         self._formatconflicts(fm)
 
         if self.unfinishedmsg:
             fm.plain(
                 b'%s\n' % _commentlines(self.unfinishedmsg), label=self._label
             )
 
     def _formatconflicts(self, fm):
         if not self.activemerge:
             return
 
         if self.unresolvedpaths:
             mergeliststr = b'\n'.join(
                 [
                     b'    %s'
                     % util.pathto(self.repo.root, encoding.getcwd(), path)
                     for path in self.unresolvedpaths
                 ]
             )
             msg = (
                 _(
                     b'''Unresolved merge conflicts:
 
 %s
 
 To mark files as resolved:  hg resolve --mark FILE'''
                 )
                 % mergeliststr
             )
 
             # If any paths with unresolved conflicts were not previously
             # formatted, output them now.
             for f in self.unresolvedpaths:
                 if f in self._formattedpaths:
                     # Already output.
                     continue
                 fm.startitem()
                 fm.context(repo=self.repo)
                 # We can't claim to know the status of the file - it may just
                 # have been in one of the states that were not requested for
                 # display, so it could be anything.
                 fm.data(itemtype=b'file', path=f, unresolved=True)
 
         else:
             msg = _(b'No unresolved merge conflicts.')
 
         fm.plain(b'%s\n' % _commentlines(msg), label=self._label)
 
 
 def readmorestatus(repo):
     """Returns a morestatus object if the repo has unfinished state."""
     statetuple = statemod.getrepostate(repo)
     mergestate = mergestatemod.mergestate.read(repo)
     activemerge = mergestate.active()
     if not statetuple and not activemerge:
         return None
 
     unfinishedop = unfinishedmsg = unresolved = None
     if statetuple:
         unfinishedop, unfinishedmsg = statetuple
     if activemerge:
         unresolved = sorted(mergestate.unresolved())
     return morestatus(
         repo, unfinishedop, unfinishedmsg, activemerge, unresolved
     )
 
 
 def findpossible(cmd, table, strict=False):
     """
     Return cmd -> (aliases, command table entry)
     for each matching command.
     Return debug commands (or their aliases) only if no normal command matches.
     """
     choice = {}
     debugchoice = {}
 
     if cmd in table:
         # short-circuit exact matches, "log" alias beats "log|history"
         keys = [cmd]
     else:
         keys = table.keys()
 
     allcmds = []
     for e in keys:
         aliases = parsealiases(e)
         allcmds.extend(aliases)
         found = None
         if cmd in aliases:
             found = cmd
         elif not strict:
             for a in aliases:
                 if a.startswith(cmd):
                     found = a
                     break
         if found is not None:
             if aliases[0].startswith(b"debug") or found.startswith(b"debug"):
                 debugchoice[found] = (aliases, table[e])
             else:
                 choice[found] = (aliases, table[e])
 
     if not choice and debugchoice:
         choice = debugchoice
 
     return choice, allcmds
 
 
 def findcmd(cmd, table, strict=True):
     """Return (aliases, command table entry) for command string."""
     choice, allcmds = findpossible(cmd, table, strict)
 
     if cmd in choice:
         return choice[cmd]
 
     if len(choice) > 1:
         clist = sorted(choice)
         raise error.AmbiguousCommand(cmd, clist)
 
     if choice:
         return list(choice.values())[0]
 
     raise error.UnknownCommand(cmd, allcmds)
 
 
 def changebranch(ui, repo, revs, label, **opts):
     """Change the branch name of given revs to label"""
 
     with repo.wlock(), repo.lock(), repo.transaction(b'branches'):
         # abort in case of uncommitted merge or dirty wdir
         bailifchanged(repo)
         revs = logcmdutil.revrange(repo, revs)
         if not revs:
             raise error.InputError(b"empty revision set")
         roots = repo.revs(b'roots(%ld)', revs)
         if len(roots) > 1:
             raise error.InputError(
                 _(b"cannot change branch of non-linear revisions")
             )
         rewriteutil.precheck(repo, revs, b'change branch of')
 
         root = repo[roots.first()]
         rpb = {parent.branch() for parent in root.parents()}
         if (
             not opts.get('force')
             and label not in rpb
             and label in repo.branchmap()
         ):
             raise error.InputError(
                 _(b"a branch of the same name already exists")
             )
 
         # make sure only topological heads
         if repo.revs(b'heads(%ld) - head()', revs):
             raise error.InputError(
                 _(b"cannot change branch in middle of a stack")
             )
 
         replacements = {}
         # avoid import cycle mercurial.cmdutil -> mercurial.context ->
         # mercurial.subrepo -> mercurial.cmdutil
         from . import context
 
         for rev in revs:
             ctx = repo[rev]
             oldbranch = ctx.branch()
             # check if ctx has same branch
             if oldbranch == label:
                 continue
 
             def filectxfn(repo, newctx, path):
                 try:
                     return ctx[path]
                 except error.ManifestLookupError:
                     return None
 
             ui.debug(
                 b"changing branch of '%s' from '%s' to '%s'\n"
                 % (hex(ctx.node()), oldbranch, label)
             )
             extra = ctx.extra()
             extra[b'branch_change'] = hex(ctx.node())
             # While changing branch of set of linear commits, make sure that
             # we base our commits on new parent rather than old parent which
             # was obsoleted while changing the branch
             p1 = ctx.p1().node()
             p2 = ctx.p2().node()
             if p1 in replacements:
                 p1 = replacements[p1][0]
             if p2 in replacements:
                 p2 = replacements[p2][0]
 
             mc = context.memctx(
                 repo,
                 (p1, p2),
                 ctx.description(),
                 ctx.files(),
                 filectxfn,
                 user=ctx.user(),
                 date=ctx.date(),
                 extra=extra,
                 branch=label,
             )
 
             newnode = repo.commitctx(mc)
             replacements[ctx.node()] = (newnode,)
             ui.debug(b'new node id is %s\n' % hex(newnode))
 
         # create obsmarkers and move bookmarks
         scmutil.cleanupnodes(
             repo, replacements, b'branch-change', fixphase=True
         )
 
         # move the working copy too
         wctx = repo[None]
         # in-progress merge is a bit too complex for now.
         if len(wctx.parents()) == 1:
             newid = replacements.get(wctx.p1().node())
             if newid is not None:
                 # avoid import cycle mercurial.cmdutil -> mercurial.hg ->
                 # mercurial.cmdutil
                 from . import hg
 
                 hg.update(repo, newid[0], quietempty=True)
 
         ui.status(_(b"changed branch on %d changesets\n") % len(replacements))
 
 
 def findrepo(p):
     while not os.path.isdir(os.path.join(p, b".hg")):
         oldp, p = p, os.path.dirname(p)
         if p == oldp:
             return None
 
     return p
 
 
 def bailifchanged(repo, merge=True, hint=None):
     """enforce the precondition that working directory must be clean.
 
     'merge' can be set to false if a pending uncommitted merge should be
     ignored (such as when 'update --check' runs).
 
     'hint' is the usual hint given to Abort exception.
     """
 
     if merge and repo.dirstate.p2() != repo.nullid:
         raise error.StateError(_(b'outstanding uncommitted merge'), hint=hint)
     st = repo.status()
     if st.modified or st.added or st.removed or st.deleted:
         raise error.StateError(_(b'uncommitted changes'), hint=hint)
     ctx = repo[None]
     for s in sorted(ctx.substate):
         ctx.sub(s).bailifchanged(hint=hint)
 
 
 def logmessage(ui: "uimod.ui", opts: Dict[bytes, Any]) -> Optional[bytes]:
     """get the log message according to -m and -l option"""
 
     check_at_most_one_arg(opts, b'message', b'logfile')
 
     message = cast(Optional[bytes], opts.get(b'message'))
     logfile = opts.get(b'logfile')
 
     if not message and logfile:
         try:
             if isstdiofilename(logfile):
                 message = ui.fin.read()
             else:
                 message = b'\n'.join(util.readfile(logfile).splitlines())
         except IOError as inst:
             raise error.Abort(
                 _(b"can't read commit message '%s': %s")
                 % (logfile, encoding.strtolocal(inst.strerror))
             )
     return message
 
 
 def mergeeditform(ctxorbool, baseformname):
     """return appropriate editform name (referencing a committemplate)
 
     'ctxorbool' is either a ctx to be committed, or a bool indicating whether
     merging is committed.
 
     This returns baseformname with '.merge' appended if it is a merge,
     otherwise '.normal' is appended.
     """
     if isinstance(ctxorbool, bool):
         if ctxorbool:
             return baseformname + b".merge"
     elif len(ctxorbool.parents()) > 1:
         return baseformname + b".merge"
 
     return baseformname + b".normal"
 
 
 def getcommiteditor(
     edit=False, finishdesc=None, extramsg=None, editform=b'', **opts
 ):
     """get appropriate commit message editor according to '--edit' option
 
     'finishdesc' is a function to be called with edited commit message
     (= 'description' of the new changeset) just after editing, but
     before checking empty-ness. It should return actual text to be
     stored into history. This allows to change description before
     storing.
 
     'extramsg' is a extra message to be shown in the editor instead of
     'Leave message empty to abort commit' line. 'HG: ' prefix and EOL
     is automatically added.
 
     'editform' is a dot-separated list of names, to distinguish
     the purpose of commit text editing.
 
     'getcommiteditor' returns 'commitforceeditor' regardless of
     'edit', if one of 'finishdesc' or 'extramsg' is specified, because
     they are specific for usage in MQ.
     """
     if edit or finishdesc or extramsg:
         return lambda r, c, s: commitforceeditor(
             r, c, s, finishdesc=finishdesc, extramsg=extramsg, editform=editform
         )
     elif editform:
         return lambda r, c, s: commiteditor(r, c, s, editform=editform)
     else:
         return commiteditor
 
 
 def _escapecommandtemplate(tmpl):
     parts = []
     for typ, start, end in templater.scantemplate(tmpl, raw=True):
         if typ == b'string':
             parts.append(stringutil.escapestr(tmpl[start:end]))
         else:
             parts.append(tmpl[start:end])
     return b''.join(parts)
 
 
 def rendercommandtemplate(ui, tmpl, props):
     r"""Expand a literal template 'tmpl' in a way suitable for command line
 
     '\' in outermost string is not taken as an escape character because it
     is a directory separator on Windows.
 
     >>> from . import ui as uimod
     >>> ui = uimod.ui()
     >>> rendercommandtemplate(ui, b'c:\\{path}', {b'path': b'foo'})
     'c:\\foo'
     >>> rendercommandtemplate(ui, b'{"c:\\{path}"}', {'path': b'foo'})
     'c:{path}'
     """
     if not tmpl:
         return tmpl
     t = formatter.maketemplater(ui, _escapecommandtemplate(tmpl))
     return t.renderdefault(props)
 
 
 def rendertemplate(ctx, tmpl, props=None):
     """Expand a literal template 'tmpl' byte-string against one changeset
 
     Each props item must be a stringify-able value or a callable returning
     such value, i.e. no bare list nor dict should be passed.
     """
     repo = ctx.repo()
     tres = formatter.templateresources(repo.ui, repo)
     t = formatter.maketemplater(
         repo.ui, tmpl, defaults=templatekw.keywords, resources=tres
     )
     mapping = {b'ctx': ctx}
     if props:
         mapping.update(props)
     return t.renderdefault(mapping)
 
 
 def format_changeset_summary(ui, ctx, command=None, default_spec=None):
     """Format a changeset summary (one line)."""
     spec = None
     if command:
         spec = ui.config(
             b'command-templates', b'oneline-summary.%s' % command, None
         )
     if not spec:
         spec = ui.config(b'command-templates', b'oneline-summary')
     if not spec:
         spec = default_spec
     if not spec:
         spec = (
             b'{separate(" ", '
             b'label("oneline-summary.changeset", "{rev}:{node|short}")'
             b', '
             b'join(filter(namespaces % "{ifeq(namespace, "branches", "", join(names % "{label("oneline-summary.{namespace}", name)}", " "))}"), " ")'
             b')} '
             b'"{label("oneline-summary.desc", desc|firstline)}"'
         )
     text = rendertemplate(ctx, spec)
     return text.split(b'\n')[0]
 
 
 def _buildfntemplate(pat, total=None, seqno=None, revwidth=None, pathname=None):
     r"""Convert old-style filename format string to template string
 
     >>> _buildfntemplate(b'foo-%b-%n.patch', seqno=0)
     'foo-{reporoot|basename}-{seqno}.patch'
     >>> _buildfntemplate(b'%R{tags % "{tag}"}%H')
     '{rev}{tags % "{tag}"}{node}'
 
     '\' in outermost strings has to be escaped because it is a directory
     separator on Windows:
 
     >>> _buildfntemplate(b'c:\\tmp\\%R\\%n.patch', seqno=0)
     'c:\\\\tmp\\\\{rev}\\\\{seqno}.patch'
     >>> _buildfntemplate(b'\\\\foo\\bar.patch')
     '\\\\\\\\foo\\\\bar.patch'
     >>> _buildfntemplate(b'\\{tags % "{tag}"}')
     '\\\\{tags % "{tag}"}'
 
     but inner strings follow the template rules (i.e. '\' is taken as an
     escape character):
 
     >>> _buildfntemplate(br'{"c:\tmp"}', seqno=0)
     '{"c:\\tmp"}'
     """
     expander = {
         b'H': b'{node}',
         b'R': b'{rev}',
         b'h': b'{node|short}',
         b'm': br'{sub(r"[^\w]", "_", desc|firstline)}',
         b'r': b'{if(revwidth, pad(rev, revwidth, "0", left=True), rev)}',
         b'%': b'%',
         b'b': b'{reporoot|basename}',
     }
     if total is not None:
         expander[b'N'] = b'{total}'
     if seqno is not None:
         expander[b'n'] = b'{seqno}'
     if total is not None and seqno is not None:
         expander[b'n'] = b'{pad(seqno, total|stringify|count, "0", left=True)}'
     if pathname is not None:
         expander[b's'] = b'{pathname|basename}'
         expander[b'd'] = b'{if(pathname|dirname, pathname|dirname, ".")}'
         expander[b'p'] = b'{pathname}'
 
     newname = []
     for typ, start, end in templater.scantemplate(pat, raw=True):
         if typ != b'string':
             newname.append(pat[start:end])
             continue
         i = start
         while i < end:
             n = pat.find(b'%', i, end)
             if n < 0:
                 newname.append(stringutil.escapestr(pat[i:end]))
                 break
             newname.append(stringutil.escapestr(pat[i:n]))
             if n + 2 > end:
                 raise error.Abort(
                     _(b"incomplete format spec in output filename")
                 )
             c = pat[n + 1 : n + 2]
             i = n + 2
             try:
                 newname.append(expander[c])
             except KeyError:
                 raise error.Abort(
                     _(b"invalid format spec '%%%s' in output filename") % c
                 )
     return b''.join(newname)
 
 
 def makefilename(ctx, pat, **props):
     if not pat:
         return pat
     tmpl = _buildfntemplate(pat, **props)
     # BUG: alias expansion shouldn't be made against template fragments
     # rewritten from %-format strings, but we have no easy way to partially
     # disable the expansion.
     return rendertemplate(ctx, tmpl, pycompat.byteskwargs(props))
 
 
 def isstdiofilename(pat):
     """True if the given pat looks like a filename denoting stdin/stdout"""
     return not pat or pat == b'-'
 
 
 class _unclosablefile:
     def __init__(self, fp):
         self._fp = fp
 
     def close(self):
         pass
 
     def __iter__(self):
         return iter(self._fp)
 
     def __getattr__(self, attr):
         return getattr(self._fp, attr)
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, exc_tb):
         pass
 
 
 def makefileobj(ctx, pat, mode=b'wb', **props):
     writable = mode not in (b'r', b'rb')
 
     if isstdiofilename(pat):
         repo = ctx.repo()
         if writable:
             fp = repo.ui.fout
         else:
             fp = repo.ui.fin
         return _unclosablefile(fp)
     fn = makefilename(ctx, pat, **props)
     return open(fn, mode)
 
 
 def openstorage(repo, cmd, file_, opts, returnrevlog=False):
     """opens the changelog, manifest, a filelog or a given revlog"""
     cl = opts[b'changelog']
     mf = opts[b'manifest']
     dir = opts[b'dir']
     msg = None
     if cl and mf:
         msg = _(b'cannot specify --changelog and --manifest at the same time')
     elif cl and dir:
         msg = _(b'cannot specify --changelog and --dir at the same time')
     elif cl or mf or dir:
         if file_:
             msg = _(b'cannot specify filename with --changelog or --manifest')
         elif not repo:
             msg = _(
                 b'cannot specify --changelog or --manifest or --dir '
                 b'without a repository'
             )
     if msg:
         raise error.InputError(msg)
 
     r = None
     if repo:
         if cl:
             r = repo.unfiltered().changelog
         elif dir:
             if not scmutil.istreemanifest(repo):
                 raise error.InputError(
                     _(
                         b"--dir can only be used on repos with "
                         b"treemanifest enabled"
                     )
                 )
             if not dir.endswith(b'/'):
                 dir = dir + b'/'
             dirlog = repo.manifestlog.getstorage(dir)
             if len(dirlog):
                 r = dirlog
         elif mf:
             r = repo.manifestlog.getstorage(b'')
         elif file_:
             filelog = repo.file(file_)
             if len(filelog):
                 r = filelog
 
         # Not all storage may be revlogs. If requested, try to return an actual
         # revlog instance.
         if returnrevlog:
             if isinstance(r, revlog.revlog):
                 pass
             elif hasattr(r, '_revlog'):
                 r = r._revlog  # pytype: disable=attribute-error
             elif r is not None:
                 raise error.InputError(
                     _(b'%r does not appear to be a revlog') % r
                 )
 
     if not r:
         if not returnrevlog:
             raise error.InputError(_(b'cannot give path to non-revlog'))
 
         if not file_:
             raise error.CommandError(cmd, _(b'invalid arguments'))
         if not os.path.isfile(file_):
             raise error.InputError(_(b"revlog '%s' not found") % file_)
 
         target = (revlog_constants.KIND_OTHER, b'free-form:%s' % file_)
         r = revlog.revlog(
             vfsmod.vfs(encoding.getcwd(), audit=False),
             target=target,
             radix=file_[:-2],
         )
     return r
 
 
 def openrevlog(repo, cmd, file_, opts):
     """Obtain a revlog backing storage of an item.
 
     This is similar to ``openstorage()`` except it always returns a revlog.
 
     In most cases, a caller cares about the main storage object - not the
     revlog backing it. Therefore, this function should only be used by code
     that needs to examine low-level revlog implementation details. e.g. debug
     commands.
     """
     return openstorage(repo, cmd, file_, opts, returnrevlog=True)
 
 
 def copy(ui, repo, pats, opts: Dict[bytes, Any], rename=False):
     check_incompatible_arguments(opts, b'forget', [b'dry_run'])
 
     # called with the repo lock held
     #
     # hgsep => pathname that uses "/" to separate directories
     # ossep => pathname that uses os.sep to separate directories
     cwd = repo.getcwd()
     targets = {}
     forget = opts.get(b"forget")
     after = opts.get(b"after")
     dryrun = opts.get(b"dry_run")
     rev = opts.get(b'at_rev')
     if rev:
         if not forget and not after:
             # TODO: Remove this restriction and make it also create the copy
             #       targets (and remove the rename source if rename==True).
             raise error.InputError(_(b'--at-rev requires --after'))
         ctx = logcmdutil.revsingle(repo, rev)
         if len(ctx.parents()) > 1:
             raise error.InputError(
                 _(b'cannot mark/unmark copy in merge commit')
             )
     else:
         ctx = repo[None]
 
     pctx = ctx.p1()
 
     uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
 
     if forget:
         if ctx.rev() is None:
             new_ctx = ctx
         else:
             if len(ctx.parents()) > 1:
                 raise error.InputError(_(b'cannot unmark copy in merge commit'))
             # avoid cycle context -> subrepo -> cmdutil
             from . import context
 
             rewriteutil.precheck(repo, [ctx.rev()], b'uncopy')
             new_ctx = context.overlayworkingctx(repo)
             new_ctx.setbase(ctx.p1())
             mergemod.graft(repo, ctx, wctx=new_ctx)
 
         match = scmutil.match(ctx, pats, opts)
 
         current_copies = ctx.p1copies()
         current_copies.update(ctx.p2copies())
 
         uipathfn = scmutil.getuipathfn(repo)
         for f in ctx.walk(match):
             if f in current_copies:
                 new_ctx[f].markcopied(None)
             elif match.exact(f):
                 ui.warn(
                     _(
                         b'%s: not unmarking as copy - file is not marked as copied\n'
                     )
                     % uipathfn(f)
                 )
 
         if ctx.rev() is not None:
             with repo.lock():
                 mem_ctx = new_ctx.tomemctx_for_amend(ctx)
                 new_node = mem_ctx.commit()
 
                 if repo.dirstate.p1() == ctx.node():
                     with repo.dirstate.changing_parents(repo):
                         scmutil.movedirstate(repo, repo[new_node])
                 replacements = {ctx.node(): [new_node]}
                 scmutil.cleanupnodes(
                     repo, replacements, b'uncopy', fixphase=True
                 )
 
         return
 
     pats = scmutil.expandpats(pats)
     if not pats:
         raise error.InputError(_(b'no source or destination specified'))
     if len(pats) == 1:
         raise error.InputError(_(b'no destination specified'))
     dest = pats.pop()
 
     def walkpat(pat):
         srcs = []
         # TODO: Inline and simplify the non-working-copy version of this code
         # since it shares very little with the working-copy version of it.
         ctx_to_walk = ctx if ctx.rev() is None else pctx
         m = scmutil.match(ctx_to_walk, [pat], opts, globbed=True)
         for abs in ctx_to_walk.walk(m):
             rel = uipathfn(abs)
             exact = m.exact(abs)
             if abs not in ctx:
                 if abs in pctx:
                     if not after:
                         if exact:
                             ui.warn(
                                 _(
                                     b'%s: not copying - file has been marked '
                                     b'for remove\n'
                                 )
                                 % rel
                             )
                         continue
                 else:
                     if exact:
                         ui.warn(
                             _(b'%s: not copying - file is not managed\n') % rel
                         )
                     continue
 
             # abs: hgsep
             # rel: ossep
             srcs.append((abs, rel, exact))
         return srcs
 
     if ctx.rev() is not None:
         rewriteutil.precheck(repo, [ctx.rev()], b'uncopy')
         absdest = pathutil.canonpath(repo.root, cwd, dest)
         if ctx.hasdir(absdest):
             raise error.InputError(
                 _(b'%s: --at-rev does not support a directory as destination')
                 % uipathfn(absdest)
             )
         if absdest not in ctx:
             raise error.InputError(
                 _(b'%s: copy destination does not exist in %s')
                 % (uipathfn(absdest), ctx)
             )
 
         # avoid cycle context -> subrepo -> cmdutil
         from . import context
 
         copylist = []
         for pat in pats:
             srcs = walkpat(pat)
             if not srcs:
                 continue
             for abs, rel, exact in srcs:
                 copylist.append(abs)
 
         if not copylist:
             raise error.InputError(_(b'no files to copy'))
         # TODO: Add support for `hg cp --at-rev . foo bar dir` and
         # `hg cp --at-rev . dir1 dir2`, preferably unifying the code with the
         # existing functions below.
         if len(copylist) != 1:
             raise error.InputError(_(b'--at-rev requires a single source'))
 
         new_ctx = context.overlayworkingctx(repo)
         new_ctx.setbase(ctx.p1())
         mergemod.graft(repo, ctx, wctx=new_ctx)
 
         new_ctx.markcopied(absdest, copylist[0])
 
         with repo.lock():
             mem_ctx = new_ctx.tomemctx_for_amend(ctx)
             new_node = mem_ctx.commit()
 
             if repo.dirstate.p1() == ctx.node():
                 with repo.dirstate.changing_parents(repo):
                     scmutil.movedirstate(repo, repo[new_node])
             replacements = {ctx.node(): [new_node]}
             scmutil.cleanupnodes(repo, replacements, b'copy', fixphase=True)
 
         return
 
     # abssrc: hgsep
     # relsrc: ossep
     # otarget: ossep
     def copyfile(abssrc, relsrc, otarget, exact):
         abstarget = pathutil.canonpath(repo.root, cwd, otarget)
         if b'/' in abstarget:
             # We cannot normalize abstarget itself, this would prevent
             # case only renames, like a => A.
             abspath, absname = abstarget.rsplit(b'/', 1)
             abstarget = repo.dirstate.normalize(abspath) + b'/' + absname
         reltarget = repo.pathto(abstarget, cwd)
         target = repo.wjoin(abstarget)
         src = repo.wjoin(abssrc)
         entry = repo.dirstate.get_entry(abstarget)
 
         already_commited = entry.tracked and not entry.added
 
         scmutil.checkportable(ui, abstarget)
 
         # check for collisions
         prevsrc = targets.get(abstarget)
         if prevsrc is not None:
             ui.warn(
                 _(b'%s: not overwriting - %s collides with %s\n')
                 % (
                     reltarget,
                     repo.pathto(abssrc, cwd),
                     repo.pathto(prevsrc, cwd),
                 )
             )
             return True  # report a failure
 
         # check for overwrites
         exists = os.path.lexists(target)
         samefile = False
         if exists and abssrc != abstarget:
             if repo.dirstate.normalize(abssrc) == repo.dirstate.normalize(
                 abstarget
             ):
                 if not rename:
                     ui.warn(_(b"%s: can't copy - same file\n") % reltarget)
                     return True  # report a failure
                 exists = False
                 samefile = True
 
         if not after and exists or after and already_commited:
             if not opts[b'force']:
                 if already_commited:
                     msg = _(b'%s: not overwriting - file already committed\n')
                     # Check if if the target was added in the parent and the
                     # source already existed in the grandparent.
                     looks_like_copy_in_pctx = abstarget in pctx and any(
                         abssrc in gpctx and abstarget not in gpctx
                         for gpctx in pctx.parents()
                     )
                     if looks_like_copy_in_pctx:
                         if rename:
                             hint = _(
                                 b"('hg rename --at-rev .' to record the rename "
                                 b"in the parent of the working copy)\n"
                             )
                         else:
                             hint = _(
                                 b"('hg copy --at-rev .' to record the copy in "
                                 b"the parent of the working copy)\n"
                             )
                     else:
                         if after:
                             flags = b'--after --force'
                         else:
                             flags = b'--force'
                         if rename:
                             hint = (
                                 _(
                                     b"('hg rename %s' to replace the file by "
                                     b'recording a rename)\n'
                                 )
                                 % flags
                             )
                         else:
                             hint = (
                                 _(
                                     b"('hg copy %s' to replace the file by "
                                     b'recording a copy)\n'
                                 )
                                 % flags
                             )
                 else:
                     msg = _(b'%s: not overwriting - file exists\n')
                     if rename:
                         hint = _(
                             b"('hg rename --after' to record the rename)\n"
                         )
                     else:
                         hint = _(b"('hg copy --after' to record the copy)\n")
                 ui.warn(msg % reltarget)
                 ui.warn(hint)
                 return True  # report a failure
 
         if after:
             if not exists:
                 if rename:
                     ui.warn(
                         _(b'%s: not recording move - %s does not exist\n')
                         % (relsrc, reltarget)
                     )
                 else:
                     ui.warn(
                         _(b'%s: not recording copy - %s does not exist\n')
                         % (relsrc, reltarget)
                     )
                 return True  # report a failure
         elif not dryrun:
             try:
                 if exists:
                     os.unlink(target)
                 targetdir = os.path.dirname(target) or b'.'
                 if not os.path.isdir(targetdir):
                     os.makedirs(targetdir)
                 if samefile:
                     tmp = target + b"~hgrename"
                     os.rename(src, tmp)
                     os.rename(tmp, target)
                 else:
                     # Preserve stat info on renames, not on copies; this matches
                     # Linux CLI behavior.
                     util.copyfile(src, target, copystat=rename)
                 srcexists = True
             except IOError as inst:
                 if inst.errno == errno.ENOENT:
                     ui.warn(_(b'%s: deleted in working directory\n') % relsrc)
                     srcexists = False
                 else:
                     ui.warn(
                         _(b'%s: cannot copy - %s\n')
                         % (relsrc, encoding.strtolocal(inst.strerror))
                     )
                     return True  # report a failure
 
         if ui.verbose or not exact:
             if rename:
                 ui.status(_(b'moving %s to %s\n') % (relsrc, reltarget))
             else:
                 ui.status(_(b'copying %s to %s\n') % (relsrc, reltarget))
 
         targets[abstarget] = abssrc
 
         # fix up dirstate
         scmutil.dirstatecopy(
             ui, repo, ctx, abssrc, abstarget, dryrun=dryrun, cwd=cwd
         )
         if rename and not dryrun:
             if not after and srcexists and not samefile:
                 rmdir = repo.ui.configbool(b'experimental', b'removeemptydirs')
                 repo.wvfs.unlinkpath(abssrc, rmdir=rmdir)
             ctx.forget([abssrc])
 
     # pat: ossep
     # dest ossep
     # srcs: list of (hgsep, hgsep, ossep, bool)
     # return: function that takes hgsep and returns ossep
     def targetpathfn(pat, dest, srcs):
         if os.path.isdir(pat):
             abspfx = pathutil.canonpath(repo.root, cwd, pat)
             abspfx = util.localpath(abspfx)
             if destdirexists:
                 striplen = len(os.path.split(abspfx)[0])
             else:
                 striplen = len(abspfx)
             if striplen:
                 striplen += len(pycompat.ossep)
             res = lambda p: os.path.join(dest, util.localpath(p)[striplen:])
         elif destdirexists:
             res = lambda p: os.path.join(
                 dest, os.path.basename(util.localpath(p))
             )
         else:
             res = lambda p: dest
         return res
 
     # pat: ossep
     # dest ossep
     # srcs: list of (hgsep, hgsep, ossep, bool)
     # return: function that takes hgsep and returns ossep
     def targetpathafterfn(pat, dest, srcs):
         if matchmod.patkind(pat):
             # a mercurial pattern
             res = lambda p: os.path.join(
                 dest, os.path.basename(util.localpath(p))
             )
         else:
             abspfx = pathutil.canonpath(repo.root, cwd, pat)
             if len(abspfx) < len(srcs[0][0]):
                 # A directory. Either the target path contains the last
                 # component of the source path or it does not.
                 def evalpath(striplen):
                     score = 0
                     for s in srcs:
                         t = os.path.join(dest, util.localpath(s[0])[striplen:])
                         if os.path.lexists(t):
                             score += 1
                     return score
 
                 abspfx = util.localpath(abspfx)
                 striplen = len(abspfx)
                 if striplen:
                     striplen += len(pycompat.ossep)
                 if os.path.isdir(os.path.join(dest, os.path.split(abspfx)[1])):
                     score = evalpath(striplen)
                     striplen1 = len(os.path.split(abspfx)[0])
                     if striplen1:
                         striplen1 += len(pycompat.ossep)
                     if evalpath(striplen1) > score:
                         striplen = striplen1
                 res = lambda p: os.path.join(dest, util.localpath(p)[striplen:])
             else:
                 # a file
                 if destdirexists:
                     res = lambda p: os.path.join(
                         dest, os.path.basename(util.localpath(p))
                     )
                 else:
                     res = lambda p: dest
         return res
 
     destdirexists = os.path.isdir(dest) and not os.path.islink(dest)
     if not destdirexists:
         if len(pats) > 1 or matchmod.patkind(pats[0]):
             raise error.InputError(
                 _(
                     b'with multiple sources, destination must be an '
                     b'existing directory'
                 )
             )
         if util.endswithsep(dest):
             raise error.InputError(
                 _(b'destination %s is not a directory') % dest
             )
 
     tfn = targetpathfn
     if after:
         tfn = targetpathafterfn
     copylist = []
     for pat in pats:
         srcs = walkpat(pat)
         if not srcs:
             continue
         copylist.append((tfn(pat, dest, srcs), srcs))
     if not copylist:
         hint = None
         if rename:
             hint = _(b'maybe you meant to use --after --at-rev=.')
         raise error.InputError(_(b'no files to copy'), hint=hint)
 
     errors = 0
     for targetpath, srcs in copylist:
         for abssrc, relsrc, exact in srcs:
             if copyfile(abssrc, relsrc, targetpath(abssrc), exact):
                 errors += 1
 
     return errors != 0
 
 
 ## facility to let extension process additional data into an import patch
 # list of identifier to be executed in order
 extrapreimport = []  # run before commit
 extrapostimport = []  # run after commit
 # mapping from identifier to actual import function
 #
 # 'preimport' are run before the commit is made and are provided the following
 # arguments:
 # - repo: the localrepository instance,
 # - patchdata: data extracted from patch header (cf m.patch.patchheadermap),
 # - extra: the future extra dictionary of the changeset, please mutate it,
 # - opts: the import options.
 # XXX ideally, we would just pass an ctx ready to be computed, that would allow
 # mutation of in memory commit and more. Feel free to rework the code to get
 # there.
 extrapreimportmap = {}
 # 'postimport' are run after the commit is made and are provided the following
 # argument:
 # - ctx: the changectx created by import.
 extrapostimportmap = {}
 
 
 def tryimportone(ui, repo, patchdata, parents, opts, msgs, updatefunc):
     """Utility function used by commands.import to import a single patch
 
     This function is explicitly defined here to help the evolve extension to
     wrap this part of the import logic.
 
     The API is currently a bit ugly because it a simple code translation from
     the import command. Feel free to make it better.
 
     :patchdata: a dictionary containing parsed patch data (such as from
                 ``patch.extract()``)
     :parents: nodes that will be parent of the created commit
     :opts: the full dict of option passed to the import command
     :msgs: list to save commit message to.
            (used in case we need to save it when failing)
     :updatefunc: a function that update a repo to a given node
                  updatefunc(<repo>, <node>)
     """
     # avoid cycle context -> subrepo -> cmdutil
     from . import context
 
     tmpname = patchdata.get(b'filename')
     message = patchdata.get(b'message')
     user = opts.get(b'user') or patchdata.get(b'user')
     date = opts.get(b'date') or patchdata.get(b'date')
     branch = patchdata.get(b'branch')
     nodeid = patchdata.get(b'nodeid')
     p1 = patchdata.get(b'p1')
     p2 = patchdata.get(b'p2')
 
     nocommit = opts.get(b'no_commit')
     importbranch = opts.get(b'import_branch')
     update = not opts.get(b'bypass')
     strip = opts[b"strip"]
     prefix = opts[b"prefix"]
     sim = float(opts.get(b'similarity') or 0)
 
     if not tmpname:
         return None, None, False
 
     rejects = False
 
     cmdline_message = logmessage(ui, opts)
     if cmdline_message:
         # pickup the cmdline msg
         message = cmdline_message
     elif message:
         # pickup the patch msg
         message = message.strip()
     else:
         # launch the editor
         message = None
     ui.debug(b'message:\n%s\n' % (message or b''))
 
     if len(parents) == 1:
         parents.append(repo[nullrev])
     if opts.get(b'exact'):
         if not nodeid or not p1:
             raise error.InputError(_(b'not a Mercurial patch'))
         p1 = repo[p1]
         p2 = repo[p2 or nullrev]
     elif p2:
         try:
             p1 = repo[p1]
             p2 = repo[p2]
             # Without any options, consider p2 only if the
             # patch is being applied on top of the recorded
             # first parent.
             if p1 != parents[0]:
                 p1 = parents[0]
                 p2 = repo[nullrev]
         except error.RepoError:
             p1, p2 = parents
         if p2.rev() == nullrev:
             ui.warn(
                 _(
                     b"warning: import the patch as a normal revision\n"
                     b"(use --exact to import the patch as a merge)\n"
                 )
             )
     else:
         p1, p2 = parents
 
     n = None
     if update:
         if p1 != parents[0]:
             updatefunc(repo, p1.node())
         if p2 != parents[1]:
             repo.setparents(p1.node(), p2.node())
 
         if opts.get(b'exact') or importbranch:
             repo.dirstate.setbranch(
                 branch or b'default', repo.currenttransaction()
             )
 
         partial = opts.get(b'partial', False)
         files = set()
         try:
             patch.patch(
                 ui,
                 repo,
                 tmpname,
                 strip=strip,
                 prefix=prefix,
                 files=files,
                 eolmode=None,
                 similarity=sim / 100.0,
             )
         except error.PatchParseError as e:
             raise error.InputError(
                 pycompat.bytestr(e),
                 hint=_(
                     b'check that whitespace in the patch has not been mangled'
                 ),
             )
         except error.PatchApplicationError as e:
             if not partial:
                 raise error.StateError(pycompat.bytestr(e))
             if partial:
                 rejects = True
 
         files = list(files)
         if nocommit:
             if message:
                 msgs.append(message)
         else:
             if opts.get(b'exact') or p2:
                 # If you got here, you either use --force and know what
                 # you are doing or used --exact or a merge patch while
                 # being updated to its first parent.
                 m = None
             else:
                 m = scmutil.matchfiles(repo, files or [])
             editform = mergeeditform(repo[None], b'import.normal')
             if opts.get(b'exact'):
                 editor = None
             else:
                 editor = getcommiteditor(
                     editform=editform, **pycompat.strkwargs(opts)
                 )
             extra = {}
             for idfunc in extrapreimport:
                 extrapreimportmap[idfunc](repo, patchdata, extra, opts)
             overrides = {}
             if partial:
                 overrides[(b'ui', b'allowemptycommit')] = True
             if opts.get(b'secret'):
                 overrides[(b'phases', b'new-commit')] = b'secret'
             with repo.ui.configoverride(overrides, b'import'):
                 n = repo.commit(
                     message, user, date, match=m, editor=editor, extra=extra
                 )
                 for idfunc in extrapostimport:
                     extrapostimportmap[idfunc](repo[n])
     else:
         if opts.get(b'exact') or importbranch:
             branch = branch or b'default'
         else:
             branch = p1.branch()
         store = patch.filestore()
         try:
             files = set()
             try:
                 patch.patchrepo(
                     ui,
                     repo,
                     p1,
                     store,
                     tmpname,
                     strip,
                     prefix,
                     files,
                     eolmode=None,
                 )
             except error.PatchParseError as e:
                 raise error.InputError(
                     stringutil.forcebytestr(e),
                     hint=_(
                         b'check that whitespace in the patch has not been mangled'
                     ),
                 )
             except error.PatchApplicationError as e:
                 raise error.StateError(stringutil.forcebytestr(e))
             if opts.get(b'exact'):
                 editor = None
             else:
                 editor = getcommiteditor(editform=b'import.bypass')
             memctx = context.memctx(
                 repo,
                 (p1.node(), p2.node()),
                 message,
                 files=files,
                 filectxfn=store,
                 user=user,
                 date=date,
                 branch=branch,
                 editor=editor,
             )
 
             overrides = {}
             if opts.get(b'secret'):
                 overrides[(b'phases', b'new-commit')] = b'secret'
             with repo.ui.configoverride(overrides, b'import'):
                 n = memctx.commit()
         finally:
             store.close()
     if opts.get(b'exact') and nocommit:
         # --exact with --no-commit is still useful in that it does merge
         # and branch bits
         ui.warn(_(b"warning: can't check exact import with --no-commit\n"))
     elif opts.get(b'exact') and (not n or hex(n) != nodeid):
         raise error.Abort(_(b'patch is damaged or loses information'))
     msg = _(b'applied to working directory')
     if n:
         # i18n: refers to a short changeset id
         msg = _(b'created %s') % short(n)
     return msg, n, rejects
 
 
 # facility to let extensions include additional data in an exported patch
 # list of identifiers to be executed in order
 extraexport = []
 # mapping from identifier to actual export function
 # function as to return a string to be added to the header or None
 # it is given two arguments (sequencenumber, changectx)
 extraexportmap = {}
 
 
 def _exportsingle(repo, ctx, fm, match, switch_parent, seqno, diffopts):
     node = scmutil.binnode(ctx)
     parents = [p.node() for p in ctx.parents() if p]
     branch = ctx.branch()
     if switch_parent:
         parents.reverse()
 
     if parents:
         prev = parents[0]
     else:
         prev = repo.nullid
 
     fm.context(ctx=ctx)
     fm.plain(b'# HG changeset patch\n')
     fm.write(b'user', b'# User %s\n', ctx.user())
     fm.plain(b'# Date %d %d\n' % ctx.date())
     fm.write(b'date', b'#      %s\n', fm.formatdate(ctx.date()))
     fm.condwrite(
         branch and branch != b'default', b'branch', b'# Branch %s\n', branch
     )
     fm.write(b'node', b'# Node ID %s\n', hex(node))
     fm.plain(b'# Parent  %s\n' % hex(prev))
     if len(parents) > 1:
         fm.plain(b'# Parent  %s\n' % hex(parents[1]))
     fm.data(parents=fm.formatlist(pycompat.maplist(hex, parents), name=b'node'))
 
     # TODO: redesign extraexportmap function to support formatter
     for headerid in extraexport:
         header = extraexportmap[headerid](seqno, ctx)
         if header is not None:
             fm.plain(b'# %s\n' % header)
 
     fm.write(b'desc', b'%s\n', ctx.description().rstrip())
     fm.plain(b'\n')
 
     if fm.isplain():
         chunkiter = patch.diffui(repo, prev, node, match, opts=diffopts)
         for chunk, label in chunkiter:
             fm.plain(chunk, label=label)
     else:
         chunkiter = patch.diff(repo, prev, node, match, opts=diffopts)
         # TODO: make it structured?
         fm.data(diff=b''.join(chunkiter))
 
 
 def _exportfile(repo, revs, fm, dest, switch_parent, diffopts, match):
     """Export changesets to stdout or a single file"""
     for seqno, rev in enumerate(revs, 1):
         ctx = repo[rev]
         if not dest.startswith(b'<'):
             repo.ui.note(b"%s\n" % dest)
         fm.startitem()
         _exportsingle(repo, ctx, fm, match, switch_parent, seqno, diffopts)
 
 
 def _exportfntemplate(
     repo, revs, basefm, fntemplate, switch_parent, diffopts, match
 ):
     """Export changesets to possibly multiple files"""
     total = len(revs)
     revwidth = max(len(str(rev)) for rev in revs)
     filemap = util.sortdict()  # filename: [(seqno, rev), ...]
 
     for seqno, rev in enumerate(revs, 1):
         ctx = repo[rev]
         dest = makefilename(
             ctx, fntemplate, total=total, seqno=seqno, revwidth=revwidth
         )
         filemap.setdefault(dest, []).append((seqno, rev))
 
     for dest in filemap:
         with formatter.maybereopen(basefm, dest) as fm:
             repo.ui.note(b"%s\n" % dest)
             for seqno, rev in filemap[dest]:
                 fm.startitem()
                 ctx = repo[rev]
                 _exportsingle(
                     repo, ctx, fm, match, switch_parent, seqno, diffopts
                 )
 
 
 def _prefetchchangedfiles(repo, revs, match):
     allfiles = set()
     for rev in revs:
         for file in repo[rev].files():
             if not match or match(file):
                 allfiles.add(file)
     match = scmutil.matchfiles(repo, allfiles)
     revmatches = [(rev, match) for rev in revs]
     scmutil.prefetchfiles(repo, revmatches)
 
 
 def export(
     repo,
     revs,
     basefm,
     fntemplate=b'hg-%h.patch',
     switch_parent=False,
     opts=None,
     match=None,
 ):
     """export changesets as hg patches
 
     Args:
       repo: The repository from which we're exporting revisions.
       revs: A list of revisions to export as revision numbers.
       basefm: A formatter to which patches should be written.
       fntemplate: An optional string to use for generating patch file names.
       switch_parent: If True, show diffs against second parent when not nullid.
                      Default is false, which always shows diff against p1.
       opts: diff options to use for generating the patch.
       match: If specified, only export changes to files matching this matcher.
 
     Returns:
       Nothing.
 
     Side Effect:
       "HG Changeset Patch" data is emitted to one of the following
       destinations:
         fntemplate specified: Each rev is written to a unique file named using
                             the given template.
         Otherwise: All revs will be written to basefm.
     """
     _prefetchchangedfiles(repo, revs, match)
 
     if not fntemplate:
         _exportfile(
             repo, revs, basefm, b'<unnamed>', switch_parent, opts, match
         )
     else:
         _exportfntemplate(
             repo, revs, basefm, fntemplate, switch_parent, opts, match
         )
 
 
 def exportfile(repo, revs, fp, switch_parent=False, opts=None, match=None):
     """Export changesets to the given file stream"""
     _prefetchchangedfiles(repo, revs, match)
 
     dest = getattr(fp, 'name', b'<unnamed>')
     with formatter.formatter(repo.ui, fp, b'export', {}) as fm:
         _exportfile(repo, revs, fm, dest, switch_parent, opts, match)
 
 
 def showmarker(fm, marker, index=None):
     """utility function to display obsolescence marker in a readable way
 
     To be used by debug function."""
     if index is not None:
         fm.write(b'index', b'%i ', index)
     fm.write(b'prednode', b'%s ', hex(marker.prednode()))
     succs = marker.succnodes()
     fm.condwrite(
         succs,
         b'succnodes',
         b'%s ',
         fm.formatlist(map(hex, succs), name=b'node'),
     )
     fm.write(b'flag', b'%X ', marker.flags())
     parents = marker.parentnodes()
     if parents is not None:
         fm.write(
             b'parentnodes',
             b'{%s} ',
             fm.formatlist(map(hex, parents), name=b'node', sep=b', '),
         )
     fm.write(b'date', b'(%s) ', fm.formatdate(marker.date()))
     meta = marker.metadata().copy()
     meta.pop(b'date', None)
     smeta = pycompat.rapply(pycompat.maybebytestr, meta)
     fm.write(
         b'metadata', b'{%s}', fm.formatdict(smeta, fmt=b'%r: %r', sep=b', ')
     )
     fm.plain(b'\n')
 
 
 def finddate(ui, repo, date):
     """Find the tipmost changeset that matches the given date spec"""
     mrevs = repo.revs(b'date(%s)', date)
     try:
         rev = mrevs.max()
     except ValueError:
         raise error.InputError(_(b"revision matching date not found"))
 
     ui.status(
         _(b"found revision %d from %s\n")
         % (rev, dateutil.datestr(repo[rev].date()))
     )
     return b'%d' % rev
 
 
 def add(ui, repo, match, prefix, uipathfn, explicitonly, **opts):
     bad = []
 
     badfn = lambda x, y: bad.append(x) or match.bad(x, y)
     names = []
     wctx = repo[None]
     cca = None
     abort, warn = scmutil.checkportabilityalert(ui)
     if abort or warn:
         cca = scmutil.casecollisionauditor(ui, abort, repo.dirstate)
 
     match = repo.narrowmatch(match, includeexact=True)
     badmatch = matchmod.badmatch(match, badfn)
     dirstate = repo.dirstate
     # We don't want to just call wctx.walk here, since it would return a lot of
     # clean files, which we aren't interested in and takes time.
     for f in sorted(
         dirstate.walk(
             badmatch,
             subrepos=sorted(wctx.substate),
             unknown=True,
             ignored=False,
             full=False,
         )
     ):
         entry = dirstate.get_entry(f)
         # We don't want to even attmpt to add back files that have been removed
         # It would lead to a misleading message saying we're adding the path,
         # and can also lead to file/dir conflicts when attempting to add it.
         removed = entry and entry.removed
         exact = match.exact(f)
         if (
             exact
             or not explicitonly
             and f not in wctx
             and repo.wvfs.lexists(f)
             and not removed
         ):
             if cca:
                 cca(f)
             names.append(f)
             if ui.verbose or not exact:
                 ui.status(
                     _(b'adding %s\n') % uipathfn(f), label=b'ui.addremove.added'
                 )
 
     for subpath in sorted(wctx.substate):
         sub = wctx.sub(subpath)
         try:
             submatch = matchmod.subdirmatcher(subpath, match)
             subprefix = repo.wvfs.reljoin(prefix, subpath)
             subuipathfn = scmutil.subdiruipathfn(subpath, uipathfn)
             if opts.get('subrepos'):
                 bad.extend(
                     sub.add(ui, submatch, subprefix, subuipathfn, False, **opts)
                 )
             else:
                 bad.extend(
                     sub.add(ui, submatch, subprefix, subuipathfn, True, **opts)
                 )
         except error.LookupError:
             ui.status(
                 _(b"skipping missing subrepository: %s\n") % uipathfn(subpath)
             )
 
     if not opts.get('dry_run'):
         rejected = wctx.add(names, prefix)
         bad.extend(f for f in rejected if f in match.files())
     return bad
 
 
 def addwebdirpath(repo, serverpath, webconf):
     webconf[serverpath] = repo.root
     repo.ui.debug(b'adding %s = %s\n' % (serverpath, repo.root))
 
     for r in repo.revs(b'filelog("path:.hgsub")'):
         ctx = repo[r]
         for subpath in ctx.substate:
             ctx.sub(subpath).addwebdirpath(serverpath, webconf)
 
 
 def forget(
     ui, repo, match, prefix, uipathfn, explicitonly, dryrun, interactive
 ):
     if dryrun and interactive:
         raise error.InputError(
             _(b"cannot specify both --dry-run and --interactive")
         )
     bad = []
     badfn = lambda x, y: bad.append(x) or match.bad(x, y)
     wctx = repo[None]
     forgot = []
 
     s = repo.status(match=matchmod.badmatch(match, badfn), clean=True)
     forget = sorted(s.modified + s.added + s.deleted + s.clean)
     if explicitonly:
         forget = [f for f in forget if match.exact(f)]
 
     for subpath in sorted(wctx.substate):
         sub = wctx.sub(subpath)
         submatch = matchmod.subdirmatcher(subpath, match)
         subprefix = repo.wvfs.reljoin(prefix, subpath)
         subuipathfn = scmutil.subdiruipathfn(subpath, uipathfn)
         try:
             subbad, subforgot = sub.forget(
                 submatch,
                 subprefix,
                 subuipathfn,
                 dryrun=dryrun,
                 interactive=interactive,
             )
             bad.extend([subpath + b'/' + f for f in subbad])
             forgot.extend([subpath + b'/' + f for f in subforgot])
         except error.LookupError:
             ui.status(
                 _(b"skipping missing subrepository: %s\n") % uipathfn(subpath)
             )
 
     if not explicitonly:
         for f in match.files():
             if f not in repo.dirstate and not repo.wvfs.isdir(f):
                 if f not in forgot:
                     if repo.wvfs.exists(f):
                         # Don't complain if the exact case match wasn't given.
                         # But don't do this until after checking 'forgot', so
                         # that subrepo files aren't normalized, and this op is
                         # purely from data cached by the status walk above.
                         if repo.dirstate.normalize(f) in repo.dirstate:
                             continue
                         ui.warn(
                             _(
                                 b'not removing %s: '
                                 b'file is already untracked\n'
                             )
                             % uipathfn(f)
                         )
                     bad.append(f)
 
     if interactive:
         responses = _(
             b'[Ynsa?]'
             b'$$ &Yes, forget this file'
             b'$$ &No, skip this file'
             b'$$ &Skip remaining files'
             b'$$ Include &all remaining files'
             b'$$ &? (display help)'
         )
         for filename in forget[:]:
             r = ui.promptchoice(
                 _(b'forget %s %s') % (uipathfn(filename), responses)
             )
             if r == 4:  # ?
                 while r == 4:
                     for c, t in ui.extractchoices(responses)[1]:
                         ui.write(b'%s - %s\n' % (c, encoding.lower(t)))
                     r = ui.promptchoice(
                         _(b'forget %s %s') % (uipathfn(filename), responses)
                     )
             if r == 0:  # yes
                 continue
             elif r == 1:  # no
                 forget.remove(filename)
             elif r == 2:  # Skip
                 fnindex = forget.index(filename)
                 del forget[fnindex:]
                 break
             elif r == 3:  # All
                 break
 
     for f in forget:
         if ui.verbose or not match.exact(f) or interactive:
             ui.status(
                 _(b'removing %s\n') % uipathfn(f), label=b'ui.addremove.removed'
             )
 
     if not dryrun:
         rejected = wctx.forget(forget, prefix)
         bad.extend(f for f in rejected if f in match.files())
         forgot.extend(f for f in forget if f not in rejected)
     return bad, forgot
 
 
 def files(ui, ctx, m, uipathfn, fm, fmt, subrepos):
     ret = 1
 
     needsfctx = ui.verbose or {b'size', b'flags'} & fm.datahint()
     if fm.isplain() and not needsfctx:
         # Fast path. The speed-up comes from skipping the formatter, and batching
         # calls to ui.write.
         buf = []
         for f in ctx.matches(m):
             buf.append(fmt % uipathfn(f))
             if len(buf) > 100:
                 ui.write(b''.join(buf))
                 del buf[:]
             ret = 0
         if buf:
             ui.write(b''.join(buf))
     else:
         for f in ctx.matches(m):
             fm.startitem()
             fm.context(ctx=ctx)
             if needsfctx:
                 fc = ctx[f]
                 fm.write(b'size flags', b'% 10d % 1s ', fc.size(), fc.flags())
             fm.data(path=f)
             fm.plain(fmt % uipathfn(f))
             ret = 0
 
     for subpath in sorted(ctx.substate):
         submatch = matchmod.subdirmatcher(subpath, m)
         subuipathfn = scmutil.subdiruipathfn(subpath, uipathfn)
         if subrepos or m.exact(subpath) or any(submatch.files()):
             sub = ctx.sub(subpath)
             try:
                 recurse = m.exact(subpath) or subrepos
                 if (
                     sub.printfiles(ui, submatch, subuipathfn, fm, fmt, recurse)
                     == 0
                 ):
                     ret = 0
             except error.LookupError:
                 ui.status(
                     _(b"skipping missing subrepository: %s\n")
                     % uipathfn(subpath)
                 )
 
     return ret
 
 
 def remove(
     ui, repo, m, prefix, uipathfn, after, force, subrepos, dryrun, warnings=None
 ):
     ret = 0
     s = repo.status(match=m, clean=True)
     modified, added, deleted, clean = s.modified, s.added, s.deleted, s.clean
 
     wctx = repo[None]
 
     if warnings is None:
         warnings = []
         warn = True
     else:
         warn = False
 
     subs = sorted(wctx.substate)
     progress = ui.makeprogress(
         _(b'searching'), total=len(subs), unit=_(b'subrepos')
     )
     for subpath in subs:
         submatch = matchmod.subdirmatcher(subpath, m)
         subprefix = repo.wvfs.reljoin(prefix, subpath)
         subuipathfn = scmutil.subdiruipathfn(subpath, uipathfn)
         if subrepos or m.exact(subpath) or any(submatch.files()):
             progress.increment()
             sub = wctx.sub(subpath)
             try:
                 if sub.removefiles(
                     submatch,
                     subprefix,
                     subuipathfn,
                     after,
                     force,
                     subrepos,
                     dryrun,
                     warnings,
                 ):
                     ret = 1
             except error.LookupError:
                 warnings.append(
                     _(b"skipping missing subrepository: %s\n")
                     % uipathfn(subpath)
                 )
     progress.complete()
 
     # warn about failure to delete explicit files/dirs
     deleteddirs = pathutil.dirs(deleted)
     files = m.files()
     progress = ui.makeprogress(
         _(b'deleting'), total=len(files), unit=_(b'files')
     )
     for f in files:
 
         def insubrepo():
             for subpath in wctx.substate:
                 if f.startswith(subpath + b'/'):
                     return True
             return False
 
         progress.increment()
         isdir = f in deleteddirs or wctx.hasdir(f)
         if f in repo.dirstate or isdir or f == b'.' or insubrepo() or f in subs:
             continue
 
         if repo.wvfs.exists(f):
             if repo.wvfs.isdir(f):
                 warnings.append(
                     _(b'not removing %s: no tracked files\n') % uipathfn(f)
                 )
             else:
                 warnings.append(
                     _(b'not removing %s: file is untracked\n') % uipathfn(f)
                 )
         # missing files will generate a warning elsewhere
         ret = 1
     progress.complete()
 
     if force:
         list = modified + deleted + clean + added
     elif after:
         list = deleted
         remaining = modified + added + clean
         progress = ui.makeprogress(
             _(b'skipping'), total=len(remaining), unit=_(b'files')
         )
         for f in remaining:
             progress.increment()
             if ui.verbose or (f in files):
                 warnings.append(
                     _(b'not removing %s: file still exists\n') % uipathfn(f)
                 )
             ret = 1
         progress.complete()
     else:
         list = deleted + clean
         progress = ui.makeprogress(
             _(b'skipping'), total=(len(modified) + len(added)), unit=_(b'files')
         )
         for f in modified:
             progress.increment()
             warnings.append(
                 _(
                     b'not removing %s: file is modified (use -f'
                     b' to force removal)\n'
                 )
                 % uipathfn(f)
             )
             ret = 1
         for f in added:
             progress.increment()
             warnings.append(
                 _(
                     b"not removing %s: file has been marked for add"
                     b" (use 'hg forget' to undo add)\n"
                 )
                 % uipathfn(f)
             )
             ret = 1
         progress.complete()
 
     list = sorted(list)
     progress = ui.makeprogress(
         _(b'deleting'), total=len(list), unit=_(b'files')
     )
     for f in list:
         if ui.verbose or not m.exact(f):
             progress.increment()
             ui.status(
                 _(b'removing %s\n') % uipathfn(f), label=b'ui.addremove.removed'
             )
     progress.complete()
 
     if not dryrun:
         with repo.wlock():
             if not after:
                 for f in list:
                     if f in added:
                         continue  # we never unlink added files on remove
                     rmdir = repo.ui.configbool(
                         b'experimental', b'removeemptydirs'
                     )
                     repo.wvfs.unlinkpath(f, ignoremissing=True, rmdir=rmdir)
             repo[None].forget(list)
 
     if warn:
         for warning in warnings:
             ui.warn(warning)
 
     return ret
 
 
 def _catfmtneedsdata(fm):
     return not fm.datahint() or b'data' in fm.datahint()
 
 
 def _updatecatformatter(fm, ctx, matcher, path, decode):
     """Hook for adding data to the formatter used by ``hg cat``.
 
     Extensions (e.g., lfs) can wrap this to inject keywords/data, but must call
     this method first."""
 
     # data() can be expensive to fetch (e.g. lfs), so don't fetch it if it
     # wasn't requested.
     data = b''
     if _catfmtneedsdata(fm):
         data = ctx[path].data()
         if decode:
             data = ctx.repo().wwritedata(path, data)
     fm.startitem()
     fm.context(ctx=ctx)
     fm.write(b'data', b'%s', data)
     fm.data(path=path)
 
 
 def cat(ui, repo, ctx, matcher, basefm, fntemplate, prefix, **opts):
     err = 1
 
     def write(path):
         filename = None
         if fntemplate:
             filename = makefilename(
                 ctx, fntemplate, pathname=os.path.join(prefix, path)
             )
             # attempt to create the directory if it does not already exist
             try:
                 os.makedirs(os.path.dirname(filename))
             except OSError:
                 pass
         with formatter.maybereopen(basefm, filename) as fm:
             _updatecatformatter(fm, ctx, matcher, path, opts.get('decode'))
 
     # Automation often uses hg cat on single files, so special case it
     # for performance to avoid the cost of parsing the manifest.
     if len(matcher.files()) == 1 and not matcher.anypats():
         file = matcher.files()[0]
         mfl = repo.manifestlog
         mfnode = ctx.manifestnode()
         try:
             if mfnode and mfl[mfnode].find(file)[0]:
                 if _catfmtneedsdata(basefm):
                     scmutil.prefetchfiles(repo, [(ctx.rev(), matcher)])
                 write(file)
                 return 0
         except KeyError:
             pass
 
     if _catfmtneedsdata(basefm):
         scmutil.prefetchfiles(repo, [(ctx.rev(), matcher)])
 
     for abs in ctx.walk(matcher):
         write(abs)
         err = 0
 
     uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
     for subpath in sorted(ctx.substate):
         sub = ctx.sub(subpath)
         try:
             submatch = matchmod.subdirmatcher(subpath, matcher)
             subprefix = os.path.join(prefix, subpath)
             if not sub.cat(
                 submatch,
                 basefm,
                 fntemplate,
                 subprefix,
                 **opts,
             ):
                 err = 0
         except error.RepoLookupError:
             ui.status(
                 _(b"skipping missing subrepository: %s\n") % uipathfn(subpath)
             )
 
     return err
 
 
 class _AddRemoveContext:
     """a small (hacky) context to deal with lazy opening of context
 
     This is to be used in the `commit` function right below. This deals with
     lazily open a `changing_files` context inside a `transaction` that span the
     full commit operation.
 
     We need :
     - a `changing_files` context to wrap the dirstate change within the
       "addremove" operation,
     - a transaction to make sure these change are not written right after the
       addremove, but when the commit operation succeed.
 
     However it get complicated because:
     - opening a transaction "this early" shuffle hooks order, especially the
       `precommit` one happening after the `pretxtopen` one which I am not too
       enthusiastic about.
     - the `mq` extensions + the `record` extension stacks many layers of call
       to implement `qrefresh --interactive` and this result with `mq` calling a
       `strip` in the middle of this function. Which prevent the existence of
       transaction wrapping all of its function code. (however, `qrefresh` never
       call the `addremove` bits.
     - the largefile extensions (and maybe other extensions?) wraps `addremove`
       so slicing `addremove` in smaller bits is a complex endeavour.
 
     So I eventually took a this shortcut that open the transaction if we
     actually needs it, not disturbing much of the rest of the code.
 
     It will result in some hooks order change for `hg commit --addremove`,
     however it seems a corner case enough to ignore that for now (hopefully).
 
     Notes that None of the above problems seems insurmountable, however I have
     been fighting with this specific piece of code for a couple of day already
     and I need a solution to keep moving forward on the bigger work around
     `changing_files` context that is being introduced at the same time as this
     hack.
 
     Each problem seems to have a solution:
     - the hook order issue could be solved by refactoring the many-layer stack
       that currently composes a commit and calling them earlier,
     - the mq issue could be solved by refactoring `mq` so that the final strip
       is done after transaction closure. Be warned that the mq code is quite
       antic however.
     - large-file could be reworked in parallel of the `addremove` to be
       friendlier to this.
 
     However each of these tasks are too much a diversion right now. In addition
     they will be much easier to undertake when the `changing_files` dust has
     settled."""
 
     def __init__(self, repo):
         self._repo = repo
         self._transaction = None
         self._dirstate_context = None
         self._state = None
 
     def __enter__(self):
         assert self._state is None
         self._state = True
         return self
 
     def open_transaction(self):
         """open a `transaction` and `changing_files` context
 
         Call this when you know that change to the dirstate will be needed and
         we need to open the transaction early
 
         This will also open the dirstate `changing_files` context, so you should
         call `close_dirstate_context` when the distate changes are done.
         """
         assert self._state is not None
         if self._transaction is None:
             self._transaction = self._repo.transaction(b'commit')
             self._transaction.__enter__()
         if self._dirstate_context is None:
             self._dirstate_context = self._repo.dirstate.changing_files(
                 self._repo
             )
             self._dirstate_context.__enter__()
 
     def close_dirstate_context(self):
         """close the change_files if any
 
         Call this after the (potential) `open_transaction` call to close the
         (potential) changing_files context.
         """
         if self._dirstate_context is not None:
             self._dirstate_context.__exit__(None, None, None)
             self._dirstate_context = None
 
     def __exit__(self, *args):
         if self._dirstate_context is not None:
             self._dirstate_context.__exit__(*args)
         if self._transaction is not None:
             self._transaction.__exit__(*args)
 
 
 def commit(ui, repo, commitfunc, pats, opts):
     '''commit the specified files or all outstanding changes'''
     date = opts.get(b'date')
     if date:
         opts[b'date'] = dateutil.parsedate(date)
 
     with repo.wlock(), repo.lock():
         message = logmessage(ui, opts)
         matcher = scmutil.match(repo[None], pats, opts)
 
         with _AddRemoveContext(repo) as c:
             # extract addremove carefully -- this function can be called from a
             # command that doesn't support addremove
             if opts.get(b'addremove'):
                 relative = scmutil.anypats(pats, opts)
                 uipathfn = scmutil.getuipathfn(
                     repo,
                     legacyrelativevalue=relative,
                 )
                 r = scmutil.addremove(
                     repo,
                     matcher,
                     b"",
                     uipathfn,
                     opts,
                     open_tr=c.open_transaction,
                 )
                 m = _(b"failed to mark all new/missing files as added/removed")
                 if r != 0:
                     raise error.Abort(m)
             c.close_dirstate_context()
             return commitfunc(ui, repo, message, matcher, opts)
 
 
 def samefile(f, ctx1, ctx2):
     if f in ctx1.manifest():
         a = ctx1.filectx(f)
         if f in ctx2.manifest():
             b = ctx2.filectx(f)
             return not a.cmp(b) and a.flags() == b.flags()
         else:
             return False
     else:
         return f not in ctx2.manifest()
 
 
 def amend(ui, repo, old, extra, pats, opts: Dict[str, Any]):
     # avoid cycle context -> subrepo -> cmdutil
     from . import context
 
     # amend will reuse the existing user if not specified, but the obsolete
     # marker creation requires that the current user's name is specified.
     if obsolete.isenabled(repo, obsolete.createmarkersopt):
         ui.username()  # raise exception if username not set
 
     ui.note(_(b'amending changeset %s\n') % old)
     base = old.p1()
 
     with repo.wlock(), repo.lock(), repo.transaction(b'amend'):
         # Participating changesets:
         #
         # wctx     o - workingctx that contains changes from working copy
         #          |   to go into amending commit
         #          |
         # old      o - changeset to amend
         #          |
         # base     o - first parent of the changeset to amend
         wctx = repo[None]
 
         # Copy to avoid mutating input
         extra = extra.copy()
         # Update extra dict from amended commit (e.g. to preserve graft
         # source)
         extra.update(old.extra())
 
         # Also update it from the from the wctx
         extra.update(wctx.extra())
 
         # date-only change should be ignored?
         datemaydiffer = resolve_commit_options(ui, opts)
         opts = pycompat.byteskwargs(opts)
 
         date = old.date()
         if opts.get(b'date'):
             date = dateutil.parsedate(opts.get(b'date'))
         user = opts.get(b'user') or old.user()
 
         if len(old.parents()) > 1:
             # ctx.files() isn't reliable for merges, so fall back to the
             # slower repo.status() method
             st = base.status(old)
             files = set(st.modified) | set(st.added) | set(st.removed)
         else:
             files = set(old.files())
 
         # add/remove the files to the working copy if the "addremove" option
         # was specified.
         matcher = scmutil.match(wctx, pats, opts)
         relative = scmutil.anypats(pats, opts)
         uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=relative)
         if opts.get(b'addremove'):
             with repo.dirstate.changing_files(repo):
                 if scmutil.addremove(repo, matcher, b"", uipathfn, opts) != 0:
                     m = _(
                         b"failed to mark all new/missing files as added/removed"
                     )
                     raise error.Abort(m)
 
         # Check subrepos. This depends on in-place wctx._status update in
         # subrepo.precommit(). To minimize the risk of this hack, we do
         # nothing if .hgsub does not exist.
         if b'.hgsub' in wctx or b'.hgsub' in old:
             subs, commitsubs, newsubstate = subrepoutil.precommit(
                 ui, wctx, wctx._status, matcher
             )
             # amend should abort if commitsubrepos is enabled
             assert not commitsubs
             if subs:
                 subrepoutil.writestate(repo, newsubstate)
 
         ms = mergestatemod.mergestate.read(repo)
         mergeutil.checkunresolved(ms)
 
         filestoamend = {f for f in wctx.files() if matcher(f)}
 
         changes = len(filestoamend) > 0
         changeset_copies = (
             repo.ui.config(b'experimental', b'copies.read-from')
             != b'filelog-only'
         )
         # If there are changes to amend or if copy information needs to be read
         # from the changeset extras, we cannot take the fast path of using
         # filectxs from the old commit.
         if changes or changeset_copies:
             # Recompute copies (avoid recording a -> b -> a)
             copied = copies.pathcopies(base, wctx)
             if old.p2():
                 copied.update(copies.pathcopies(old.p2(), wctx))
 
             # Prune files which were reverted by the updates: if old
             # introduced file X and the file was renamed in the working
             # copy, then those two files are the same and
             # we can discard X from our list of files. Likewise if X
             # was removed, it's no longer relevant. If X is missing (aka
             # deleted), old X must be preserved.
             files.update(filestoamend)
             files = [
                 f
                 for f in files
                 if (f not in filestoamend or not samefile(f, wctx, base))
             ]
 
             def filectxfn(repo, ctx_, path):
                 try:
                     # If the file being considered is not amongst the files
                     # to be amended, we should use the file context from the
                     # old changeset. This avoids issues when only some files in
                     # the working copy are being amended but there are also
                     # changes to other files from the old changeset.
                     if path in filestoamend:
                         # Return None for removed files.
                         if path in wctx.removed():
                             return None
                         fctx = wctx[path]
                     else:
                         fctx = old.filectx(path)
                     flags = fctx.flags()
                     mctx = context.memfilectx(
                         repo,
                         ctx_,
                         fctx.path(),
                         fctx.data(),
                         islink=b'l' in flags,
                         isexec=b'x' in flags,
                         copysource=copied.get(path),
                     )
                     return mctx
                 except KeyError:
                     return None
 
         else:
             ui.note(_(b'copying changeset %s to %s\n') % (old, base))
 
             # Use version of files as in the old cset
             def filectxfn(repo, ctx_, path):
                 try:
                     return old.filectx(path)
                 except KeyError:
                     return None
 
         # See if we got a message from -m or -l, if not, open the editor with
         # the message of the changeset to amend.
         message = logmessage(ui, opts)
 
         editform = mergeeditform(old, b'commit.amend')
 
         if not message:
             message = old.description()
             # Default if message isn't provided and --edit is not passed is to
             # invoke editor, but allow --no-edit. If somehow we don't have any
             # description, let's always start the editor.
             doedit = not message or opts.get(b'edit') in [True, None]
         else:
             # Default if message is provided is to not invoke editor, but allow
             # --edit.
             doedit = opts.get(b'edit') is True
         editor = getcommiteditor(edit=doedit, editform=editform)
 
         pureextra = extra.copy()
         extra[b'amend_source'] = old.hex()
 
         new = context.memctx(
             repo,
             parents=[base.node(), old.p2().node()],
             text=message,
             files=files,
             filectxfn=filectxfn,
             user=user,
             date=date,
             extra=extra,
             editor=editor,
         )
 
         newdesc = changelog.stripdesc(new.description())
         if (
             (not changes)
             and newdesc == old.description()
             and user == old.user()
             and (date == old.date() or datemaydiffer)
             and pureextra == old.extra()
         ):
             # nothing changed. continuing here would create a new node
             # anyway because of the amend_source noise.
             #
             # This not what we expect from amend.
             return old.node()
 
         commitphase = None
         if opts.get(b'secret'):
             commitphase = phases.secret
         elif opts.get(b'draft'):
             commitphase = phases.draft
         newid = repo.commitctx(new)
         ms.reset()
 
         with repo.dirstate.changing_parents(repo):
             # Reroute the working copy parent to the new changeset
             repo.setparents(newid, repo.nullid)
 
             # Fixing the dirstate because localrepo.commitctx does not update
             # it. This is rather convenient because we did not need to update
             # the dirstate for all the files in the new commit which commitctx
             # could have done if it updated the dirstate. Now, we can
             # selectively update the dirstate only for the amended files.
             dirstate = repo.dirstate
 
             # Update the state of the files which were added and modified in the
             # amend to "normal" in the dirstate. We need to use "normallookup" since
             # the files may have changed since the command started; using "normal"
             # would mark them as clean but with uncommitted contents.
             normalfiles = set(wctx.modified() + wctx.added()) & filestoamend
             for f in normalfiles:
                 dirstate.update_file(
                     f, p1_tracked=True, wc_tracked=True, possibly_dirty=True
                 )
 
             # Update the state of files which were removed in the amend
             # to "removed" in the dirstate.
             removedfiles = set(wctx.removed()) & filestoamend
             for f in removedfiles:
                 dirstate.update_file(f, p1_tracked=False, wc_tracked=False)
 
         mapping = {old.node(): (newid,)}
         obsmetadata = None
         if opts.get(b'note'):
             obsmetadata = {b'note': encoding.fromlocal(opts[b'note'])}
         backup = ui.configbool(b'rewrite', b'backup-bundle')
         scmutil.cleanupnodes(
             repo,
             mapping,
             b'amend',
             metadata=obsmetadata,
             fixphase=True,
             targetphase=commitphase,
             backup=backup,
         )
 
     return newid
 
 
 def commiteditor(repo, ctx, subs, editform=b''):
     if ctx.description():
         return ctx.description()
     return commitforceeditor(
         repo, ctx, subs, editform=editform, unchangedmessagedetection=True
     )
 
 
 def commitforceeditor(
     repo,
     ctx,
     subs,
     finishdesc=None,
     extramsg=None,
     editform=b'',
     unchangedmessagedetection=False,
 ):
     if not extramsg:
         extramsg = _(b"Leave message empty to abort commit.")
 
     forms = [e for e in editform.split(b'.') if e]
     forms.insert(0, b'changeset')
     templatetext = None
     while forms:
         ref = b'.'.join(forms)
         if repo.ui.config(b'committemplate', ref):
             templatetext = committext = buildcommittemplate(
                 repo, ctx, subs, extramsg, ref
             )
             break
         forms.pop()
     else:
         committext = buildcommittext(repo, ctx, subs, extramsg)
 
     # run editor in the repository root
     olddir = encoding.getcwd()
     os.chdir(repo.root)
 
     # make in-memory changes visible to external process
     tr = repo.currenttransaction()
     repo.dirstate.write(tr)
     pending = tr and tr.writepending() and repo.root
 
     editortext = repo.ui.edit(
         committext,
         ctx.user(),
         ctx.extra(),
         editform=editform,
         pending=pending,
         repopath=repo.path,
         action=b'commit',
     )
     text = editortext
 
     # strip away anything below this special string (used for editors that want
     # to display the diff)
     stripbelow = re.search(_linebelow, text, flags=re.MULTILINE)
     if stripbelow:
         text = text[: stripbelow.start()]
 
     text = re.sub(b"(?m)^HG:.*(\n|$)", b"", text)
     os.chdir(olddir)
 
     if finishdesc:
         text = finishdesc(text)
     if not text.strip():
         raise error.InputError(_(b"empty commit message"))
     if unchangedmessagedetection and editortext == templatetext:
         raise error.InputError(_(b"commit message unchanged"))
 
     return text
 
 
 def buildcommittemplate(repo, ctx, subs, extramsg, ref):
     ui = repo.ui
     spec = formatter.reference_templatespec(ref)
     t = logcmdutil.changesettemplater(ui, repo, spec)
     t.t.cache.update(
         (k, templater.unquotestring(v))
         for k, v in repo.ui.configitems(b'committemplate')
     )
 
     if not extramsg:
         extramsg = b''  # ensure that extramsg is string
 
     ui.pushbuffer()
     t.show(ctx, extramsg=extramsg)
     return ui.popbuffer()
 
 
 def hgprefix(msg):
     return b"\n".join([b"HG: %s" % a for a in msg.split(b"\n") if a])
 
 
 def buildcommittext(repo, ctx, subs, extramsg):
     edittext = []
     modified, added, removed = ctx.modified(), ctx.added(), ctx.removed()
     if ctx.description():
         edittext.append(ctx.description())
     edittext.append(b"")
     edittext.append(b"")  # Empty line between message and comments.
     edittext.append(
         hgprefix(
             _(
                 b"Enter commit message."
                 b"  Lines beginning with 'HG:' are removed."
             )
         )
     )
     edittext.append(hgprefix(extramsg))
     edittext.append(b"HG: --")
     edittext.append(hgprefix(_(b"user: %s") % ctx.user()))
     if ctx.p2():
         edittext.append(hgprefix(_(b"branch merge")))
     if ctx.branch():
         edittext.append(hgprefix(_(b"branch '%s'") % ctx.branch()))
     if bookmarks.isactivewdirparent(repo):
         edittext.append(hgprefix(_(b"bookmark '%s'") % repo._activebookmark))
     edittext.extend([hgprefix(_(b"subrepo %s") % s) for s in subs])
     edittext.extend([hgprefix(_(b"added %s") % f) for f in added])
     edittext.extend([hgprefix(_(b"changed %s") % f) for f in modified])
     edittext.extend([hgprefix(_(b"removed %s") % f) for f in removed])
     if not added and not modified and not removed:
         edittext.append(hgprefix(_(b"no files changed")))
     edittext.append(b"")
 
     return b"\n".join(edittext)
 
 
 def commitstatus(repo, node, branch, bheads=None, tip=None, **opts):
     ctx = repo[node]
     parents = ctx.parents()
 
     if tip is not None and repo.changelog.tip() == tip:
         # avoid reporting something like "committed new head" when
         # recommitting old changesets, and issue a helpful warning
         # for most instances
         repo.ui.warn(_(b"warning: commit already existed in the repository!\n"))
     elif (
         not opts.get('amend')
         and bheads
         and node not in bheads
         and not any(
             p.node() in bheads and p.branch() == branch for p in parents
         )
     ):
         repo.ui.status(_(b'created new head\n'))
         # The message is not printed for initial roots. For the other
         # changesets, it is printed in the following situations:
         #
         # Par column: for the 2 parents with ...
         #   N: null or no parent
         #   B: parent is on another named branch
         #   C: parent is a regular non head changeset
         #   H: parent was a branch head of the current branch
         # Msg column: whether we print "created new head" message
         # In the following, it is assumed that there already exists some
         # initial branch heads of the current branch, otherwise nothing is
         # printed anyway.
         #
         # Par Msg Comment
         # N N  y  additional topo root
         #
         # B N  y  additional branch root
         # C N  y  additional topo head
         # H N  n  usual case
         #
         # B B  y  weird additional branch root
         # C B  y  branch merge
         # H B  n  merge with named branch
         #
         # C C  y  additional head from merge
         # C H  n  merge with a head
         #
         # H H  n  head merge: head count decreases
 
     if not opts.get('close_branch'):
         for r in parents:
             if r.closesbranch() and r.branch() == branch:
                 repo.ui.status(
                     _(b'reopening closed branch head %d\n') % r.rev()
                 )
 
     if repo.ui.debugflag:
         repo.ui.write(
             _(b'committed changeset %d:%s\n') % (ctx.rev(), ctx.hex())
         )
     elif repo.ui.verbose:
         repo.ui.write(_(b'committed changeset %d:%s\n') % (ctx.rev(), ctx))
 
 
 def postcommitstatus(repo, pats, opts):
     return repo.status(match=scmutil.match(repo[None], pats, opts))
 
 
 def revert(ui, repo, ctx, *pats, **opts):
     opts = pycompat.byteskwargs(opts)
     parent, p2 = repo.dirstate.parents()
     node = ctx.node()
 
     mf = ctx.manifest()
     if node == p2:
         parent = p2
 
     # need all matching names in dirstate and manifest of target rev,
     # so have to walk both. do not print errors if files exist in one
     # but not other. in both cases, filesets should be evaluated against
     # workingctx to get consistent result (issue4497). this means 'set:**'
     # cannot be used to select missing files from target rev.
 
     # `names` is a mapping for all elements in working copy and target revision
     # The mapping is in the form:
     #   <abs path in repo> -> (<path from CWD>, <exactly specified by matcher?>)
     names = {}
     uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
 
     with repo.wlock(), repo.dirstate.changing_files(repo):
         ## filling of the `names` mapping
         # walk dirstate to fill `names`
 
         interactive = opts.get(b'interactive', False)
         wctx = repo[None]
         m = scmutil.match(wctx, pats, opts)
 
         # we'll need this later
         targetsubs = sorted(s for s in wctx.substate if m(s))
 
         if not m.always():
             matcher = matchmod.badmatch(m, lambda x, y: False)
             for abs in wctx.walk(matcher):
                 names[abs] = m.exact(abs)
 
             # walk target manifest to fill `names`
 
             def badfn(path, msg):
                 if path in names:
                     return
                 if path in ctx.substate:
                     return
                 path_ = path + b'/'
                 for f in names:
                     if f.startswith(path_):
                         return
                 ui.warn(b"%s: %s\n" % (uipathfn(path), msg))
 
             for abs in ctx.walk(matchmod.badmatch(m, badfn)):
                 if abs not in names:
                     names[abs] = m.exact(abs)
 
             # Find status of all file in `names`.
             m = scmutil.matchfiles(repo, names)
 
             changes = repo.status(
                 node1=node, match=m, unknown=True, ignored=True, clean=True
             )
         else:
             changes = repo.status(node1=node, match=m)
             for kind in changes:
                 for abs in kind:
                     names[abs] = m.exact(abs)
 
             m = scmutil.matchfiles(repo, names)
 
         modified = set(changes.modified)
         added = set(changes.added)
         removed = set(changes.removed)
         _deleted = set(changes.deleted)
         unknown = set(changes.unknown)
         unknown.update(changes.ignored)
         clean = set(changes.clean)
         modadded = set()
 
         # We need to account for the state of the file in the dirstate,
         # even when we revert against something else than parent. This will
         # slightly alter the behavior of revert (doing back up or not, delete
         # or just forget etc).
         if parent == node:
             dsmodified = modified
             dsadded = added
             dsremoved = removed
             # store all local modifications, useful later for rename detection
             localchanges = dsmodified | dsadded
             modified, added, removed = set(), set(), set()
         else:
             changes = repo.status(node1=parent, match=m)
             dsmodified = set(changes.modified)
             dsadded = set(changes.added)
             dsremoved = set(changes.removed)
             # store all local modifications, useful later for rename detection
             localchanges = dsmodified | dsadded
 
             # only take into account for removes between wc and target
             clean |= dsremoved - removed
             dsremoved &= removed
             # distinct between dirstate remove and other
             removed -= dsremoved
 
             modadded = added & dsmodified
             added -= modadded
 
             # tell newly modified apart.
             dsmodified &= modified
             dsmodified |= modified & dsadded  # dirstate added may need backup
             modified -= dsmodified
 
             # We need to wait for some post-processing to update this set
             # before making the distinction. The dirstate will be used for
             # that purpose.
             dsadded = added
 
         # in case of merge, files that are actually added can be reported as
         # modified, we need to post process the result
         if p2 != repo.nullid:
             mergeadd = set(dsmodified)
             for path in dsmodified:
                 if path in mf:
                     mergeadd.remove(path)
             dsadded |= mergeadd
             dsmodified -= mergeadd
 
         # if f is a rename, update `names` to also revert the source
         for f in localchanges:
             src = repo.dirstate.copied(f)
             # XXX should we check for rename down to target node?
             if (
                 src
                 and src not in names
                 and repo.dirstate.get_entry(src).removed
             ):
                 dsremoved.add(src)
                 names[src] = True
 
         # determine the exact nature of the deleted changesets
         deladded = set(_deleted)
         for path in _deleted:
             if path in mf:
                 deladded.remove(path)
         deleted = _deleted - deladded
 
         # distinguish between file to forget and the other
         added = set()
         for abs in dsadded:
             if not repo.dirstate.get_entry(abs).added:
                 added.add(abs)
         dsadded -= added
 
         for abs in deladded:
             if repo.dirstate.get_entry(abs).added:
                 dsadded.add(abs)
         deladded -= dsadded
 
         # For files marked as removed, we check if an unknown file is present at
         # the same path. If a such file exists it may need to be backed up.
         # Making the distinction at this stage helps have simpler backup
         # logic.
         removunk = set()
         for abs in removed:
             target = repo.wjoin(abs)
             if os.path.lexists(target):
                 removunk.add(abs)
         removed -= removunk
 
         dsremovunk = set()
         for abs in dsremoved:
             target = repo.wjoin(abs)
             if os.path.lexists(target):
                 dsremovunk.add(abs)
         dsremoved -= dsremovunk
 
         # action to be actually performed by revert
         # (<list of file>, message>) tuple
         actions = {
             b'revert': ([], _(b'reverting %s\n')),
             b'add': ([], _(b'adding %s\n')),
             b'remove': ([], _(b'removing %s\n')),
             b'drop': ([], _(b'removing %s\n')),
             b'forget': ([], _(b'forgetting %s\n')),
             b'undelete': ([], _(b'undeleting %s\n')),
             b'noop': (None, _(b'no changes needed to %s\n')),
             b'unknown': (None, _(b'file not managed: %s\n')),
         }
 
         # "constant" that convey the backup strategy.
         # All set to `discard` if `no-backup` is set do avoid checking
         # no_backup lower in the code.
         # These values are ordered for comparison purposes
         backupinteractive = 3  # do backup if interactively modified
         backup = 2  # unconditionally do backup
         check = 1  # check if the existing file differs from target
         discard = 0  # never do backup
         if opts.get(b'no_backup'):
             backupinteractive = backup = check = discard
         if interactive:
             dsmodifiedbackup = backupinteractive
         else:
             dsmodifiedbackup = backup
         tobackup = set()
 
         backupanddel = actions[b'remove']
         if not opts.get(b'no_backup'):
             backupanddel = actions[b'drop']
 
         disptable = (
             # dispatch table:
             #   file state
             #   action
             #   make backup
             ## Sets that results that will change file on disk
             # Modified compared to target, no local change
             (modified, actions[b'revert'], discard),
             # Modified compared to target, but local file is deleted
             (deleted, actions[b'revert'], discard),
             # Modified compared to target, local change
             (dsmodified, actions[b'revert'], dsmodifiedbackup),
             # Added since target
             (added, actions[b'remove'], discard),
             # Added in working directory
             (dsadded, actions[b'forget'], discard),
             # Added since target, have local modification
             (modadded, backupanddel, backup),
             # Added since target but file is missing in working directory
             (deladded, actions[b'drop'], discard),
             # Removed since  target, before working copy parent
             (removed, actions[b'add'], discard),
             # Same as `removed` but an unknown file exists at the same path
             (removunk, actions[b'add'], check),
             # Removed since targe, marked as such in working copy parent
             (dsremoved, actions[b'undelete'], discard),
             # Same as `dsremoved` but an unknown file exists at the same path
             (dsremovunk, actions[b'undelete'], check),
             ## the following sets does not result in any file changes
             # File with no modification
             (clean, actions[b'noop'], discard),
             # Existing file, not tracked anywhere
             (unknown, actions[b'unknown'], discard),
         )
 
         for abs, exact in sorted(names.items()):
             # target file to be touch on disk (relative to cwd)
             target = repo.wjoin(abs)
             # search the entry in the dispatch table.
             # if the file is in any of these sets, it was touched in the working
             # directory parent and we are sure it needs to be reverted.
             for table, (xlist, msg), dobackup in disptable:
                 if abs not in table:
                     continue
                 if xlist is not None:
                     xlist.append(abs)
                     if dobackup:
                         # If in interactive mode, don't automatically create
                         # .orig files (issue4793)
                         if dobackup == backupinteractive:
                             tobackup.add(abs)
                         elif backup <= dobackup or wctx[abs].cmp(ctx[abs]):
                             absbakname = scmutil.backuppath(ui, repo, abs)
                             bakname = os.path.relpath(
                                 absbakname, start=repo.root
                             )
                             ui.note(
                                 _(b'saving current version of %s as %s\n')
                                 % (uipathfn(abs), uipathfn(bakname))
                             )
                             if not opts.get(b'dry_run'):
                                 if interactive:
                                     util.copyfile(target, absbakname)
                                 else:
                                     util.rename(target, absbakname)
                     if opts.get(b'dry_run'):
                         if ui.verbose or not exact:
                             ui.status(msg % uipathfn(abs))
                 elif exact:
                     ui.warn(msg % uipathfn(abs))
                 break
 
         if not opts.get(b'dry_run'):
             needdata = (b'revert', b'add', b'undelete')
             oplist = [actions[name][0] for name in needdata]
             prefetch = scmutil.prefetchfiles
             matchfiles = scmutil.matchfiles(
                 repo, [f for sublist in oplist for f in sublist]
             )
             prefetch(
                 repo,
                 [(ctx.rev(), matchfiles)],
             )
             match = scmutil.match(repo[None], pats)
             _performrevert(
                 repo,
                 ctx,
                 names,
                 uipathfn,
                 actions,
                 match,
                 interactive,
                 tobackup,
             )
 
         if targetsubs:
             # Revert the subrepos on the revert list
             for sub in targetsubs:
                 try:
                     wctx.sub(sub).revert(
                         ctx.substate[sub], *pats, **pycompat.strkwargs(opts)
                     )
                 except KeyError:
                     raise error.Abort(
                         b"subrepository '%s' does not exist in %s!"
                         % (sub, short(ctx.node()))
                     )
 
 
 def _performrevert(
     repo,
     ctx,
     names,
     uipathfn,
     actions,
     match,
     interactive=False,
     tobackup=None,
 ):
     """function that actually perform all the actions computed for revert
 
     This is an independent function to let extension to plug in and react to
     the imminent revert.
 
     Make sure you have the working directory locked when calling this function.
     """
     parent, p2 = repo.dirstate.parents()
     node = ctx.node()
     excluded_files = []
 
     def checkout(f):
         fc = ctx[f]
         repo.wwrite(f, fc.data(), fc.flags())
 
     def doremove(f):
         try:
             rmdir = repo.ui.configbool(b'experimental', b'removeemptydirs')
             repo.wvfs.unlinkpath(f, rmdir=rmdir)
         except OSError:
             pass
         repo.dirstate.set_untracked(f)
 
     def prntstatusmsg(action, f):
         exact = names[f]
         if repo.ui.verbose or not exact:
             repo.ui.status(actions[action][1] % uipathfn(f))
 
     audit_path = pathutil.pathauditor(repo.root, cached=True)
     for f in actions[b'forget'][0]:
         if interactive:
             choice = repo.ui.promptchoice(
                 _(b"forget added file %s (Yn)?$$ &Yes $$ &No") % uipathfn(f)
             )
             if choice == 0:
                 prntstatusmsg(b'forget', f)
                 repo.dirstate.set_untracked(f)
             else:
                 excluded_files.append(f)
         else:
             prntstatusmsg(b'forget', f)
             repo.dirstate.set_untracked(f)
     for f in actions[b'remove'][0]:
         audit_path(f)
         if interactive:
             choice = repo.ui.promptchoice(
                 _(b"remove added file %s (Yn)?$$ &Yes $$ &No") % uipathfn(f)
             )
             if choice == 0:
                 prntstatusmsg(b'remove', f)
                 doremove(f)
             else:
                 excluded_files.append(f)
         else:
             prntstatusmsg(b'remove', f)
             doremove(f)
     for f in actions[b'drop'][0]:
         audit_path(f)
         prntstatusmsg(b'drop', f)
         repo.dirstate.set_untracked(f)
 
     # We are reverting to our parent. If possible, we had like `hg status`
     # to report the file as clean. We have to be less agressive for
     # merges to avoid losing information about copy introduced by the merge.
     # This might comes with bugs ?
     reset_copy = p2 == repo.nullid
 
     def normal(filename):
         return repo.dirstate.set_tracked(filename, reset_copy=reset_copy)
 
     newlyaddedandmodifiedfiles = set()
     if interactive:
         # Prompt the user for changes to revert
         torevert = [f for f in actions[b'revert'][0] if f not in excluded_files]
         m = scmutil.matchfiles(repo, torevert)
         diffopts = patch.difffeatureopts(
             repo.ui,
             whitespace=True,
             section=b'commands',
             configprefix=b'revert.interactive.',
         )
         diffopts.nodates = True
         diffopts.git = True
         operation = b'apply'
         if node == parent:
             if repo.ui.configbool(
                 b'experimental', b'revert.interactive.select-to-keep'
             ):
                 operation = b'keep'
             else:
                 operation = b'discard'
 
         if operation == b'apply':
             diff = patch.diff(repo, None, ctx.node(), m, opts=diffopts)
         else:
             diff = patch.diff(repo, ctx.node(), None, m, opts=diffopts)
         original_headers = patch.parsepatch(diff)
 
         try:
 
             chunks, opts = recordfilter(
                 repo.ui, original_headers, match, operation=operation
             )
             if operation == b'discard':
                 chunks = patch.reversehunks(chunks)
 
         except error.PatchParseError as err:
             raise error.InputError(_(b'error parsing patch: %s') % err)
         except error.PatchApplicationError as err:
             raise error.StateError(_(b'error applying patch: %s') % err)
 
         # FIXME: when doing an interactive revert of a copy, there's no way of
         # performing a partial revert of the added file, the only option is
         # "remove added file <name> (Yn)?", so we don't need to worry about the
         # alsorestore value. Ideally we'd be able to partially revert
         # copied/renamed files.
         newlyaddedandmodifiedfiles, unusedalsorestore = newandmodified(chunks)
         if tobackup is None:
             tobackup = set()
         # Apply changes
         fp = stringio()
         # chunks are serialized per file, but files aren't sorted
         for f in sorted({c.header.filename() for c in chunks if ishunk(c)}):
             prntstatusmsg(b'revert', f)
         files = set()
         for c in chunks:
             if ishunk(c):
                 abs = c.header.filename()
                 # Create a backup file only if this hunk should be backed up
                 if c.header.filename() in tobackup:
                     target = repo.wjoin(abs)
                     bakname = scmutil.backuppath(repo.ui, repo, abs)
                     util.copyfile(target, bakname)
                     tobackup.remove(abs)
                 if abs not in files:
                     files.add(abs)
                     if operation == b'keep':
                         checkout(abs)
             c.write(fp)
         dopatch = fp.tell()
         fp.seek(0)
         if dopatch:
             try:
                 patch.internalpatch(repo.ui, repo, fp, 1, eolmode=None)
             except error.PatchParseError as err:
                 raise error.InputError(pycompat.bytestr(err))
             except error.PatchApplicationError as err:
                 raise error.StateError(pycompat.bytestr(err))
         del fp
     else:
         for f in actions[b'revert'][0]:
             prntstatusmsg(b'revert', f)
             checkout(f)
             if normal:
                 normal(f)
 
     for f in actions[b'add'][0]:
         # Don't checkout modified files, they are already created by the diff
         if f in newlyaddedandmodifiedfiles:
             continue
 
         if interactive:
             choice = repo.ui.promptchoice(
                 _(b"add new file %s (Yn)?$$ &Yes $$ &No") % uipathfn(f)
             )
             if choice != 0:
                 continue
         prntstatusmsg(b'add', f)
         checkout(f)
         repo.dirstate.set_tracked(f)
 
     for f in actions[b'undelete'][0]:
         if interactive:
             choice = repo.ui.promptchoice(
                 _(b"add back removed file %s (Yn)?$$ &Yes $$ &No") % f
             )
             if choice == 0:
                 prntstatusmsg(b'undelete', f)
                 checkout(f)
                 normal(f)
             else:
                 excluded_files.append(f)
         else:
             prntstatusmsg(b'undelete', f)
             checkout(f)
             normal(f)
 
     copied = copies.pathcopies(repo[parent], ctx)
 
     for f in (
         actions[b'add'][0] + actions[b'undelete'][0] + actions[b'revert'][0]
     ):
         if f in copied:
             repo.dirstate.copy(copied[f], f)
 
 
 # a list of (ui, repo, otherpeer, opts, missing) functions called by
 # commands.outgoing.  "missing" is "missing" of the result of
 # "findcommonoutgoing()"
 outgoinghooks = util.hooks()
 
 # a list of (ui, repo) functions called by commands.summary
 summaryhooks = util.hooks()
 
 # a list of (ui, repo, opts, changes) functions called by commands.summary.
 #
 # functions should return tuple of booleans below, if 'changes' is None:
 #  (whether-incomings-are-needed, whether-outgoings-are-needed)
 #
 # otherwise, 'changes' is a tuple of tuples below:
 #  - (sourceurl, sourcebranch, sourcepeer, incoming)
 #  - (desturl,   destbranch,   destpeer,   outgoing)
 summaryremotehooks = util.hooks()
 
 
 def checkunfinished(repo, commit=False, skipmerge=False):
     """Look for an unfinished multistep operation, like graft, and abort
     if found. It's probably good to check this right before
     bailifchanged().
     """
     # Check for non-clearable states first, so things like rebase will take
     # precedence over update.
     for state in statemod._unfinishedstates:
         if (
             state._clearable
             or (commit and state._allowcommit)
             or state._reportonly
         ):
             continue
         if state.isunfinished(repo):
             raise error.StateError(state.msg(), hint=state.hint())
 
     for s in statemod._unfinishedstates:
         if (
             not s._clearable
             or (commit and s._allowcommit)
             or (s._opname == b'merge' and skipmerge)
             or s._reportonly
         ):
             continue
         if s.isunfinished(repo):
             raise error.StateError(s.msg(), hint=s.hint())
 
 
 def clearunfinished(repo):
     """Check for unfinished operations (as above), and clear the ones
     that are clearable.
     """
     for state in statemod._unfinishedstates:
         if state._reportonly:
             continue
         if not state._clearable and state.isunfinished(repo):
             raise error.StateError(state.msg(), hint=state.hint())
 
     for s in statemod._unfinishedstates:
         if s._opname == b'merge' or s._reportonly:
             continue
         if s._clearable and s.isunfinished(repo):
             util.unlink(repo.vfs.join(s._fname))
 
 
 def getunfinishedstate(repo):
     """Checks for unfinished operations and returns statecheck object
     for it"""
     for state in statemod._unfinishedstates:
         if state.isunfinished(repo):
             return state
     return None
 
 
 def howtocontinue(repo):
     """Check for an unfinished operation and return the command to finish
     it.
 
     statemod._unfinishedstates list is checked for an unfinished operation
     and the corresponding message to finish it is generated if a method to
     continue is supported by the operation.
 
     Returns a (msg, warning) tuple. 'msg' is a string and 'warning' is
     a boolean.
     """
     contmsg = _(b"continue: %s")
     for state in statemod._unfinishedstates:
         if not state._continueflag:
             continue
         if state.isunfinished(repo):
             return contmsg % state.continuemsg(), True
     if repo[None].dirty(missing=True, merge=False, branch=False):
         return contmsg % _(b"hg commit"), False
     return None, None
 
 
 def checkafterresolved(repo):
     """Inform the user about the next action after completing hg resolve
 
     If there's a an unfinished operation that supports continue flag,
     howtocontinue will yield repo.ui.warn as the reporter.
 
     Otherwise, it will yield repo.ui.note.
     """
     msg, warning = howtocontinue(repo)
     if msg is not None:
         if warning:
             repo.ui.warn(b"%s\n" % msg)
         else:
             repo.ui.note(b"%s\n" % msg)
 
 
 def wrongtooltocontinue(repo, task):
     """Raise an abort suggesting how to properly continue if there is an
     active task.
 
     Uses howtocontinue() to find the active task.
 
     If there's no task (repo.ui.note for 'hg commit'), it does not offer
     a hint.
     """
     after = howtocontinue(repo)
     hint = None
     if after[1]:
         hint = after[0]
     raise error.StateError(_(b'no %s in progress') % task, hint=hint)
 
 
 def abortgraft(ui, repo, graftstate):
     """abort the interrupted graft and rollbacks to the state before interrupted
     graft"""
     if not graftstate.exists():
         raise error.StateError(_(b"no interrupted graft to abort"))
     statedata = readgraftstate(repo, graftstate)
     newnodes = statedata.get(b'newnodes')
     if newnodes is None:
         # and old graft state which does not have all the data required to abort
         # the graft
         raise error.Abort(_(b"cannot abort using an old graftstate"))
 
     # changeset from which graft operation was started
     if len(newnodes) > 0:
         startctx = repo[newnodes[0]].p1()
     else:
         startctx = repo[b'.']
     # whether to strip or not
     cleanup = False
 
     if newnodes:
         newnodes = [repo[r].rev() for r in newnodes]
         cleanup = True
         # checking that none of the newnodes turned public or is public
         immutable = [c for c in newnodes if not repo[c].mutable()]
         if immutable:
             repo.ui.warn(
                 _(b"cannot clean up public changesets %s\n")
                 % b', '.join(bytes(repo[r]) for r in immutable),
                 hint=_(b"see 'hg help phases' for details"),
             )
             cleanup = False
 
         # checking that no new nodes are created on top of grafted revs
         desc = set(repo.changelog.descendants(newnodes))
         if desc - set(newnodes):
             repo.ui.warn(
                 _(
                     b"new changesets detected on destination "
                     b"branch, can't strip\n"
                 )
             )
             cleanup = False
 
         if cleanup:
             with repo.wlock(), repo.lock():
                 mergemod.clean_update(startctx)
                 # stripping the new nodes created
                 strippoints = [
                     c.node() for c in repo.set(b"roots(%ld)", newnodes)
                 ]
                 repair.strip(repo.ui, repo, strippoints, backup=False)
 
     if not cleanup:
         # we don't update to the startnode if we can't strip
         startctx = repo[b'.']
         mergemod.clean_update(startctx)
 
     ui.status(_(b"graft aborted\n"))
     ui.status(_(b"working directory is now at %s\n") % startctx.hex()[:12])
     graftstate.delete()
     return 0
 
 
 def readgraftstate(repo, graftstate):
     # type: (Any, statemod.cmdstate) -> Dict[bytes, Any]
     """read the graft state file and return a dict of the data stored in it"""
     try:
         return graftstate.read()
     except error.CorruptedState:
         nodes = repo.vfs.read(b'graftstate').splitlines()
         return {b'nodes': nodes}
 
 
 def hgabortgraft(ui, repo):
     """abort logic for aborting graft using 'hg abort'"""
     with repo.wlock():
         graftstate = statemod.cmdstate(repo, b'graftstate')
         return abortgraft(ui, repo, graftstate)

mercurial/encoding.py

@@ -1,738 +1,738 b''
 # encoding.py - character transcoding support for Mercurial
 #
 #  Copyright 2005-2009 Olivia Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import locale
 import os
 import re
+import typing
 import unicodedata
 
+from typing import (
+    Any,
+    Callable,
+    List,
+    Text,
+    Type,
+    TypeVar,
+    Union,
+)
+
 from . import (
     error,
     policy,
     pycompat,
 )
 
 from .pure import charencode as charencodepure
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Any,
-        Callable,
-        List,
-        Text,
-        Type,
-        TypeVar,
-        Union,
-    )
+# keep pyflakes happy
+for t in (Any, Callable, List, Text, Type, Union):
+    assert t
 
-    # keep pyflakes happy
-    for t in (Any, Callable, List, Text, Type, Union):
-        assert t
-
-    _Tlocalstr = TypeVar('_Tlocalstr', bound='localstr')
+_Tlocalstr = TypeVar('_Tlocalstr', bound='localstr')
 
 charencode = policy.importmod('charencode')
 
 isasciistr = charencode.isasciistr
 asciilower = charencode.asciilower
 asciiupper = charencode.asciiupper
 _jsonescapeu8fast = charencode.jsonescapeu8fast
 
 _sysstr = pycompat.sysstr
 
 unichr = chr
 
 # These unicode characters are ignored by HFS+ (Apple Technote 1150,
 # "Unicode Subtleties"), so we need to ignore them in some places for
 # sanity.
 _ignore = [
     unichr(int(x, 16)).encode("utf-8")
     for x in b"200c 200d 200e 200f 202a 202b 202c 202d 202e "
     b"206a 206b 206c 206d 206e 206f feff".split()
 ]
 # verify the next function will work
 assert all(i.startswith((b"\xe2", b"\xef")) for i in _ignore)
 
 
 def hfsignoreclean(s):
     # type: (bytes) -> bytes
     """Remove codepoints ignored by HFS+ from s.
 
     >>> hfsignoreclean(u'.h\u200cg'.encode('utf-8'))
     '.hg'
     >>> hfsignoreclean(u'.h\ufeffg'.encode('utf-8'))
     '.hg'
     """
     if b"\xe2" in s or b"\xef" in s:
         for c in _ignore:
             s = s.replace(c, b'')
     return s
 
 
 # encoding.environ is provided read-only, which may not be used to modify
 # the process environment
 _nativeenviron = os.supports_bytes_environ
 if _nativeenviron:
     environ = os.environb  # re-exports
     if pycompat.sysplatform == b'OpenVMS':
         # workaround for a bug in VSI 3.10 port
         # os.environb is only populated with a few Predefined symbols
         def newget(self, key, default=None):
             # pytype on linux does not understand OpenVMS special modules
             import _decc  # pytype: disable=import-error
 
             v = _decc.getenv(key, None)
             if isinstance(key, bytes):
                 return default if v is None else v.encode('latin-1')
             else:
                 return default if v is None else v
 
         environ.__class__.get = newget
 else:
     # preferred encoding isn't known yet; use utf-8 to avoid unicode error
     # and recreate it once encoding is settled
     environ = {
         k.encode('utf-8'): v.encode('utf-8')
         for k, v in os.environ.items()  # re-exports
     }
 
 _encodingrewrites = {
     b'646': b'ascii',
     b'ANSI_X3.4-1968': b'ascii',
 }
 # cp65001 is a Windows variant of utf-8, which isn't supported on Python 2.
 # No idea if it should be rewritten to the canonical name 'utf-8' on Python 3.
 # https://bugs.python.org/issue13216
 if pycompat.iswindows:
     _encodingrewrites[b'cp65001'] = b'utf-8'
 
 try:
     encoding = environ.get(b"HGENCODING")
     if not encoding:
         encoding = locale.getpreferredencoding().encode('ascii') or b'ascii'
         encoding = _encodingrewrites.get(encoding, encoding)
 except locale.Error:
     encoding = b'ascii'
 encodingmode = environ.get(b"HGENCODINGMODE", b"strict")
 fallbackencoding = b'ISO-8859-1'
 
 
 class localstr(bytes):
     """This class allows strings that are unmodified to be
     round-tripped to the local encoding and back"""
 
     def __new__(cls, u, l):
         s = bytes.__new__(cls, l)
         s._utf8 = u
         return s
 
-    if pycompat.TYPE_CHECKING:
+    if typing.TYPE_CHECKING:
         # pseudo implementation to help pytype see localstr() constructor
         def __init__(self, u, l):
             # type: (bytes, bytes) -> None
             super(localstr, self).__init__(l)
             self._utf8 = u
 
     def __hash__(self):
         return hash(self._utf8)  # avoid collisions in local string space
 
 
 class safelocalstr(bytes):
     """Tagged string denoting it was previously an internal UTF-8 string,
     and can be converted back to UTF-8 losslessly
 
     >>> assert safelocalstr(b'\\xc3') == b'\\xc3'
     >>> assert b'\\xc3' == safelocalstr(b'\\xc3')
     >>> assert b'\\xc3' in {safelocalstr(b'\\xc3'): 0}
     >>> assert safelocalstr(b'\\xc3') in {b'\\xc3': 0}
     """
 
 
 def tolocal(s):
     # type: (bytes) -> bytes
     """
     Convert a string from internal UTF-8 to local encoding
 
     All internal strings should be UTF-8 but some repos before the
     implementation of locale support may contain latin1 or possibly
     other character sets. We attempt to decode everything strictly
     using UTF-8, then Latin-1, and failing that, we use UTF-8 and
     replace unknown characters.
 
     The localstr class is used to cache the known UTF-8 encoding of
     strings next to their local representation to allow lossless
     round-trip conversion back to UTF-8.
 
     >>> u = b'foo: \\xc3\\xa4' # utf-8
     >>> l = tolocal(u)
     >>> l
     'foo: ?'
     >>> fromlocal(l)
     'foo: \\xc3\\xa4'
     >>> u2 = b'foo: \\xc3\\xa1'
     >>> d = { l: 1, tolocal(u2): 2 }
     >>> len(d) # no collision
     2
     >>> b'foo: ?' in d
     False
     >>> l1 = b'foo: \\xe4' # historical latin1 fallback
     >>> l = tolocal(l1)
     >>> l
     'foo: ?'
     >>> fromlocal(l) # magically in utf-8
     'foo: \\xc3\\xa4'
     """
 
     if isasciistr(s):
         return s
 
     try:
         try:
             # make sure string is actually stored in UTF-8
             u = s.decode('UTF-8')
             if encoding == b'UTF-8':
                 # fast path
                 return s
             r = u.encode(_sysstr(encoding), "replace")
             if u == r.decode(_sysstr(encoding)):
                 # r is a safe, non-lossy encoding of s
                 return safelocalstr(r)
             return localstr(s, r)
         except UnicodeDecodeError:
             # we should only get here if we're looking at an ancient changeset
             try:
                 u = s.decode(_sysstr(fallbackencoding))
                 r = u.encode(_sysstr(encoding), "replace")
                 if u == r.decode(_sysstr(encoding)):
                     # r is a safe, non-lossy encoding of s
                     return safelocalstr(r)
                 return localstr(u.encode('UTF-8'), r)
             except UnicodeDecodeError:
                 u = s.decode("utf-8", "replace")  # last ditch
                 # can't round-trip
                 return u.encode(_sysstr(encoding), "replace")
     except LookupError as k:
         raise error.Abort(
             pycompat.bytestr(k), hint=b"please check your locale settings"
         )
 
 
 def fromlocal(s):
     # type: (bytes) -> bytes
     """
     Convert a string from the local character encoding to UTF-8
 
     We attempt to decode strings using the encoding mode set by
     HGENCODINGMODE, which defaults to 'strict'. In this mode, unknown
     characters will cause an error message. Other modes include
     'replace', which replaces unknown characters with a special
     Unicode character, and 'ignore', which drops the character.
     """
 
     # can we do a lossless round-trip?
     if isinstance(s, localstr):
         return s._utf8
     if isasciistr(s):
         return s
 
     try:
         u = s.decode(_sysstr(encoding), _sysstr(encodingmode))
         return u.encode("utf-8")
     except UnicodeDecodeError as inst:
         sub = s[max(0, inst.start - 10) : inst.start + 10]
         raise error.Abort(
             b"decoding near '%s': %s!" % (sub, pycompat.bytestr(inst))
         )
     except LookupError as k:
         raise error.Abort(
             pycompat.bytestr(k), hint=b"please check your locale settings"
         )
 
 
 def unitolocal(u):
     # type: (Text) -> bytes
     """Convert a unicode string to a byte string of local encoding"""
     return tolocal(u.encode('utf-8'))
 
 
 def unifromlocal(s):
     # type: (bytes) -> Text
     """Convert a byte string of local encoding to a unicode string"""
     return fromlocal(s).decode('utf-8')
 
 
 def unimethod(bytesfunc):
     # type: (Callable[[Any], bytes]) -> Callable[[Any], Text]
     """Create a proxy method that forwards __unicode__() and __str__() of
     Python 3 to __bytes__()"""
 
     def unifunc(obj):
         return unifromlocal(bytesfunc(obj))
 
     return unifunc
 
 
 # converter functions between native str and byte string. use these if the
 # character encoding is not aware (e.g. exception message) or is known to
 # be locale dependent (e.g. date formatting.)
 strtolocal = unitolocal
 strfromlocal = unifromlocal
 strmethod = unimethod
 
 
 def lower(s):
     # type: (bytes) -> bytes
     """best-effort encoding-aware case-folding of local string s"""
     try:
         return asciilower(s)
     except UnicodeDecodeError:
         pass
     try:
         if isinstance(s, localstr):
             u = s._utf8.decode("utf-8")
         else:
             u = s.decode(_sysstr(encoding), _sysstr(encodingmode))
 
         lu = u.lower()
         if u == lu:
             return s  # preserve localstring
         return lu.encode(_sysstr(encoding))
     except UnicodeError:
         return s.lower()  # we don't know how to fold this except in ASCII
     except LookupError as k:
         raise error.Abort(
             pycompat.bytestr(k), hint=b"please check your locale settings"
         )
 
 
 def upper(s):
     # type: (bytes) -> bytes
     """best-effort encoding-aware case-folding of local string s"""
     try:
         return asciiupper(s)
     except UnicodeDecodeError:
         return upperfallback(s)
 
 
 def upperfallback(s):
     # type: (Any) -> Any
     try:
         if isinstance(s, localstr):
             u = s._utf8.decode("utf-8")
         else:
             u = s.decode(_sysstr(encoding), _sysstr(encodingmode))
 
         uu = u.upper()
         if u == uu:
             return s  # preserve localstring
         return uu.encode(_sysstr(encoding))
     except UnicodeError:
         return s.upper()  # we don't know how to fold this except in ASCII
     except LookupError as k:
         raise error.Abort(
             pycompat.bytestr(k), hint=b"please check your locale settings"
         )
 
 
 if not _nativeenviron:
     # now encoding and helper functions are available, recreate the environ
     # dict to be exported to other modules
     if pycompat.iswindows:
 
         class WindowsEnviron(dict):
             """`os.environ` normalizes environment variables to uppercase on windows"""
 
             def get(self, key, default=None):
                 return super().get(upper(key), default)
 
         environ = WindowsEnviron()
 
     for k, v in os.environ.items():  # re-exports
         environ[tolocal(k.encode('utf-8'))] = tolocal(v.encode('utf-8'))
 
 
 DRIVE_RE = re.compile(b'^[a-z]:')
 
 # os.getcwd() on Python 3 returns string, but it has os.getcwdb() which
 # returns bytes.
 if pycompat.iswindows:
     # Python 3 on Windows issues a DeprecationWarning about using the bytes
     # API when os.getcwdb() is called.
     #
     # Additionally, py3.8+ uppercases the drive letter when calling
     # os.path.realpath(), which is used on ``repo.root``.  Since those
     # strings are compared in various places as simple strings, also call
     # realpath here.  See https://bugs.python.org/issue40368
     #
     # However this is not reliable, so lets explicitly make this drive
     # letter upper case.
     #
     # note: we should consider dropping realpath here since it seems to
     # change the semantic of `getcwd`.
 
     def getcwd():
         cwd = os.getcwd()  # re-exports
         cwd = os.path.realpath(cwd)
         cwd = strtolocal(cwd)
         if DRIVE_RE.match(cwd):
             cwd = cwd[0:1].upper() + cwd[1:]
         return cwd
 
 
 else:
     getcwd = os.getcwdb  # re-exports
 
 # How to treat ambiguous-width characters. Set to 'wide' to treat as wide.
 _wide = _sysstr(
     environ.get(b"HGENCODINGAMBIGUOUS", b"narrow") == b"wide"
     and b"WFA"
     or b"WF"
 )
 
 
 def colwidth(s):
     # type: (bytes) -> int
     """Find the column width of a string for display in the local encoding"""
     return ucolwidth(s.decode(_sysstr(encoding), 'replace'))
 
 
 def ucolwidth(d):
     # type: (Text) -> int
     """Find the column width of a Unicode string for display"""
     eaw = getattr(unicodedata, 'east_asian_width', None)
     if eaw is not None:
         return sum([eaw(c) in _wide and 2 or 1 for c in d])
     return len(d)
 
 
 def getcols(s, start, c):
     # type: (bytes, int, int) -> bytes
     """Use colwidth to find a c-column substring of s starting at byte
     index start"""
     for x in range(start + c, len(s)):
         t = s[start:x]
         if colwidth(t) == c:
             return t
     raise ValueError('substring not found')
 
 
 def trim(s, width, ellipsis=b'', leftside=False):
     # type: (bytes, int, bytes, bool) -> bytes
     """Trim string 's' to at most 'width' columns (including 'ellipsis').
 
     If 'leftside' is True, left side of string 's' is trimmed.
     'ellipsis' is always placed at trimmed side.
 
     >>> from .node import bin
     >>> def bprint(s):
     ...     print(pycompat.sysstr(s))
     >>> ellipsis = b'+++'
     >>> from . import encoding
     >>> encoding.encoding = b'utf-8'
     >>> t = b'1234567890'
     >>> bprint(trim(t, 12, ellipsis=ellipsis))
     1234567890
     >>> bprint(trim(t, 10, ellipsis=ellipsis))
     1234567890
     >>> bprint(trim(t, 8, ellipsis=ellipsis))
     12345+++
     >>> bprint(trim(t, 8, ellipsis=ellipsis, leftside=True))
     +++67890
     >>> bprint(trim(t, 8))
     12345678
     >>> bprint(trim(t, 8, leftside=True))
     34567890
     >>> bprint(trim(t, 3, ellipsis=ellipsis))
     +++
     >>> bprint(trim(t, 1, ellipsis=ellipsis))
     +
     >>> u = u'\u3042\u3044\u3046\u3048\u304a' # 2 x 5 = 10 columns
     >>> t = u.encode(pycompat.sysstr(encoding.encoding))
     >>> bprint(trim(t, 12, ellipsis=ellipsis))
     \xe3\x81\x82\xe3\x81\x84\xe3\x81\x86\xe3\x81\x88\xe3\x81\x8a
     >>> bprint(trim(t, 10, ellipsis=ellipsis))
     \xe3\x81\x82\xe3\x81\x84\xe3\x81\x86\xe3\x81\x88\xe3\x81\x8a
     >>> bprint(trim(t, 8, ellipsis=ellipsis))
     \xe3\x81\x82\xe3\x81\x84+++
     >>> bprint(trim(t, 8, ellipsis=ellipsis, leftside=True))
     +++\xe3\x81\x88\xe3\x81\x8a
     >>> bprint(trim(t, 5))
     \xe3\x81\x82\xe3\x81\x84
     >>> bprint(trim(t, 5, leftside=True))
     \xe3\x81\x88\xe3\x81\x8a
     >>> bprint(trim(t, 4, ellipsis=ellipsis))
     +++
     >>> bprint(trim(t, 4, ellipsis=ellipsis, leftside=True))
     +++
     >>> t = bin(b'112233445566778899aa') # invalid byte sequence
     >>> bprint(trim(t, 12, ellipsis=ellipsis))
     \x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa
     >>> bprint(trim(t, 10, ellipsis=ellipsis))
     \x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa
     >>> bprint(trim(t, 8, ellipsis=ellipsis))
     \x11\x22\x33\x44\x55+++
     >>> bprint(trim(t, 8, ellipsis=ellipsis, leftside=True))
     +++\x66\x77\x88\x99\xaa
     >>> bprint(trim(t, 8))
     \x11\x22\x33\x44\x55\x66\x77\x88
     >>> bprint(trim(t, 8, leftside=True))
     \x33\x44\x55\x66\x77\x88\x99\xaa
     >>> bprint(trim(t, 3, ellipsis=ellipsis))
     +++
     >>> bprint(trim(t, 1, ellipsis=ellipsis))
     +
     """
     try:
         u = s.decode(_sysstr(encoding))
     except UnicodeDecodeError:
         if len(s) <= width:  # trimming is not needed
             return s
         width -= len(ellipsis)
         if width <= 0:  # no enough room even for ellipsis
             return ellipsis[: width + len(ellipsis)]
         if leftside:
             return ellipsis + s[-width:]
         return s[:width] + ellipsis
 
     if ucolwidth(u) <= width:  # trimming is not needed
         return s
 
     width -= len(ellipsis)
     if width <= 0:  # no enough room even for ellipsis
         return ellipsis[: width + len(ellipsis)]
 
     chars = list(u)
     if leftside:
         chars.reverse()
     width_so_far = 0
     for i, c in enumerate(chars):
         width_so_far += ucolwidth(c)
         if width_so_far > width:
             break
     chars = chars[:i]
     if leftside:
         chars.reverse()
     u = u''.join(chars).encode(_sysstr(encoding))
     if leftside:
         return ellipsis + u
     return u + ellipsis
 
 
 class normcasespecs:
     """what a platform's normcase does to ASCII strings
 
     This is specified per platform, and should be consistent with what normcase
     on that platform actually does.
 
     lower: normcase lowercases ASCII strings
     upper: normcase uppercases ASCII strings
     other: the fallback function should always be called
 
     This should be kept in sync with normcase_spec in util.h."""
 
     lower = -1
     upper = 1
     other = 0
 
 
 def jsonescape(s, paranoid=False):
     # type: (Any, Any) -> Any
     """returns a string suitable for JSON
 
     JSON is problematic for us because it doesn't support non-Unicode
     bytes. To deal with this, we take the following approach:
 
     - localstr/safelocalstr objects are converted back to UTF-8
     - valid UTF-8/ASCII strings are passed as-is
     - other strings are converted to UTF-8b surrogate encoding
     - apply JSON-specified string escaping
 
     (escapes are doubled in these tests)
 
     >>> jsonescape(b'this is a test')
     'this is a test'
     >>> jsonescape(b'escape characters: \\0 \\x0b \\x7f')
     'escape characters: \\\\u0000 \\\\u000b \\\\u007f'
     >>> jsonescape(b'escape characters: \\b \\t \\n \\f \\r \\" \\\\')
     'escape characters: \\\\b \\\\t \\\\n \\\\f \\\\r \\\\" \\\\\\\\'
     >>> jsonescape(b'a weird byte: \\xdd')
     'a weird byte: \\xed\\xb3\\x9d'
     >>> jsonescape(b'utf-8: caf\\xc3\\xa9')
     'utf-8: caf\\xc3\\xa9'
     >>> jsonescape(b'')
     ''
 
     If paranoid, non-ascii and common troublesome characters are also escaped.
     This is suitable for web output.
 
     >>> s = b'escape characters: \\0 \\x0b \\x7f'
     >>> assert jsonescape(s) == jsonescape(s, paranoid=True)
     >>> s = b'escape characters: \\b \\t \\n \\f \\r \\" \\\\'
     >>> assert jsonescape(s) == jsonescape(s, paranoid=True)
     >>> jsonescape(b'escape boundary: \\x7e \\x7f \\xc2\\x80', paranoid=True)
     'escape boundary: ~ \\\\u007f \\\\u0080'
     >>> jsonescape(b'a weird byte: \\xdd', paranoid=True)
     'a weird byte: \\\\udcdd'
     >>> jsonescape(b'utf-8: caf\\xc3\\xa9', paranoid=True)
     'utf-8: caf\\\\u00e9'
     >>> jsonescape(b'non-BMP: \\xf0\\x9d\\x84\\x9e', paranoid=True)
     'non-BMP: \\\\ud834\\\\udd1e'
     >>> jsonescape(b'<[e-mail]>', paranoid=True)
     '\\\\[e-mail]\\\\u003e'
     """
 
     u8chars = toutf8b(s)
     try:
         return _jsonescapeu8fast(u8chars, paranoid)
     except ValueError:
         pass
     return charencodepure.jsonescapeu8fallback(u8chars, paranoid)
 
 
 # We need to decode/encode U+DCxx codes transparently since invalid UTF-8
 # bytes are mapped to that range.
 _utf8strict = r'surrogatepass'
 
 _utf8len = [0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 3, 4]
 
 
 def getutf8char(s, pos):
     # type: (bytes, int) -> bytes
     """get the next full utf-8 character in the given string, starting at pos
 
     Raises a UnicodeError if the given location does not start a valid
     utf-8 character.
     """
 
     # find how many bytes to attempt decoding from first nibble
     l = _utf8len[ord(s[pos : pos + 1]) >> 4]
     if not l:  # ascii
         return s[pos : pos + 1]
 
     c = s[pos : pos + l]
     # validate with attempted decode
     c.decode("utf-8", _utf8strict)
     return c
 
 
 def toutf8b(s):
     # type: (bytes) -> bytes
     """convert a local, possibly-binary string into UTF-8b
 
     This is intended as a generic method to preserve data when working
     with schemes like JSON and XML that have no provision for
     arbitrary byte strings. As Mercurial often doesn't know
     what encoding data is in, we use so-called UTF-8b.
 
     If a string is already valid UTF-8 (or ASCII), it passes unmodified.
     Otherwise, unsupported bytes are mapped to UTF-16 surrogate range,
     uDC00-uDCFF.
 
     Principles of operation:
 
     - ASCII and UTF-8 data successfully round-trips and is understood
       by Unicode-oriented clients
     - filenames and file contents in arbitrary other encodings can have
       be round-tripped or recovered by clueful clients
     - local strings that have a cached known UTF-8 encoding (aka
       localstr) get sent as UTF-8 so Unicode-oriented clients get the
       Unicode data they want
     - non-lossy local strings (aka safelocalstr) get sent as UTF-8 as well
     - because we must preserve UTF-8 bytestring in places such as
       filenames, metadata can't be roundtripped without help
 
     (Note: "UTF-8b" often refers to decoding a mix of valid UTF-8 and
     arbitrary bytes into an internal Unicode format that can be
     re-encoded back into the original. Here we are exposing the
     internal surrogate encoding as a UTF-8 string.)
     """
 
     if isinstance(s, localstr):
         # assume that the original UTF-8 sequence would never contain
         # invalid characters in U+DCxx range
         return s._utf8
     elif isinstance(s, safelocalstr):
         # already verified that s is non-lossy in legacy encoding, which
         # shouldn't contain characters in U+DCxx range
         return fromlocal(s)
     elif isasciistr(s):
         return s
     if b"\xed" not in s:
         try:
             s.decode('utf-8', _utf8strict)
             return s
         except UnicodeDecodeError:
             pass
 
     s = pycompat.bytestr(s)
     r = bytearray()
     pos = 0
     l = len(s)
     while pos < l:
         try:
             c = getutf8char(s, pos)
             if b"\xed\xb0\x80" <= c <= b"\xed\xb3\xbf":
                 # have to re-escape existing U+DCxx characters
                 c = unichr(0xDC00 + ord(s[pos])).encode('utf-8', _utf8strict)
                 pos += 1
             else:
                 pos += len(c)
         except UnicodeDecodeError:
             c = unichr(0xDC00 + ord(s[pos])).encode('utf-8', _utf8strict)
             pos += 1
         r += c
     return bytes(r)
 
 
 def fromutf8b(s):
     # type: (bytes) -> bytes
     """Given a UTF-8b string, return a local, possibly-binary string.
 
     return the original binary string. This
     is a round-trip process for strings like filenames, but metadata
     that's was passed through tolocal will remain in UTF-8.
 
     >>> roundtrip = lambda x: fromutf8b(toutf8b(x)) == x
     >>> m = b"\\xc3\\xa9\\x99abcd"
     >>> toutf8b(m)
     '\\xc3\\xa9\\xed\\xb2\\x99abcd'
     >>> roundtrip(m)
     True
     >>> roundtrip(b"\\xc2\\xc2\\x80")
     True
     >>> roundtrip(b"\\xef\\xbf\\xbd")
     True
     >>> roundtrip(b"\\xef\\xef\\xbf\\xbd")
     True
     >>> roundtrip(b"\\xf1\\x80\\x80\\x80\\x80")
     True
     """
 
     if isasciistr(s):
         return s
     # fast path - look for uDxxx prefixes in s
     if b"\xed" not in s:
         return s
 
     # We could do this with the unicode type but some Python builds
     # use UTF-16 internally (issue5031) which causes non-BMP code
     # points to be escaped. Instead, we use our handy getutf8char
     # helper again to walk the string without "decoding" it.
 
     s = pycompat.bytestr(s)
     r = bytearray()
     pos = 0
     l = len(s)
     while pos < l:
         c = getutf8char(s, pos)
         pos += len(c)
         # unescape U+DCxx characters
         if b"\xed\xb0\x80" <= c <= b"\xed\xb3\xbf":
             c = pycompat.bytechr(ord(c.decode("utf-8", _utf8strict)) & 0xFF)
         r += c
     return bytes(r)

mercurial/error.py

@@ -1,681 +1,692 b''
 # error.py - Mercurial exceptions
 #
 # Copyright 2005-2008 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """Mercurial exceptions.
 
 This allows us to catch exceptions at higher levels without forcing
 imports.
 """
 
 
 import difflib
 
+from typing import (
+    Any,
+    AnyStr,
+    Iterable,
+    List,
+    Optional,
+    Sequence,
+    Union,
+)
+
 # Do not import anything but pycompat here, please
 from . import pycompat
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Any,
-        AnyStr,
-        Iterable,
-        List,
-        Optional,
-        Sequence,
-        Union,
-    )
+
+# keeps pyflakes happy
+assert [
+    Any,
+    AnyStr,
+    Iterable,
+    List,
+    Optional,
+    Sequence,
+    Union,
+]
 
 
 def _tobytes(exc):
     # type: (...) -> bytes
     """Byte-stringify exception in the same way as BaseException_str()"""
     if not exc.args:
         return b''
     if len(exc.args) == 1:
         return pycompat.bytestr(exc.args[0])
     return b'(%s)' % b', '.join(b"'%s'" % pycompat.bytestr(a) for a in exc.args)
 
 
 class Hint:
     """Mix-in to provide a hint of an error
 
     This should come first in the inheritance list to consume a hint and
     pass remaining arguments to the exception class.
     """
 
     def __init__(self, *args, **kw):
         self.hint = kw.pop('hint', None)  # type: Optional[bytes]
         super(Hint, self).__init__(*args, **kw)
 
 
 class Error(Hint, Exception):
     """Base class for Mercurial errors."""
 
     coarse_exit_code = None
     detailed_exit_code = None
 
     def __init__(self, message, hint=None):
         # type: (bytes, Optional[bytes]) -> None
         self.message = message
         self.hint = hint
         # Pass the message into the Exception constructor to help extensions
         # that look for exc.args[0].
         Exception.__init__(self, message)
 
     def __bytes__(self):
         return self.message
 
     def __str__(self):
         # type: () -> str
         # the output would be unreadable if the message was translated,
         # but do not replace it with encoding.strfromlocal(), which
         # may raise another exception.
         return pycompat.sysstr(self.__bytes__())
 
     def format(self):
         # type: () -> bytes
         from .i18n import _
 
         message = _(b"abort: %s\n") % self.message
         if self.hint:
             message += _(b"(%s)\n") % self.hint
         return message
 
 
 class Abort(Error):
     """Raised if a command needs to print an error and exit."""
 
 
 class StorageError(Error):
     """Raised when an error occurs in a storage layer.
 
     Usually subclassed by a storage-specific exception.
     """
 
     detailed_exit_code = 50
 
 
 class RevlogError(StorageError):
     pass
 
 
 class SidedataHashError(RevlogError):
     def __init__(self, key, expected, got):
         # type: (int, bytes, bytes) -> None
         self.hint = None
         self.sidedatakey = key
         self.expecteddigest = expected
         self.actualdigest = got
 
 
 class FilteredIndexError(IndexError):
     __bytes__ = _tobytes
 
 
 class LookupError(RevlogError, KeyError):
     def __init__(self, name, index, message):
         # type: (bytes, bytes, bytes) -> None
         self.name = name
         self.index = index
         # this can't be called 'message' because at least some installs of
         # Python 2.6+ complain about the 'message' property being deprecated
         self.lookupmessage = message
         if isinstance(name, bytes) and len(name) == 20:
             from .node import hex
 
             name = hex(name)
         # if name is a binary node, it can be None
         RevlogError.__init__(
             self, b'%s@%s: %s' % (index, pycompat.bytestr(name), message)
         )
 
     def __bytes__(self):
         return RevlogError.__bytes__(self)
 
     def __str__(self):
         return RevlogError.__str__(self)
 
 
 class AmbiguousPrefixLookupError(LookupError):
     pass
 
 
 class FilteredLookupError(LookupError):
     pass
 
 
 class ManifestLookupError(LookupError):
     pass
 
 
 class CommandError(Exception):
     """Exception raised on errors in parsing the command line."""
 
     def __init__(self, command, message):
         # type: (Optional[bytes], bytes) -> None
         self.command = command
         self.message = message
         super(CommandError, self).__init__()
 
     __bytes__ = _tobytes
 
 
 class UnknownCommand(Exception):
     """Exception raised if command is not in the command table."""
 
     def __init__(self, command, all_commands=None):
         # type: (bytes, Optional[List[bytes]]) -> None
         self.command = command
         self.all_commands = all_commands
         super(UnknownCommand, self).__init__()
 
     __bytes__ = _tobytes
 
 
 class AmbiguousCommand(Exception):
     """Exception raised if command shortcut matches more than one command."""
 
     def __init__(self, prefix, matches):
         # type: (bytes, List[bytes]) -> None
         self.prefix = prefix
         self.matches = matches
         super(AmbiguousCommand, self).__init__()
 
     __bytes__ = _tobytes
 
 
 class WorkerError(Exception):
     """Exception raised when a worker process dies."""
 
     def __init__(self, status_code):
         # type: (int) -> None
         self.status_code = status_code
         # Pass status code to superclass just so it becomes part of __bytes__
         super(WorkerError, self).__init__(status_code)
 
     __bytes__ = _tobytes
 
 
 class InterventionRequired(Abort):
     """Exception raised when a command requires human intervention."""
 
     coarse_exit_code = 1
     detailed_exit_code = 240
 
     def format(self):
         # type: () -> bytes
         from .i18n import _
 
         message = _(b"%s\n") % self.message
         if self.hint:
             message += _(b"(%s)\n") % self.hint
         return message
 
 
 class ConflictResolutionRequired(InterventionRequired):
     """Exception raised when a continuable command required merge conflict resolution."""
 
     def __init__(self, opname):
         # type: (bytes) -> None
         from .i18n import _
 
         self.opname = opname
         InterventionRequired.__init__(
             self,
             _(
                 b"unresolved conflicts (see 'hg resolve', then 'hg %s --continue')"
             )
             % opname,
         )
 
 
 class InputError(Abort):
     """Indicates that the user made an error in their input.
 
     Examples: Invalid command, invalid flags, invalid revision.
     """
 
     detailed_exit_code = 10
 
 
 class StateError(Abort):
     """Indicates that the operation might work if retried in a different state.
 
     Examples: Unresolved merge conflicts, unfinished operations.
     """
 
     detailed_exit_code = 20
 
 
 class CanceledError(Abort):
     """Indicates that the user canceled the operation.
 
     Examples: Close commit editor with error status, quit chistedit.
     """
 
     detailed_exit_code = 250
 
 
 class SecurityError(Abort):
     """Indicates that some aspect of security failed.
 
     Examples: Bad server credentials, expired local credentials for network
     filesystem, mismatched GPG signature, DoS protection.
     """
 
     detailed_exit_code = 150
 
 
 class HookLoadError(Abort):
     """raised when loading a hook fails, aborting an operation
 
     Exists to allow more specialized catching."""
 
 
 class HookAbort(Abort):
     """raised when a validation hook fails, aborting an operation
 
     Exists to allow more specialized catching."""
 
     detailed_exit_code = 40
 
 
 class ConfigError(Abort):
     """Exception raised when parsing config files"""
 
     detailed_exit_code = 30
 
     def __init__(self, message, location=None, hint=None):
         # type: (bytes, Optional[bytes], Optional[bytes]) -> None
         super(ConfigError, self).__init__(message, hint=hint)
         self.location = location
 
     def format(self):
         # type: () -> bytes
         from .i18n import _
 
         if self.location is not None:
             message = _(b"config error at %s: %s\n") % (
                 pycompat.bytestr(self.location),
                 self.message,
             )
         else:
             message = _(b"config error: %s\n") % self.message
         if self.hint:
             message += _(b"(%s)\n") % self.hint
         return message
 
 
 class UpdateAbort(Abort):
     """Raised when an update is aborted for destination issue"""
 
 
 class MergeDestAbort(Abort):
     """Raised when an update is aborted for destination issues"""
 
 
 class NoMergeDestAbort(MergeDestAbort):
     """Raised when an update is aborted because there is nothing to merge"""
 
 
 class ManyMergeDestAbort(MergeDestAbort):
     """Raised when an update is aborted because destination is ambiguous"""
 
 
 class ResponseExpected(Abort):
     """Raised when an EOF is received for a prompt"""
 
     def __init__(self):
         from .i18n import _
 
         Abort.__init__(self, _(b'response expected'))
 
 
 class RemoteError(Abort):
     """Exception raised when interacting with a remote repo fails"""
 
     detailed_exit_code = 100
 
 
 class OutOfBandError(RemoteError):
     """Exception raised when a remote repo reports failure"""
 
     def __init__(self, message=None, hint=None):
         # type: (Optional[bytes], Optional[bytes]) -> None
         from .i18n import _
 
         if message:
             # Abort.format() adds a trailing newline
             message = _(b"remote error:\n%s") % message.rstrip(b'\n')
         else:
             message = _(b"remote error")
         super(OutOfBandError, self).__init__(message, hint=hint)
 
 
 class ParseError(Abort):
     """Raised when parsing config files and {rev,file}sets (msg[, pos])"""
 
     detailed_exit_code = 10
 
     def __init__(self, message, location=None, hint=None):
         # type: (bytes, Optional[Union[bytes, int]], Optional[bytes]) -> None
         super(ParseError, self).__init__(message, hint=hint)
         self.location = location
 
     def format(self):
         # type: () -> bytes
         from .i18n import _
 
         if self.location is not None:
             message = _(b"hg: parse error at %s: %s\n") % (
                 pycompat.bytestr(self.location),
                 self.message,
             )
         else:
             message = _(b"hg: parse error: %s\n") % self.message
         if self.hint:
             message += _(b"(%s)\n") % self.hint
         return message
 
 
 class PatchError(Exception):
     __bytes__ = _tobytes
 
 
 class PatchParseError(PatchError):
     __bytes__ = _tobytes
 
 
 class PatchApplicationError(PatchError):
     __bytes__ = _tobytes
 
 
 def getsimilar(symbols, value):
     # type: (Iterable[bytes], bytes) -> List[bytes]
     sim = lambda x: difflib.SequenceMatcher(None, value, x).ratio()
     # The cutoff for similarity here is pretty arbitrary. It should
     # probably be investigated and tweaked.
     return [s for s in symbols if sim(s) > 0.6]
 
 
 def similarity_hint(similar):
     # type: (List[bytes]) -> Optional[bytes]
     from .i18n import _
 
     if len(similar) == 1:
         return _(b"did you mean %s?") % similar[0]
     elif similar:
         ss = b", ".join(sorted(similar))
         return _(b"did you mean one of %s?") % ss
     else:
         return None
 
 
 class UnknownIdentifier(ParseError):
     """Exception raised when a {rev,file}set references an unknown identifier"""
 
     def __init__(self, function, symbols):
         # type: (bytes, Iterable[bytes]) -> None
         from .i18n import _
 
         similar = getsimilar(symbols, function)
         hint = similarity_hint(similar)
 
         ParseError.__init__(
             self, _(b"unknown identifier: %s") % function, hint=hint
         )
 
 
 class RepoError(Hint, Exception):
     __bytes__ = _tobytes
 
 
 class RepoLookupError(RepoError):
     pass
 
 
 class FilteredRepoLookupError(RepoLookupError):
     pass
 
 
 class CapabilityError(RepoError):
     pass
 
 
 class RequirementError(RepoError):
     """Exception raised if .hg/requires has an unknown entry."""
 
 
 class StdioError(IOError):
     """Raised if I/O to stdout or stderr fails"""
 
     def __init__(self, err):
         # type: (IOError) -> None
         IOError.__init__(self, err.errno, err.strerror)
 
     # no __bytes__() because error message is derived from the standard IOError
 
 
 class UnsupportedMergeRecords(Abort):
     def __init__(self, recordtypes):
         # type: (Iterable[bytes]) -> None
         from .i18n import _
 
         self.recordtypes = sorted(recordtypes)
         s = b' '.join(self.recordtypes)
         Abort.__init__(
             self,
             _(b'unsupported merge state records: %s') % s,
             hint=_(
                 b'see https://mercurial-scm.org/wiki/MergeStateRecords for '
                 b'more information'
             ),
         )
 
 
 class UnknownVersion(Abort):
     """generic exception for aborting from an encounter with an unknown version"""
 
     def __init__(self, msg, hint=None, version=None):
         # type: (bytes, Optional[bytes], Optional[bytes]) -> None
         self.version = version
         super(UnknownVersion, self).__init__(msg, hint=hint)
 
 
 class LockError(IOError):
     def __init__(self, errno, strerror, filename, desc):
         # TODO: figure out if this should be bytes or str
         # _type: (int, str, str, bytes) -> None
         IOError.__init__(self, errno, strerror, filename)
         self.desc = desc
 
     # no __bytes__() because error message is derived from the standard IOError
 
 
 class LockHeld(LockError):
     def __init__(self, errno, filename, desc, locker):
         LockError.__init__(self, errno, b'Lock held', filename, desc)
         self.locker = locker
 
 
 class LockUnavailable(LockError):
     pass
 
 
 # LockError is for errors while acquiring the lock -- this is unrelated
 class LockInheritanceContractViolation(RuntimeError):
     __bytes__ = _tobytes
 
 
 class ResponseError(Exception):
     """Raised to print an error with part of output and exit."""
 
     __bytes__ = _tobytes
 
 
 # derived from KeyboardInterrupt to simplify some breakout code
 class SignalInterrupt(KeyboardInterrupt):
     """Exception raised on SIGTERM and SIGHUP."""
 
 
 class SignatureError(Exception):
     __bytes__ = _tobytes
 
 
 class PushRaced(RuntimeError):
     """An exception raised during unbundling that indicate a push race"""
 
     __bytes__ = _tobytes
 
 
 class ProgrammingError(Hint, RuntimeError):
     """Raised if a mercurial (core or extension) developer made a mistake"""
 
     def __init__(self, msg, *args, **kwargs):
         # type: (AnyStr, Any, Any) -> None
         # On Python 3, turn the message back into a string since this is
         # an internal-only error that won't be printed except in a
         # stack traces.
         msg = pycompat.sysstr(msg)
         super(ProgrammingError, self).__init__(msg, *args, **kwargs)
 
     __bytes__ = _tobytes
 
 
 class WdirUnsupported(Exception):
     """An exception which is raised when 'wdir()' is not supported"""
 
     __bytes__ = _tobytes
 
 
 # bundle2 related errors
 class BundleValueError(ValueError):
     """error raised when bundle2 cannot be processed"""
 
     __bytes__ = _tobytes
 
 
 class BundleUnknownFeatureError(BundleValueError):
     def __init__(self, parttype=None, params=(), values=()):
         self.parttype = parttype
         self.params = params
         self.values = values
         if self.parttype is None:
             msg = b'Stream Parameter'
         else:
             msg = parttype
         entries = self.params
         if self.params and self.values:
             assert len(self.params) == len(self.values)
             entries = []
             for idx, par in enumerate(self.params):
                 val = self.values[idx]
                 if val is None:
                     entries.append(val)
                 else:
                     entries.append(b"%s=%r" % (par, pycompat.maybebytestr(val)))
         if entries:
             msg = b'%s - %s' % (msg, b', '.join(entries))
         ValueError.__init__(self, msg)  # TODO: convert to str?
 
 
 class ReadOnlyPartError(RuntimeError):
     """error raised when code tries to alter a part being generated"""
 
     __bytes__ = _tobytes
 
 
 class PushkeyFailed(Abort):
     """error raised when a pushkey part failed to update a value"""
 
     def __init__(
         self, partid, namespace=None, key=None, new=None, old=None, ret=None
     ):
         self.partid = partid
         self.namespace = namespace
         self.key = key
         self.new = new
         self.old = old
         self.ret = ret
         # no i18n expected to be processed into a better message
         Abort.__init__(
             self, b'failed to update value for "%s/%s"' % (namespace, key)
         )
 
 
 class CensoredNodeError(StorageError):
     """error raised when content verification fails on a censored node
 
     Also contains the tombstone data substituted for the uncensored data.
     """
 
     def __init__(self, filename, node, tombstone):
         # type: (bytes, bytes, bytes) -> None
         from .node import short
 
         StorageError.__init__(self, b'%s:%s' % (filename, short(node)))
         self.tombstone = tombstone
 
 
 class CensoredBaseError(StorageError):
     """error raised when a delta is rejected because its base is censored
 
     A delta based on a censored revision must be formed as single patch
     operation which replaces the entire base with new content. This ensures
     the delta may be applied by clones which have not censored the base.
     """
 
 
 class InvalidBundleSpecification(Exception):
     """error raised when a bundle specification is invalid.
 
     This is used for syntax errors as opposed to support errors.
     """
 
     __bytes__ = _tobytes
 
 
 class UnsupportedBundleSpecification(Exception):
     """error raised when a bundle specification is not supported."""
 
     __bytes__ = _tobytes
 
 
 class CorruptedState(Exception):
     """error raised when a command is not able to read its state from file"""
 
     __bytes__ = _tobytes
 
 
 class CorruptedDirstate(Exception):
     """error raised the dirstate appears corrupted on-disk. It may be due to
     a dirstate version mismatch (i.e. expecting v2 and finding v1 on disk)."""
 
     __bytes__ = _tobytes
 
 
 class PeerTransportError(Abort):
     """Transport-level I/O error when communicating with a peer repo."""
 
 
 class InMemoryMergeConflictsError(Exception):
     """Exception raised when merge conflicts arose during an in-memory merge."""
 
     __bytes__ = _tobytes
 
 
 class WireprotoCommandError(Exception):
     """Represents an error during execution of a wire protocol command.
 
     Should only be thrown by wire protocol version 2 commands.
 
     The error is a formatter string and an optional iterable of arguments.
     """
 
     def __init__(self, message, args=None):
         # type: (bytes, Optional[Sequence[bytes]]) -> None
         self.message = message
         self.messageargs = args

mercurial/i18n.py

@@ -1,124 +1,128 b''
 # i18n.py - internationalization support for mercurial
 #
 # Copyright 2005, 2006 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import gettext as gettextmod
 import locale
 import os
 import sys
 
+from typing import (
+    Callable,
+    List,
+)
+
 from .utils import resourceutil
 from . import (
     encoding,
     pycompat,
 )
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Callable,
-        List,
-    )
-
+# keeps pyflakes happy
+assert [
+    Callable,
+    List,
+]
 
 # modelled after templater.templatepath:
 if getattr(sys, 'frozen', None) is not None:
     module = pycompat.sysexecutable
 else:
     module = pycompat.fsencode(__file__)
 
 _languages = None
 if (
     pycompat.iswindows
     and b'LANGUAGE' not in encoding.environ
     and b'LC_ALL' not in encoding.environ
     and b'LC_MESSAGES' not in encoding.environ
     and b'LANG' not in encoding.environ
 ):
     # Try to detect UI language by "User Interface Language Management" API
     # if no locale variables are set. Note that locale.getdefaultlocale()
     # uses GetLocaleInfo(), which may be different from UI language.
     # (See http://msdn.microsoft.com/en-us/library/dd374098(v=VS.85).aspx )
     try:
         import ctypes
 
         # pytype: disable=module-attr
         langid = ctypes.windll.kernel32.GetUserDefaultUILanguage()
         # pytype: enable=module-attr
 
         _languages = [locale.windows_locale[langid]]
     except (ImportError, AttributeError, KeyError):
         # ctypes not found or unknown langid
         pass
 
 
 datapath = pycompat.fsdecode(resourceutil.datapath)
 localedir = os.path.join(datapath, 'locale')
 t = gettextmod.translation('hg', localedir, _languages, fallback=True)
 try:
     _ugettext = t.ugettext  # pytype: disable=attribute-error
 except AttributeError:
     _ugettext = t.gettext
 
 
 _msgcache = {}  # encoding: {message: translation}
 
 
 def gettext(message):
     # type: (bytes) -> bytes
     """Translate message.
 
     The message is looked up in the catalog to get a Unicode string,
     which is encoded in the local encoding before being returned.
 
     Important: message is restricted to characters in the encoding
     given by sys.getdefaultencoding() which is most likely 'ascii'.
     """
     # If message is None, t.ugettext will return u'None' as the
     # translation whereas our callers expect us to return None.
     if message is None or not _ugettext:
         return message
 
     cache = _msgcache.setdefault(encoding.encoding, {})
     if message not in cache:
         if type(message) is str:
             # goofy unicode docstrings in test
             paragraphs = message.split(u'\n\n')  # type: List[str]
         else:
             # should be ascii, but we have unicode docstrings in test, which
             # are converted to utf-8 bytes on Python 3.
             paragraphs = [p.decode("utf-8") for p in message.split(b'\n\n')]
         # Be careful not to translate the empty string -- it holds the
         # meta data of the .po file.
         u = u'\n\n'.join([p and _ugettext(p) or u'' for p in paragraphs])
         try:
             # encoding.tolocal cannot be used since it will first try to
             # decode the Unicode string. Calling u.decode(enc) really
             # means u.encode(sys.getdefaultencoding()).decode(enc). Since
             # the Python encoding defaults to 'ascii', this fails if the
             # translated string use non-ASCII characters.
             encodingstr = pycompat.sysstr(encoding.encoding)
             cache[message] = u.encode(encodingstr, "replace")
         except LookupError:
             # An unknown encoding results in a LookupError.
             cache[message] = message
     return cache[message]
 
 
 def _plain():
     if (
         b'HGPLAIN' not in encoding.environ
         and b'HGPLAINEXCEPT' not in encoding.environ
     ):
         return False
     exceptions = encoding.environ.get(b'HGPLAINEXCEPT', b'').strip().split(b',')
     return b'i18n' not in exceptions
 
 
 if _plain():
     _ = lambda message: message  # type: Callable[[bytes], bytes]
 else:
     _ = gettext

mercurial/logcmdutil.py

@@ -1,1324 +1,1333 b''
 # logcmdutil.py - utility for log-like commands
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import itertools
 import os
 import posixpath
 
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Optional,
+    Sequence,
+    Tuple,
+)
+
 from .i18n import _
 from .node import wdirrev
 
 from .thirdparty import attr
 
 from . import (
     dagop,
     diffutil,
     error,
     formatter,
     graphmod,
     match as matchmod,
     mdiff,
     patch,
     pathutil,
     pycompat,
     revset,
     revsetlang,
     scmutil,
     smartset,
     templatekw,
     templater,
     util,
 )
 from .utils import (
     dateutil,
     stringutil,
 )
 
+# keeps pyflakes happy
+assert [
+    Any,
+    Callable,
+    Dict,
+    Optional,
+    Sequence,
+    Tuple,
+]
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Any,
-        Callable,
-        Dict,
-        Optional,
-        Sequence,
-        Tuple,
-    )
-
-    for t in (Any, Callable, Dict, Optional, Tuple):
-        assert t
+# keep pyflakes happy
+for t in (Any, Callable, Dict, Optional, Tuple):
+    assert t
 
 
 def getlimit(opts):
     """get the log limit according to option -l/--limit"""
     limit = opts.get(b'limit')
     if limit:
         try:
             limit = int(limit)
         except ValueError:
             raise error.InputError(_(b'limit must be a positive integer'))
         if limit <= 0:
             raise error.InputError(_(b'limit must be positive'))
     else:
         limit = None
     return limit
 
 
 def get_diff_chunks(
     ui,
     repo,
     diffopts,
     ctx1,
     ctx2,
     match,
     changes=None,
     stat=False,
     prefix=b'',
     root=b'',
     hunksfilterfn=None,
 ):
     if root:
         relroot = pathutil.canonpath(repo.root, repo.getcwd(), root)
     else:
         relroot = b''
     copysourcematch = None
 
     def compose(f, g):
         return lambda x: f(g(x))
 
     def pathfn(f):
         return posixpath.join(prefix, f)
 
     if relroot != b'':
         # XXX relative roots currently don't work if the root is within a
         # subrepo
         uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
         uirelroot = uipathfn(pathfn(relroot))
         relroot += b'/'
         for matchroot in match.files():
             if not matchroot.startswith(relroot):
                 ui.warn(
                     _(b'warning: %s not inside relative root %s\n')
                     % (uipathfn(pathfn(matchroot)), uirelroot)
                 )
 
         relrootmatch = scmutil.match(ctx2, pats=[relroot], default=b'path')
         match = matchmod.intersectmatchers(match, relrootmatch)
         copysourcematch = relrootmatch
 
         checkroot = repo.ui.configbool(
             b'devel', b'all-warnings'
         ) or repo.ui.configbool(b'devel', b'check-relroot')
 
         def relrootpathfn(f):
             if checkroot and not f.startswith(relroot):
                 raise AssertionError(
                     b"file %s doesn't start with relroot %s" % (f, relroot)
                 )
             return f[len(relroot) :]
 
         pathfn = compose(relrootpathfn, pathfn)
 
     if stat:
         diffopts = diffopts.copy(context=0, noprefix=False)
         # If an explicit --root was given, don't respect ui.relative-paths
         if not relroot:
             pathfn = compose(scmutil.getuipathfn(repo), pathfn)
 
     return ctx2.diff(
         ctx1,
         match,
         changes,
         opts=diffopts,
         pathfn=pathfn,
         copysourcematch=copysourcematch,
         hunksfilterfn=hunksfilterfn,
     )
 
 
 def diffordiffstat(
     ui,
     repo,
     diffopts,
     ctx1,
     ctx2,
     match,
     changes=None,
     stat=False,
     fp=None,
     graphwidth=0,
     prefix=b'',
     root=b'',
     listsubrepos=False,
     hunksfilterfn=None,
 ):
     '''show diff or diffstat.'''
 
     chunks = get_diff_chunks(
         ui,
         repo,
         diffopts,
         ctx1,
         ctx2,
         match,
         changes=changes,
         stat=stat,
         prefix=prefix,
         root=root,
         hunksfilterfn=hunksfilterfn,
     )
 
     if stat:
         diffopts = diffopts.copy(context=0, noprefix=False)
         width = 80
         if not ui.plain():
             width = ui.termwidth() - graphwidth
 
     if fp is not None or ui.canwritewithoutlabels():
         out = fp or ui
         if stat:
             chunks = [patch.diffstat(util.iterlines(chunks), width=width)]
         for chunk in util.filechunkiter(util.chunkbuffer(chunks)):
             out.write(chunk)
     else:
         if stat:
             chunks = patch.diffstatui(util.iterlines(chunks), width=width)
         else:
             chunks = patch.difflabel(
                 lambda chunks, **kwargs: chunks, chunks, opts=diffopts
             )
         if ui.canbatchlabeledwrites():
 
             def gen():
                 for chunk, label in chunks:
                     yield ui.label(chunk, label=label)
 
             for chunk in util.filechunkiter(util.chunkbuffer(gen())):
                 ui.write(chunk)
         else:
             for chunk, label in chunks:
                 ui.write(chunk, label=label)
 
     node2 = ctx2.node()
     for subpath, sub in scmutil.itersubrepos(ctx1, ctx2):
         tempnode2 = node2
         try:
             if node2 is not None:
                 tempnode2 = ctx2.substate[subpath][1]
         except KeyError:
             # A subrepo that existed in node1 was deleted between node1 and
             # node2 (inclusive). Thus, ctx2's substate won't contain that
             # subpath. The best we can do is to ignore it.
             tempnode2 = None
         submatch = matchmod.subdirmatcher(subpath, match)
         subprefix = repo.wvfs.reljoin(prefix, subpath)
         if listsubrepos or match.exact(subpath) or any(submatch.files()):
             sub.diff(
                 ui,
                 diffopts,
                 tempnode2,
                 submatch,
                 changes=changes,
                 stat=stat,
                 fp=fp,
                 prefix=subprefix,
             )
 
 
 class changesetdiffer:
     """Generate diff of changeset with pre-configured filtering functions"""
 
     def _makefilematcher(self, ctx):
         return scmutil.matchall(ctx.repo())
 
     def _makehunksfilter(self, ctx):
         return None
 
     def showdiff(self, ui, ctx, diffopts, graphwidth=0, stat=False):
         diffordiffstat(
             ui,
             ctx.repo(),
             diffopts,
             diffutil.diff_parent(ctx),
             ctx,
             match=self._makefilematcher(ctx),
             stat=stat,
             graphwidth=graphwidth,
             hunksfilterfn=self._makehunksfilter(ctx),
         )
 
     def getdiffstats(self, ui, ctx, diffopts, stat=False):
         chunks = get_diff_chunks(
             ui,
             ctx.repo(),
             diffopts,
             diffutil.diff_parent(ctx),
             ctx,
             match=self._makefilematcher(ctx),
             stat=stat,
             hunksfilterfn=self._makehunksfilter(ctx),
         )
 
         diffdata = []
         for filename, additions, removals, binary in patch.diffstatdata(
             util.iterlines(chunks)
         ):
             diffdata.append(
                 {
                     b"name": filename,
                     b"additions": additions,
                     b"removals": removals,
                     b"binary": binary,
                 }
             )
 
         return diffdata
 
 
 def changesetlabels(ctx):
     labels = [b'log.changeset', b'changeset.%s' % ctx.phasestr()]
     if ctx.obsolete():
         labels.append(b'changeset.obsolete')
     if ctx.isunstable():
         labels.append(b'changeset.unstable')
         for instability in ctx.instabilities():
             labels.append(b'instability.%s' % instability)
     return b' '.join(labels)
 
 
 class changesetprinter:
     '''show changeset information when templating not requested.'''
 
     def __init__(self, ui, repo, differ=None, diffopts=None, buffered=False):
         self.ui = ui
         self.repo = repo
         self.buffered = buffered
         self._differ = differ or changesetdiffer()
         self._diffopts = patch.diffallopts(ui, diffopts)
         self._includestat = diffopts and diffopts.get(b'stat')
         self._includediff = diffopts and diffopts.get(b'patch')
         self.header = {}
         self.hunk = {}
         self.lastheader = None
         self.footer = None
         self._columns = templatekw.getlogcolumns()
 
     def flush(self, ctx):
         rev = ctx.rev()
         if rev in self.header:
             h = self.header[rev]
             if h != self.lastheader:
                 self.lastheader = h
                 self.ui.write(h)
             del self.header[rev]
         if rev in self.hunk:
             self.ui.write(self.hunk[rev])
             del self.hunk[rev]
 
     def close(self):
         if self.footer:
             self.ui.write(self.footer)
 
     def show(self, ctx, copies=None, **props):
         props = pycompat.byteskwargs(props)
         if self.buffered:
             self.ui.pushbuffer(labeled=True)
             self._show(ctx, copies, props)
             self.hunk[ctx.rev()] = self.ui.popbuffer()
         else:
             self._show(ctx, copies, props)
 
     def _show(self, ctx, copies, props):
         '''show a single changeset or file revision'''
         changenode = ctx.node()
         graphwidth = props.get(b'graphwidth', 0)
 
         if self.ui.quiet:
             self.ui.write(
                 b"%s\n" % scmutil.formatchangeid(ctx), label=b'log.node'
             )
             return
 
         columns = self._columns
         self.ui.write(
             columns[b'changeset'] % scmutil.formatchangeid(ctx),
             label=changesetlabels(ctx),
         )
 
         # branches are shown first before any other names due to backwards
         # compatibility
         branch = ctx.branch()
         # don't show the default branch name
         if branch != b'default':
             self.ui.write(columns[b'branch'] % branch, label=b'log.branch')
 
         for nsname, ns in self.repo.names.items():
             # branches has special logic already handled above, so here we just
             # skip it
             if nsname == b'branches':
                 continue
             # we will use the templatename as the color name since those two
             # should be the same
             for name in ns.names(self.repo, changenode):
                 self.ui.write(ns.logfmt % name, label=b'log.%s' % ns.colorname)
         if self.ui.debugflag:
             self.ui.write(
                 columns[b'phase'] % ctx.phasestr(), label=b'log.phase'
             )
         for pctx in scmutil.meaningfulparents(self.repo, ctx):
             label = b'log.parent changeset.%s' % pctx.phasestr()
             self.ui.write(
                 columns[b'parent'] % scmutil.formatchangeid(pctx), label=label
             )
 
         if self.ui.debugflag:
             mnode = ctx.manifestnode()
             if mnode is None:
                 mnode = self.repo.nodeconstants.wdirid
                 mrev = wdirrev
             else:
                 mrev = self.repo.manifestlog.rev(mnode)
             self.ui.write(
                 columns[b'manifest']
                 % scmutil.formatrevnode(self.ui, mrev, mnode),
                 label=b'ui.debug log.manifest',
             )
         self.ui.write(columns[b'user'] % ctx.user(), label=b'log.user')
         self.ui.write(
             columns[b'date'] % dateutil.datestr(ctx.date()), label=b'log.date'
         )
 
         if ctx.isunstable():
             instabilities = ctx.instabilities()
             self.ui.write(
                 columns[b'instability'] % b', '.join(instabilities),
                 label=b'log.instability',
             )
 
         elif ctx.obsolete():
             self._showobsfate(ctx)
 
         self._exthook(ctx)
 
         if self.ui.debugflag:
             for key, value in zip(
                 [b'files', b'files+', b'files-'],
                 [ctx.filesmodified(), ctx.filesadded(), ctx.filesremoved()],
             ):
                 if value:
                     self.ui.write(
                         columns[key] % b" ".join(value),
                         label=b'ui.debug log.files',
                     )
         elif ctx.files() and self.ui.verbose:
             self.ui.write(
                 columns[b'files'] % b" ".join(ctx.files()),
                 label=b'ui.note log.files',
             )
         if copies and self.ui.verbose:
             copies = [b'%s (%s)' % c for c in copies]
             self.ui.write(
                 columns[b'copies'] % b' '.join(copies),
                 label=b'ui.note log.copies',
             )
 
         extra = ctx.extra()
         if extra and self.ui.debugflag:
             for key, value in sorted(extra.items()):
                 self.ui.write(
                     columns[b'extra'] % (key, stringutil.escapestr(value)),
                     label=b'ui.debug log.extra',
                 )
 
         description = ctx.description().strip()
         if description:
             if self.ui.verbose:
                 self.ui.write(
                     _(b"description:\n"), label=b'ui.note log.description'
                 )
                 self.ui.write(description, label=b'ui.note log.description')
                 self.ui.write(b"\n\n")
             else:
                 self.ui.write(
                     columns[b'summary'] % stringutil.firstline(description),
                     label=b'log.summary',
                 )
         self.ui.write(b"\n")
 
         self._showpatch(ctx, graphwidth)
 
     def _showobsfate(self, ctx):
         # TODO: do not depend on templater
         tres = formatter.templateresources(self.repo.ui, self.repo)
         t = formatter.maketemplater(
             self.repo.ui,
             b'{join(obsfate, "\n")}',
             defaults=templatekw.keywords,
             resources=tres,
         )
         obsfate = t.renderdefault({b'ctx': ctx}).splitlines()
 
         if obsfate:
             for obsfateline in obsfate:
                 self.ui.write(
                     self._columns[b'obsolete'] % obsfateline,
                     label=b'log.obsfate',
                 )
 
     def _exthook(self, ctx):
         """empty method used by extension as a hook point"""
 
     def _showpatch(self, ctx, graphwidth=0):
         if self._includestat:
             self._differ.showdiff(
                 self.ui, ctx, self._diffopts, graphwidth, stat=True
             )
         if self._includestat and self._includediff:
             self.ui.write(b"\n")
         if self._includediff:
             self._differ.showdiff(
                 self.ui, ctx, self._diffopts, graphwidth, stat=False
             )
         if self._includestat or self._includediff:
             self.ui.write(b"\n")
 
 
 class changesetformatter(changesetprinter):
     """Format changeset information by generic formatter"""
 
     def __init__(
         self, ui, repo, fm, differ=None, diffopts=None, buffered=False
     ):
         changesetprinter.__init__(self, ui, repo, differ, diffopts, buffered)
         self._diffopts = patch.difffeatureopts(ui, diffopts, git=True)
         self._fm = fm
 
     def close(self):
         self._fm.end()
 
     def _show(self, ctx, copies, props):
         '''show a single changeset or file revision'''
         fm = self._fm
         fm.startitem()
         fm.context(ctx=ctx)
         fm.data(rev=scmutil.intrev(ctx), node=fm.hexfunc(scmutil.binnode(ctx)))
 
         datahint = fm.datahint()
         if self.ui.quiet and not datahint:
             return
 
         fm.data(
             branch=ctx.branch(),
             phase=ctx.phasestr(),
             user=ctx.user(),
             date=fm.formatdate(ctx.date()),
             desc=ctx.description(),
             bookmarks=fm.formatlist(ctx.bookmarks(), name=b'bookmark'),
             tags=fm.formatlist(ctx.tags(), name=b'tag'),
             parents=fm.formatlist(
                 [fm.hexfunc(c.node()) for c in ctx.parents()], name=b'node'
             ),
         )
 
         if self.ui.debugflag or b'manifest' in datahint:
             fm.data(
                 manifest=fm.hexfunc(
                     ctx.manifestnode() or self.repo.nodeconstants.wdirid
                 )
             )
         if self.ui.debugflag or b'extra' in datahint:
             fm.data(extra=fm.formatdict(ctx.extra()))
 
         if (
             self.ui.debugflag
             or b'modified' in datahint
             or b'added' in datahint
             or b'removed' in datahint
         ):
             fm.data(
                 modified=fm.formatlist(ctx.filesmodified(), name=b'file'),
                 added=fm.formatlist(ctx.filesadded(), name=b'file'),
                 removed=fm.formatlist(ctx.filesremoved(), name=b'file'),
             )
 
         verbose = not self.ui.debugflag and self.ui.verbose
         if verbose or b'files' in datahint:
             fm.data(files=fm.formatlist(ctx.files(), name=b'file'))
         if verbose and copies or b'copies' in datahint:
             fm.data(
                 copies=fm.formatdict(copies or {}, key=b'name', value=b'source')
             )
 
         if self._includestat or b'diffstat' in datahint:
             data = self._differ.getdiffstats(
                 self.ui, ctx, self._diffopts, stat=True
             )
             fm.data(diffstat=fm.formatlist(data, name=b'diffstat'))
         if self._includediff or b'diff' in datahint:
             self.ui.pushbuffer()
             self._differ.showdiff(self.ui, ctx, self._diffopts, stat=False)
             fm.data(diff=self.ui.popbuffer())
 
 
 class changesettemplater(changesetprinter):
     """format changeset information.
 
     Note: there are a variety of convenience functions to build a
     changesettemplater for common cases. See functions such as:
     maketemplater, changesetdisplayer, buildcommittemplate, or other
     functions that use changesest_templater.
     """
 
     # Arguments before "buffered" used to be positional. Consider not
     # adding/removing arguments before "buffered" to not break callers.
     def __init__(
         self, ui, repo, tmplspec, differ=None, diffopts=None, buffered=False
     ):
         changesetprinter.__init__(self, ui, repo, differ, diffopts, buffered)
         # tres is shared with _graphnodeformatter()
         self._tresources = tres = formatter.templateresources(ui, repo)
         self.t = formatter.loadtemplater(
             ui,
             tmplspec,
             defaults=templatekw.keywords,
             resources=tres,
             cache=templatekw.defaulttempl,
         )
         self._counter = itertools.count()
 
         self._tref = tmplspec.ref
         self._parts = {
             b'header': b'',
             b'footer': b'',
             tmplspec.ref: tmplspec.ref,
             b'docheader': b'',
             b'docfooter': b'',
             b'separator': b'',
         }
         if tmplspec.mapfile:
             # find correct templates for current mode, for backward
             # compatibility with 'log -v/-q/--debug' using a mapfile
             tmplmodes = [
                 (True, b''),
                 (self.ui.verbose, b'_verbose'),
                 (self.ui.quiet, b'_quiet'),
                 (self.ui.debugflag, b'_debug'),
             ]
             for mode, postfix in tmplmodes:
                 for t in self._parts:
                     cur = t + postfix
                     if mode and cur in self.t:
                         self._parts[t] = cur
         else:
             partnames = [p for p in self._parts.keys() if p != tmplspec.ref]
             m = formatter.templatepartsmap(tmplspec, self.t, partnames)
             self._parts.update(m)
 
         if self._parts[b'docheader']:
             self.ui.write(self.t.render(self._parts[b'docheader'], {}))
 
     def close(self):
         if self._parts[b'docfooter']:
             if not self.footer:
                 self.footer = b""
             self.footer += self.t.render(self._parts[b'docfooter'], {})
         return super(changesettemplater, self).close()
 
     def _show(self, ctx, copies, props):
         '''show a single changeset or file revision'''
         props = props.copy()
         props[b'ctx'] = ctx
         props[b'index'] = index = next(self._counter)
         props[b'revcache'] = {b'copies': copies}
         graphwidth = props.get(b'graphwidth', 0)
 
         # write separator, which wouldn't work well with the header part below
         # since there's inherently a conflict between header (across items) and
         # separator (per item)
         if self._parts[b'separator'] and index > 0:
             self.ui.write(self.t.render(self._parts[b'separator'], {}))
 
         # write header
         if self._parts[b'header']:
             h = self.t.render(self._parts[b'header'], props)
             if self.buffered:
                 self.header[ctx.rev()] = h
             else:
                 if self.lastheader != h:
                     self.lastheader = h
                     self.ui.write(h)
 
         # write changeset metadata, then patch if requested
         key = self._parts[self._tref]
         self.ui.write(self.t.render(key, props))
         self._exthook(ctx)
         self._showpatch(ctx, graphwidth)
 
         if self._parts[b'footer']:
             if not self.footer:
                 self.footer = self.t.render(self._parts[b'footer'], props)
 
 
 def templatespec(tmpl, mapfile):
     assert not (tmpl and mapfile)
     if mapfile:
         return formatter.mapfile_templatespec(b'changeset', mapfile)
     else:
         return formatter.literal_templatespec(tmpl)
 
 
 def _lookuptemplate(ui, tmpl, style):
     """Find the template matching the given template spec or style
 
     See formatter.lookuptemplate() for details.
     """
 
     # ui settings
     if not tmpl and not style:  # template are stronger than style
         tmpl = ui.config(b'command-templates', b'log')
         if tmpl:
             return formatter.literal_templatespec(templater.unquotestring(tmpl))
         else:
             style = util.expandpath(ui.config(b'ui', b'style'))
 
     if not tmpl and style:
         mapfile = style
         fp = None
         if not os.path.split(mapfile)[0]:
             (mapname, fp) = templater.try_open_template(
                 b'map-cmdline.' + mapfile
             ) or templater.try_open_template(mapfile)
             if mapname:
                 mapfile = mapname
         return formatter.mapfile_templatespec(b'changeset', mapfile, fp)
 
     return formatter.lookuptemplate(ui, b'changeset', tmpl)
 
 
 def maketemplater(ui, repo, tmpl, buffered=False):
     """Create a changesettemplater from a literal template 'tmpl'
     byte-string."""
     spec = formatter.literal_templatespec(tmpl)
     return changesettemplater(ui, repo, spec, buffered=buffered)
 
 
 def changesetdisplayer(ui, repo, opts, differ=None, buffered=False):
     """show one changeset using template or regular display.
 
     Display format will be the first non-empty hit of:
     1. option 'template'
     2. option 'style'
     3. [command-templates] setting 'log'
     4. [ui] setting 'style'
     If all of these values are either the unset or the empty string,
     regular display via changesetprinter() is done.
     """
     postargs = (differ, opts, buffered)
     spec = _lookuptemplate(ui, opts.get(b'template'), opts.get(b'style'))
 
     # machine-readable formats have slightly different keyword set than
     # plain templates, which are handled by changesetformatter.
     # note that {b'pickle', b'debug'} can also be added to the list if needed.
     if spec.ref in {b'cbor', b'json'}:
         fm = ui.formatter(b'log', opts)
         return changesetformatter(ui, repo, fm, *postargs)
 
     if not spec.ref and not spec.tmpl and not spec.mapfile:
         return changesetprinter(ui, repo, *postargs)
 
     return changesettemplater(ui, repo, spec, *postargs)
 
 
 @attr.s
 class walkopts:
     """Options to configure a set of revisions and file matcher factory
     to scan revision/file history
     """
 
     # raw command-line parameters, which a matcher will be built from
     pats = attr.ib()
     opts = attr.ib()
 
     # a list of revset expressions to be traversed; if follow, it specifies
     # the start revisions
     revspec = attr.ib()
 
     # miscellaneous queries to filter revisions (see "hg help log" for details)
     bookmarks = attr.ib(default=attr.Factory(list))
     branches = attr.ib(default=attr.Factory(list))
     date = attr.ib(default=None)
     keywords = attr.ib(default=attr.Factory(list))
     no_merges = attr.ib(default=False)
     only_merges = attr.ib(default=False)
     prune_ancestors = attr.ib(default=attr.Factory(list))
     users = attr.ib(default=attr.Factory(list))
 
     # miscellaneous matcher arguments
     include_pats = attr.ib(default=attr.Factory(list))
     exclude_pats = attr.ib(default=attr.Factory(list))
 
     # 0: no follow, 1: follow first, 2: follow both parents
     follow = attr.ib(default=0)
 
     # do not attempt filelog-based traversal, which may be fast but cannot
     # include revisions where files were removed
     force_changelog_traversal = attr.ib(default=False)
 
     # filter revisions by file patterns, which should be disabled only if
     # you want to include revisions where files were unmodified
     filter_revisions_by_pats = attr.ib(default=True)
 
     # sort revisions prior to traversal: 'desc', 'topo', or None
     sort_revisions = attr.ib(default=None)
 
     # limit number of changes displayed; None means unlimited
     limit = attr.ib(default=None)
 
 
 def parseopts(ui, pats, opts):
     # type: (Any, Sequence[bytes], Dict[bytes, Any]) -> walkopts
     """Parse log command options into walkopts
 
     The returned walkopts will be passed in to getrevs() or makewalker().
     """
     if opts.get(b'follow_first'):
         follow = 1
     elif opts.get(b'follow'):
         follow = 2
     else:
         follow = 0
 
     if opts.get(b'graph'):
         if ui.configbool(b'experimental', b'log.topo'):
             sort_revisions = b'topo'
         else:
             sort_revisions = b'desc'
     else:
         sort_revisions = None
 
     return walkopts(
         pats=pats,
         opts=opts,
         revspec=opts.get(b'rev', []),
         bookmarks=opts.get(b'bookmark', []),
         # branch and only_branch are really aliases and must be handled at
         # the same time
         branches=opts.get(b'branch', []) + opts.get(b'only_branch', []),
         date=opts.get(b'date'),
         keywords=opts.get(b'keyword', []),
         no_merges=bool(opts.get(b'no_merges')),
         only_merges=bool(opts.get(b'only_merges')),
         prune_ancestors=opts.get(b'prune', []),
         users=opts.get(b'user', []),
         include_pats=opts.get(b'include', []),
         exclude_pats=opts.get(b'exclude', []),
         follow=follow,
         force_changelog_traversal=bool(opts.get(b'removed')),
         sort_revisions=sort_revisions,
         limit=getlimit(opts),
     )
 
 
 def _makematcher(repo, revs, wopts):
     """Build matcher and expanded patterns from log options
 
     If --follow, revs are the revisions to follow from.
 
     Returns (match, pats, slowpath) where
     - match: a matcher built from the given pats and -I/-X opts
     - pats: patterns used (globs are expanded on Windows)
     - slowpath: True if patterns aren't as simple as scanning filelogs
     """
     # pats/include/exclude are passed to match.match() directly in
     # _matchfiles() revset, but a log-like command should build its matcher
     # with scmutil.match(). The difference is input pats are globbed on
     # platforms without shell expansion (windows).
     wctx = repo[None]
     match, pats = scmutil.matchandpats(wctx, wopts.pats, wopts.opts)
     slowpath = match.anypats() or (
         not match.always() and wopts.force_changelog_traversal
     )
     if not slowpath:
         if wopts.follow and wopts.revspec:
             # There may be the case that a path doesn't exist in some (but
             # not all) of the specified start revisions, but let's consider
             # the path is valid. Missing files will be warned by the matcher.
             all_files = list(match.files())
             missing_files = set(all_files)
             files = all_files
             for r in revs:
                 if not files:
                     # We don't have any file to check anymore.
                     break
                 ctx = repo[r]
                 for f in files:
                     if f in ctx:
                         missing_files.discard(f)
                     elif ctx.hasdir(f):
                         # If a directory exists in any of the start revisions,
                         # take the slow path.
                         missing_files.discard(f)
                         slowpath = True
                         # we found on slow path, no need to search for more.
                         files = missing_files
             for f in all_files:
                 if f in missing_files:
                     raise error.StateError(
                         _(
                             b'cannot follow file not in any of the specified '
                             b'revisions: "%s"'
                         )
                         % f
                     )
         elif wopts.follow:
             for f in match.files():
                 if f not in wctx:
                     # If the file exists, it may be a directory, so let it
                     # take the slow path.
                     if os.path.exists(repo.wjoin(f)):
                         slowpath = True
                         continue
                     else:
                         raise error.StateError(
                             _(
                                 b'cannot follow file not in parent '
                                 b'revision: "%s"'
                             )
                             % f
                         )
                 filelog = repo.file(f)
                 if not filelog:
                     # A file exists in wdir but not in history, which means
                     # the file isn't committed yet.
                     raise error.StateError(
                         _(b'cannot follow nonexistent file: "%s"') % f
                     )
         else:
             for f in match.files():
                 filelog = repo.file(f)
                 if not filelog:
                     # A zero count may be a directory or deleted file, so
                     # try to find matching entries on the slow path.
                     slowpath = True
 
         # We decided to fall back to the slowpath because at least one
         # of the paths was not a file. Check to see if at least one of them
         # existed in history - in that case, we'll continue down the
         # slowpath; otherwise, we can turn off the slowpath
         if slowpath:
             for path in match.files():
                 if not path or path in repo.store:
                     break
             else:
                 slowpath = False
 
     return match, pats, slowpath
 
 
 def _fileancestors(repo, revs, match, followfirst):
     fctxs = []
     for r in revs:
         ctx = repo[r]
         fctxs.extend(ctx[f].introfilectx() for f in ctx.walk(match))
 
     # When displaying a revision with --patch --follow FILE, we have
     # to know which file of the revision must be diffed. With
     # --follow, we want the names of the ancestors of FILE in the
     # revision, stored in "fcache". "fcache" is populated as a side effect
     # of the graph traversal.
     fcache = {}
 
     def filematcher(ctx):
         return scmutil.matchfiles(repo, fcache.get(scmutil.intrev(ctx), []))
 
     def revgen():
         for rev, cs in dagop.filectxancestors(fctxs, followfirst=followfirst):
             fcache[rev] = [c.path() for c in cs]
             yield rev
 
     return smartset.generatorset(revgen(), iterasc=False), filematcher
 
 
 def _makenofollowfilematcher(repo, pats, opts):
     '''hook for extensions to override the filematcher for non-follow cases'''
     return None
 
 
 def revsingle(repo, revspec, default=b'.', localalias=None):
     """Resolves user-provided revset(s) into a single revision.
 
     This just wraps the lower-level scmutil.revsingle() in order to raise an
     exception indicating user error.
     """
     try:
         return scmutil.revsingle(repo, revspec, default, localalias)
     except error.RepoLookupError as e:
         raise error.InputError(e.args[0], hint=e.hint)
 
 
 def revpair(repo, revs):
     """Resolves user-provided revset(s) into two revisions.
 
     This just wraps the lower-level scmutil.revpair() in order to raise an
     exception indicating user error.
     """
     try:
         return scmutil.revpair(repo, revs)
     except error.RepoLookupError as e:
         raise error.InputError(e.args[0], hint=e.hint)
 
 
 def revrange(repo, specs, localalias=None):
     """Resolves user-provided revset(s).
 
     This just wraps the lower-level scmutil.revrange() in order to raise an
     exception indicating user error.
     """
     try:
         return scmutil.revrange(repo, specs, localalias)
     except error.RepoLookupError as e:
         raise error.InputError(e.args[0], hint=e.hint)
 
 
 _opt2logrevset = {
     b'no_merges': (b'not merge()', None),
     b'only_merges': (b'merge()', None),
     b'_matchfiles': (None, b'_matchfiles(%ps)'),
     b'date': (b'date(%s)', None),
     b'branch': (b'branch(%s)', b'%lr'),
     b'_patslog': (b'filelog(%s)', b'%lr'),
     b'keyword': (b'keyword(%s)', b'%lr'),
     b'prune': (b'ancestors(%s)', b'not %lr'),
     b'user': (b'user(%s)', b'%lr'),
 }
 
 
 def _makerevset(repo, wopts, slowpath):
     """Return a revset string built from log options and file patterns"""
     opts = {
         b'branch': [b'literal:' + repo.lookupbranch(b) for b in wopts.branches],
         b'date': wopts.date,
         b'keyword': wopts.keywords,
         b'no_merges': wopts.no_merges,
         b'only_merges': wopts.only_merges,
         b'prune': wopts.prune_ancestors,
         b'user': [b'literal:' + v for v in wopts.users],
     }
 
     if wopts.filter_revisions_by_pats and slowpath:
         # pats/include/exclude cannot be represented as separate
         # revset expressions as their filtering logic applies at file
         # level. For instance "-I a -X b" matches a revision touching
         # "a" and "b" while "file(a) and not file(b)" does
         # not. Besides, filesets are evaluated against the working
         # directory.
         matchargs = [b'r:', b'd:relpath']
         for p in wopts.pats:
             matchargs.append(b'p:' + p)
         for p in wopts.include_pats:
             matchargs.append(b'i:' + p)
         for p in wopts.exclude_pats:
             matchargs.append(b'x:' + p)
         opts[b'_matchfiles'] = matchargs
     elif wopts.filter_revisions_by_pats and not wopts.follow:
         opts[b'_patslog'] = list(wopts.pats)
 
     expr = []
     for op, val in sorted(opts.items()):
         if not val:
             continue
         revop, listop = _opt2logrevset[op]
         if revop and b'%' not in revop:
             expr.append(revop)
         elif not listop:
             expr.append(revsetlang.formatspec(revop, val))
         else:
             if revop:
                 val = [revsetlang.formatspec(revop, v) for v in val]
             expr.append(revsetlang.formatspec(listop, val))
 
     if wopts.bookmarks:
         expr.append(
             revsetlang.formatspec(
                 b'%lr',
                 [scmutil.format_bookmark_revspec(v) for v in wopts.bookmarks],
             )
         )
 
     if expr:
         expr = b'(' + b' and '.join(expr) + b')'
     else:
         expr = None
     return expr
 
 
 def _initialrevs(repo, wopts):
     """Return the initial set of revisions to be filtered or followed"""
     if wopts.revspec:
         revs = revrange(repo, wopts.revspec)
     elif wopts.follow and repo.dirstate.p1() == repo.nullid:
         revs = smartset.baseset()
     elif wopts.follow:
         revs = repo.revs(b'.')
     else:
         revs = smartset.spanset(repo)
         revs.reverse()
     return revs
 
 
 def makewalker(repo, wopts):
     # type: (Any, walkopts) -> Tuple[smartset.abstractsmartset, Optional[Callable[[Any], matchmod.basematcher]]]
     """Build (revs, makefilematcher) to scan revision/file history
 
     - revs is the smartset to be traversed.
     - makefilematcher is a function to map ctx to a matcher for that revision
     """
     revs = _initialrevs(repo, wopts)
     if not revs:
         return smartset.baseset(), None
     # TODO: might want to merge slowpath with wopts.force_changelog_traversal
     match, pats, slowpath = _makematcher(repo, revs, wopts)
     wopts = attr.evolve(wopts, pats=pats)
 
     filematcher = None
     if wopts.follow:
         if slowpath or match.always():
             revs = dagop.revancestors(repo, revs, followfirst=wopts.follow == 1)
         else:
             assert not wopts.force_changelog_traversal
             revs, filematcher = _fileancestors(
                 repo, revs, match, followfirst=wopts.follow == 1
             )
         revs.reverse()
     if filematcher is None:
         filematcher = _makenofollowfilematcher(repo, wopts.pats, wopts.opts)
     if filematcher is None:
 
         def filematcher(ctx):
             return match
 
     expr = _makerevset(repo, wopts, slowpath)
     if wopts.sort_revisions:
         assert wopts.sort_revisions in {b'topo', b'desc'}
         if wopts.sort_revisions == b'topo':
             if not revs.istopo():
                 revs = dagop.toposort(revs, repo.changelog.parentrevs)
                 # TODO: try to iterate the set lazily
                 revs = revset.baseset(list(revs), istopo=True)
         elif not (revs.isdescending() or revs.istopo()):
             # User-specified revs might be unsorted
             revs.sort(reverse=True)
     if expr:
         matcher = revset.match(None, expr)
         revs = matcher(repo, revs)
     if wopts.limit is not None:
         revs = revs.slice(0, wopts.limit)
 
     return revs, filematcher
 
 
 def getrevs(repo, wopts):
     # type: (Any, walkopts) -> Tuple[smartset.abstractsmartset, Optional[changesetdiffer]]
     """Return (revs, differ) where revs is a smartset
 
     differ is a changesetdiffer with pre-configured file matcher.
     """
     revs, filematcher = makewalker(repo, wopts)
     if not revs:
         return revs, None
     differ = changesetdiffer()
     differ._makefilematcher = filematcher
     return revs, differ
 
 
 def _parselinerangeopt(repo, opts):
     """Parse --line-range log option and return a list of tuples (filename,
     (fromline, toline)).
     """
     linerangebyfname = []
     for pat in opts.get(b'line_range', []):
         try:
             pat, linerange = pat.rsplit(b',', 1)
         except ValueError:
             raise error.InputError(
                 _(b'malformatted line-range pattern %s') % pat
             )
         try:
             fromline, toline = map(int, linerange.split(b':'))
         except ValueError:
             raise error.InputError(_(b"invalid line range for %s") % pat)
         msg = _(b"line range pattern '%s' must match exactly one file") % pat
         fname = scmutil.parsefollowlinespattern(repo, None, pat, msg)
         linerangebyfname.append(
             (fname, util.processlinerange(fromline, toline))
         )
     return linerangebyfname
 
 
 def getlinerangerevs(repo, userrevs, opts):
     """Return (revs, differ).
 
     "revs" are revisions obtained by processing "line-range" log options and
     walking block ancestors of each specified file/line-range.
 
     "differ" is a changesetdiffer with pre-configured file matcher and hunks
     filter.
     """
     wctx = repo[None]
 
     # Two-levels map of "rev -> file ctx -> [line range]".
     linerangesbyrev = {}
     for fname, (fromline, toline) in _parselinerangeopt(repo, opts):
         if fname not in wctx:
             raise error.StateError(
                 _(b'cannot follow file not in parent revision: "%s"') % fname
             )
         fctx = wctx.filectx(fname)
         for fctx, linerange in dagop.blockancestors(fctx, fromline, toline):
             rev = fctx.introrev()
             if rev is None:
                 rev = wdirrev
             if rev not in userrevs:
                 continue
             linerangesbyrev.setdefault(rev, {}).setdefault(
                 fctx.path(), []
             ).append(linerange)
 
     def nofilterhunksfn(fctx, hunks):
         return hunks
 
     def hunksfilter(ctx):
         fctxlineranges = linerangesbyrev.get(scmutil.intrev(ctx))
         if fctxlineranges is None:
             return nofilterhunksfn
 
         def filterfn(fctx, hunks):
             lineranges = fctxlineranges.get(fctx.path())
             if lineranges is not None:
                 for hr, lines in hunks:
                     if hr is None:  # binary
                         yield hr, lines
                         continue
                     if any(mdiff.hunkinrange(hr[2:], lr) for lr in lineranges):
                         yield hr, lines
             else:
                 for hunk in hunks:
                     yield hunk
 
         return filterfn
 
     def filematcher(ctx):
         files = list(linerangesbyrev.get(scmutil.intrev(ctx), []))
         return scmutil.matchfiles(repo, files)
 
     revs = sorted(linerangesbyrev, reverse=True)
 
     differ = changesetdiffer()
     differ._makefilematcher = filematcher
     differ._makehunksfilter = hunksfilter
     return smartset.baseset(revs), differ
 
 
 def _graphnodeformatter(ui, displayer):
     spec = ui.config(b'command-templates', b'graphnode')
     if not spec:
         return templatekw.getgraphnode  # fast path for "{graphnode}"
 
     spec = templater.unquotestring(spec)
     if isinstance(displayer, changesettemplater):
         # reuse cache of slow templates
         tres = displayer._tresources
     else:
         tres = formatter.templateresources(ui)
     templ = formatter.maketemplater(
         ui, spec, defaults=templatekw.keywords, resources=tres
     )
 
     def formatnode(repo, ctx, cache):
         props = {b'ctx': ctx, b'repo': repo}
         return templ.renderdefault(props)
 
     return formatnode
 
 
 def displaygraph(ui, repo, dag, displayer, edgefn, getcopies=None, props=None):
     props = props or {}
     formatnode = _graphnodeformatter(ui, displayer)
     state = graphmod.asciistate()
     styles = state.styles
 
     # only set graph styling if HGPLAIN is not set.
     if ui.plain(b'graph'):
         # set all edge styles to |, the default pre-3.8 behaviour
         styles.update(dict.fromkeys(styles, b'|'))
     else:
         edgetypes = {
             b'parent': graphmod.PARENT,
             b'grandparent': graphmod.GRANDPARENT,
             b'missing': graphmod.MISSINGPARENT,
         }
         for name, key in edgetypes.items():
             # experimental config: experimental.graphstyle.*
             styles[key] = ui.config(
                 b'experimental', b'graphstyle.%s' % name, styles[key]
             )
             if not styles[key]:
                 styles[key] = None
 
         # experimental config: experimental.graphshorten
         state.graphshorten = ui.configbool(b'experimental', b'graphshorten')
 
     formatnode_cache = {}
     for rev, type, ctx, parents in dag:
         char = formatnode(repo, ctx, formatnode_cache)
         copies = getcopies(ctx) if getcopies else None
         edges = edgefn(type, char, state, rev, parents)
         firstedge = next(edges)
         width = firstedge[2]
         displayer.show(
             ctx, copies=copies, graphwidth=width, **pycompat.strkwargs(props)
         )
         lines = displayer.hunk.pop(rev).split(b'\n')
         if not lines[-1]:
             del lines[-1]
         displayer.flush(ctx)
         for type, char, width, coldata in itertools.chain([firstedge], edges):
             graphmod.ascii(ui, state, type, char, lines, coldata)
             lines = []
     displayer.close()
 
 
 def displaygraphrevs(ui, repo, revs, displayer, getrenamed):
     revdag = graphmod.dagwalker(repo, revs)
     displaygraph(ui, repo, revdag, displayer, graphmod.asciiedges, getrenamed)
 
 
 def displayrevs(ui, repo, revs, displayer, getcopies):
     for rev in revs:
         ctx = repo[rev]
         copies = getcopies(ctx) if getcopies else None
         displayer.show(ctx, copies=copies)
         displayer.flush(ctx)
     displayer.close()
 
 
 def checkunsupportedgraphflags(pats, opts):
     for op in [b"newest_first"]:
         if op in opts and opts[op]:
             raise error.InputError(
                 _(b"-G/--graph option is incompatible with --%s")
                 % op.replace(b"_", b"-")
             )
 
 
 def graphrevs(repo, nodes, opts):
     limit = getlimit(opts)
     nodes.reverse()
     if limit is not None:
         nodes = nodes[:limit]
     return graphmod.nodes(repo, nodes)

mercurial/mail.py

@@ -1,517 +1,527 b''
 # mail.py - mail sending bits for mercurial
 #
 # Copyright 2006 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import email
 import email.charset
 import email.generator
 import email.header
 import email.message
 import email.parser
 import io
 import os
 import smtplib
 import socket
 import time
 
+from typing import (
+    Any,
+    List,
+    Tuple,
+    Union,
+)
+
 from .i18n import _
 from .pycompat import (
     open,
 )
 from . import (
     encoding,
     error,
     pycompat,
     sslutil,
     util,
 )
 from .utils import (
     procutil,
     stringutil,
     urlutil,
 )
 
-if pycompat.TYPE_CHECKING:
-    from typing import Any, List, Tuple, Union
 
-    # keep pyflakes happy
-    assert all((Any, List, Tuple, Union))
+# keep pyflakes happy
+assert [
+    Any,
+    List,
+    Tuple,
+    Union,
+]
 
 
 class STARTTLS(smtplib.SMTP):
     """Derived class to verify the peer certificate for STARTTLS.
 
     This class allows to pass any keyword arguments to SSL socket creation.
     """
 
     def __init__(self, ui, host=None, **kwargs):
         smtplib.SMTP.__init__(self, **kwargs)
         self._ui = ui
         self._host = host
 
     def starttls(self, keyfile=None, certfile=None, context=None):
         if not self.has_extn("starttls"):
             msg = "STARTTLS extension not supported by server"
             raise smtplib.SMTPException(msg)
         (resp, reply) = self.docmd("STARTTLS")
         if resp == 220:
             self.sock = sslutil.wrapsocket(
                 self.sock,
                 keyfile,
                 certfile,
                 ui=self._ui,
                 serverhostname=self._host,
             )
             self.file = self.sock.makefile("rb")
             self.helo_resp = None
             self.ehlo_resp = None
             self.esmtp_features = {}
             self.does_esmtp = 0
         return (resp, reply)
 
 
 class SMTPS(smtplib.SMTP):
     """Derived class to verify the peer certificate for SMTPS.
 
     This class allows to pass any keyword arguments to SSL socket creation.
     """
 
     def __init__(self, ui, keyfile=None, certfile=None, host=None, **kwargs):
         self.keyfile = keyfile
         self.certfile = certfile
         smtplib.SMTP.__init__(self, **kwargs)
         self._host = host
         self.default_port = smtplib.SMTP_SSL_PORT
         self._ui = ui
 
     def _get_socket(self, host, port, timeout):
         if self.debuglevel > 0:
             self._ui.debug(b'connect: %r\n' % ((host, port),))
         new_socket = socket.create_connection((host, port), timeout)
         new_socket = sslutil.wrapsocket(
             new_socket,
             self.keyfile,
             self.certfile,
             ui=self._ui,
             serverhostname=self._host,
         )
         self.file = new_socket.makefile('rb')
         return new_socket
 
 
 def _pyhastls():
     # type: () -> bool
     """Returns true iff Python has TLS support, false otherwise."""
     try:
         import ssl
 
         getattr(ssl, 'HAS_TLS', False)
         return True
     except ImportError:
         return False
 
 
 def _smtp(ui):
     '''build an smtp connection and return a function to send mail'''
     local_hostname = ui.config(b'smtp', b'local_hostname')
     tls = ui.config(b'smtp', b'tls')
     # backward compatible: when tls = true, we use starttls.
     starttls = tls == b'starttls' or stringutil.parsebool(tls)
     smtps = tls == b'smtps'
     if (starttls or smtps) and not _pyhastls():
         raise error.Abort(_(b"can't use TLS: Python SSL support not installed"))
     mailhost = ui.config(b'smtp', b'host')
     if not mailhost:
         raise error.Abort(_(b'smtp.host not configured - cannot send mail'))
     if smtps:
         ui.note(_(b'(using smtps)\n'))
         s = SMTPS(ui, local_hostname=local_hostname, host=mailhost)
     elif starttls:
         s = STARTTLS(ui, local_hostname=local_hostname, host=mailhost)
     else:
         s = smtplib.SMTP(local_hostname=local_hostname)
     if smtps:
         defaultport = 465
     else:
         defaultport = 25
     mailport = urlutil.getport(ui.config(b'smtp', b'port', defaultport))
     ui.note(_(b'sending mail: smtp host %s, port %d\n') % (mailhost, mailport))
     s.connect(host=mailhost, port=mailport)
     if starttls:
         ui.note(_(b'(using starttls)\n'))
         s.ehlo()
         s.starttls()
         s.ehlo()
     if starttls or smtps:
         ui.note(_(b'(verifying remote certificate)\n'))
         sslutil.validatesocket(s.sock)
 
     try:
         _smtp_login(ui, s, mailhost, mailport)
     except smtplib.SMTPException as inst:
         raise error.Abort(stringutil.forcebytestr(inst))
 
     def send(sender, recipients, msg):
         try:
             return s.sendmail(sender, recipients, msg)
         except smtplib.SMTPRecipientsRefused as inst:
             recipients = [r[1] for r in inst.recipients.values()]
             raise error.Abort(b'\n' + b'\n'.join(recipients))
         except smtplib.SMTPException as inst:
             raise error.Abort(stringutil.forcebytestr(inst))
 
     return send
 
 
 def _smtp_login(ui, smtp, mailhost, mailport):
     """A hook for the keyring extension to perform the actual SMTP login.
 
     An already connected SMTP object of the proper type is provided, based on
     the current configuration.  The host and port to which the connection was
     established are provided for accessibility, since the SMTP object doesn't
     provide an accessor.  ``smtplib.SMTPException`` is raised on error.
     """
     username = ui.config(b'smtp', b'username')
     password = ui.config(b'smtp', b'password')
     if username:
         if password:
             password = encoding.strfromlocal(password)
         else:
             password = ui.getpass()
             if password is not None:
                 password = encoding.strfromlocal(password)
     if username and password:
         ui.note(_(b'(authenticating to mail server as %s)\n') % username)
         username = encoding.strfromlocal(username)
         smtp.login(username, password)
 
 
 def _sendmail(ui, sender, recipients, msg):
     '''send mail using sendmail.'''
     program = ui.config(b'email', b'method')
 
     def stremail(x):
         return procutil.shellquote(stringutil.email(encoding.strtolocal(x)))
 
     cmdline = b'%s -f %s %s' % (
         program,
         stremail(sender),
         b' '.join(map(stremail, recipients)),
     )
     ui.note(_(b'sending mail: %s\n') % cmdline)
     fp = procutil.popen(cmdline, b'wb')
     fp.write(util.tonativeeol(msg))
     ret = fp.close()
     if ret:
         raise error.Abort(
             b'%s %s'
             % (
                 os.path.basename(procutil.shellsplit(program)[0]),
                 procutil.explainexit(ret),
             )
         )
 
 
 def _mbox(mbox, sender, recipients, msg):
     '''write mails to mbox'''
     # TODO: use python mbox library for proper locking
     with open(mbox, b'ab+') as fp:
         # Should be time.asctime(), but Windows prints 2-characters day
         # of month instead of one. Make them print the same thing.
         date = time.strftime('%a %b %d %H:%M:%S %Y', time.localtime())
         fp.write(
             b'From %s %s\n'
             % (encoding.strtolocal(sender), encoding.strtolocal(date))
         )
         fp.write(msg)
         fp.write(b'\n\n')
 
 
 def connect(ui, mbox=None):
     """make a mail connection. return a function to send mail.
     call as sendmail(sender, list-of-recipients, msg)."""
     if mbox:
         open(mbox, b'wb').close()
         return lambda s, r, m: _mbox(mbox, s, r, m)
     if ui.config(b'email', b'method') == b'smtp':
         return _smtp(ui)
     return lambda s, r, m: _sendmail(ui, s, r, m)
 
 
 def sendmail(ui, sender, recipients, msg, mbox=None):
     send = connect(ui, mbox=mbox)
     return send(sender, recipients, msg)
 
 
 def validateconfig(ui):
     '''determine if we have enough config data to try sending email.'''
     method = ui.config(b'email', b'method')
     if method == b'smtp':
         if not ui.config(b'smtp', b'host'):
             raise error.Abort(
                 _(
                     b'smtp specified as email transport, '
                     b'but no smtp host configured'
                 )
             )
     else:
         command = procutil.shellsplit(method)
         command = command[0] if command else b''
         if not (command and procutil.findexe(command)):
             raise error.Abort(
                 _(b'%r specified as email transport, but not in PATH') % command
             )
 
 
 def codec2iana(cs):
     # type: (str) -> str
     ''' '''
     cs = email.charset.Charset(cs).input_charset.lower()
 
     # "latin1" normalizes to "iso8859-1", standard calls for "iso-8859-1"
     if cs.startswith("iso") and not cs.startswith("iso-"):
         return "iso-" + cs[3:]
     return cs
 
 
 def mimetextpatch(s, subtype='plain', display=False):
     # type: (bytes, str, bool) -> email.message.Message
     """Return MIME message suitable for a patch.
     Charset will be detected by first trying to decode as us-ascii, then utf-8,
     and finally the global encodings. If all those fail, fall back to
     ISO-8859-1, an encoding with that allows all byte sequences.
     Transfer encodings will be used if necessary."""
 
     cs = [
         'us-ascii',
         'utf-8',
         pycompat.sysstr(encoding.encoding),
         pycompat.sysstr(encoding.fallbackencoding),
     ]
     if display:
         cs = ['us-ascii']
     for charset in cs:
         try:
             s.decode(charset)
             return mimetextqp(s, subtype, codec2iana(charset))
         except UnicodeDecodeError:
             pass
 
     return mimetextqp(s, subtype, "iso-8859-1")
 
 
 def mimetextqp(body, subtype, charset):
     # type: (bytes, str, str) -> email.message.Message
     """Return MIME message.
     Quoted-printable transfer encoding will be used if necessary.
     """
     cs = email.charset.Charset(charset)
     msg = email.message.Message()
     msg.set_type('text/' + subtype)
 
     for line in body.splitlines():
         if len(line) > 950:
             cs.body_encoding = email.charset.QP
             break
 
     # On Python 2, this simply assigns a value. Python 3 inspects
     # body and does different things depending on whether it has
     # encode() or decode() attributes. We can get the old behavior
     # if we pass a str and charset is None and we call set_charset().
     # But we may get into  trouble later due to Python attempting to
     # encode/decode using the registered charset (or attempting to
     # use ascii in the absence of a charset).
     msg.set_payload(body, cs)
 
     return msg
 
 
 def _charsets(ui):
     # type: (Any) -> List[str]
     '''Obtains charsets to send mail parts not containing patches.'''
     charsets = [
         pycompat.sysstr(cs.lower())
         for cs in ui.configlist(b'email', b'charsets')
     ]
     fallbacks = [
         pycompat.sysstr(encoding.fallbackencoding.lower()),
         pycompat.sysstr(encoding.encoding.lower()),
         'utf-8',
     ]
     for cs in fallbacks:  # find unique charsets while keeping order
         if cs not in charsets:
             charsets.append(cs)
     return [cs for cs in charsets if not cs.endswith('ascii')]
 
 
 def _encode(ui, s, charsets):
     # type: (Any, bytes, List[str]) -> Tuple[bytes, str]
     """Returns (converted) string, charset tuple.
     Finds out best charset by cycling through sendcharsets in descending
     order. Tries both encoding and fallbackencoding for input. Only as
     last resort send as is in fake ascii.
     Caveat: Do not use for mail parts containing patches!"""
     sendcharsets = charsets or _charsets(ui)
     if not isinstance(s, bytes):
         # We have unicode data, which we need to try and encode to
         # some reasonable-ish encoding. Try the encodings the user
         # wants, and fall back to garbage-in-ascii.
         for ocs in sendcharsets:
             try:
                 return s.encode(ocs), ocs
             except UnicodeEncodeError:
                 pass
             except LookupError:
                 ui.warn(
                     _(b'ignoring invalid sendcharset: %s\n')
                     % pycompat.sysbytes(ocs)
                 )
         else:
             # Everything failed, ascii-armor what we've got and send it.
             return s.encode('ascii', 'backslashreplace'), 'us-ascii'
     # We have a bytes of unknown encoding. We'll try and guess a valid
     # encoding, falling back to pretending we had ascii even though we
     # know that's wrong.
     try:
         s.decode('ascii')
     except UnicodeDecodeError:
         for ics in (encoding.encoding, encoding.fallbackencoding):
             ics = pycompat.sysstr(ics)
             try:
                 u = s.decode(ics)
             except UnicodeDecodeError:
                 continue
             for ocs in sendcharsets:
                 try:
                     return u.encode(ocs), ocs
                 except UnicodeEncodeError:
                     pass
                 except LookupError:
                     ui.warn(
                         _(b'ignoring invalid sendcharset: %s\n')
                         % pycompat.sysbytes(ocs)
                     )
     # if ascii, or all conversion attempts fail, send (broken) ascii
     return s, 'us-ascii'
 
 
 def headencode(ui, s, charsets=None, display=False):
     # type: (Any, Union[bytes, str], List[str], bool) -> str
     '''Returns RFC-2047 compliant header from given string.'''
     if not display:
         # split into words?
         s, cs = _encode(ui, s, charsets)
         return email.header.Header(s, cs).encode()
     return encoding.strfromlocal(s)
 
 
 def _addressencode(ui, name, addr, charsets=None):
     # type: (Any, str, str, List[str]) -> str
     addr = encoding.strtolocal(addr)
     name = headencode(ui, name, charsets)
     try:
         acc, dom = addr.split(b'@')
         acc.decode('ascii')
         dom = dom.decode(pycompat.sysstr(encoding.encoding)).encode('idna')
         addr = b'%s@%s' % (acc, dom)
     except UnicodeDecodeError:
         raise error.Abort(_(b'invalid email address: %s') % addr)
     except ValueError:
         try:
             # too strict?
             addr.decode('ascii')
         except UnicodeDecodeError:
             raise error.Abort(_(b'invalid local address: %s') % addr)
     return email.utils.formataddr((name, encoding.strfromlocal(addr)))
 
 
 def addressencode(ui, address, charsets=None, display=False):
     # type: (Any, bytes, List[str], bool) -> str
     '''Turns address into RFC-2047 compliant header.'''
     if display or not address:
         return encoding.strfromlocal(address or b'')
     name, addr = email.utils.parseaddr(encoding.strfromlocal(address))
     return _addressencode(ui, name, addr, charsets)
 
 
 def addrlistencode(ui, addrs, charsets=None, display=False):
     # type: (Any, List[bytes], List[str], bool) -> List[str]
     """Turns a list of addresses into a list of RFC-2047 compliant headers.
     A single element of input list may contain multiple addresses, but output
     always has one address per item"""
     straddrs = []
     for a in addrs:
         assert isinstance(a, bytes), '%r unexpectedly not a bytestr' % a
         straddrs.append(encoding.strfromlocal(a))
     if display:
         return [a.strip() for a in straddrs if a.strip()]
 
     result = []
     for name, addr in email.utils.getaddresses(straddrs):
         if name or addr:
             r = _addressencode(ui, name, addr, charsets)
             result.append(r)
     return result
 
 
 def mimeencode(ui, s, charsets=None, display=False):
     # type: (Any, bytes, List[str], bool) -> email.message.Message
     """creates mime text object, encodes it if needed, and sets
     charset and transfer-encoding accordingly."""
     cs = 'us-ascii'
     if not display:
         s, cs = _encode(ui, s, charsets)
     return mimetextqp(s, 'plain', cs)
 
 
 Generator = email.generator.BytesGenerator
 
 
 def parse(fp):
     # type: (Any) -> email.message.Message
     ep = email.parser.Parser()
     # disable the "universal newlines" mode, which isn't binary safe.
     # I have no idea if ascii/surrogateescape is correct, but that's
     # what the standard Python email parser does.
     fp = io.TextIOWrapper(
         fp, encoding='ascii', errors='surrogateescape', newline=chr(10)
     )
     try:
         return ep.parse(fp)
     finally:
         fp.detach()
 
 
 def parsebytes(data):
     # type: (bytes) -> email.message.Message
     ep = email.parser.BytesParser()
     return ep.parsebytes(data)
 
 
 def headdecode(s):
     # type: (Union[email.header.Header, bytes]) -> bytes
     '''Decodes RFC-2047 header'''
     uparts = []
     for part, charset in email.header.decode_header(s):
         if charset is not None:
             try:
                 uparts.append(part.decode(charset))
                 continue
             except (UnicodeDecodeError, LookupError):
                 pass
         # On Python 3, decode_header() may return either bytes or unicode
         # depending on whether the header has =?<charset>? or not
         if isinstance(part, type(u'')):
             uparts.append(part)
             continue
         try:
             uparts.append(part.decode('UTF-8'))
             continue
         except UnicodeDecodeError:
             pass
         uparts.append(part.decode('ISO-8859-1'))
     return encoding.unitolocal(u' '.join(uparts))

mercurial/pathutil.py

@@ -1,391 +1,399 b''
 import contextlib
 import errno
 import os
 import posixpath
 import stat
 
 from typing import (
     Any,
     Callable,
     Iterator,
     Optional,
 )
 
 from .i18n import _
 from . import (
     encoding,
     error,
     policy,
     pycompat,
     util,
 )
 
 rustdirs = policy.importrust('dirstate', 'Dirs')
 parsers = policy.importmod('parsers')
 
+# keeps pyflakes happy
+assert [
+    Any,
+    Callable,
+    Iterator,
+    Optional,
+]
+
 
 def _lowerclean(s):
     # type: (bytes) -> bytes
     return encoding.hfsignoreclean(s.lower())
 
 
 class pathauditor:
     """ensure that a filesystem path contains no banned components.
     the following properties of a path are checked:
 
     - ends with a directory separator
     - under top-level .hg
     - starts at the root of a windows drive
     - contains ".."
 
     More check are also done about the file system states:
     - traverses a symlink (e.g. a/symlink_here/b)
     - inside a nested repository (a callback can be used to approve
       some nested repositories, e.g., subrepositories)
 
     The file system checks are only done when 'realfs' is set to True (the
     default). They should be disable then we are auditing path for operation on
     stored history.
 
     If 'cached' is set to True, audited paths and sub-directories are cached.
     Be careful to not keep the cache of unmanaged directories for long because
     audited paths may be replaced with symlinks.
     """
 
     def __init__(self, root, callback=None, realfs=True, cached=False):
         self.audited = set()
         self.auditeddir = dict()
         self.root = root
         self._realfs = realfs
         self._cached = cached
         self.callback = callback
         if os.path.lexists(root) and not util.fscasesensitive(root):
             self.normcase = util.normcase
         else:
             self.normcase = lambda x: x
 
     def __call__(self, path, mode=None):
         # type: (bytes, Optional[Any]) -> None
         """Check the relative path.
         path may contain a pattern (e.g. foodir/**.txt)"""
 
         path = util.localpath(path)
         if path in self.audited:
             return
         # AIX ignores "/" at end of path, others raise EISDIR.
         if util.endswithsep(path):
             raise error.InputError(
                 _(b"path ends in directory separator: %s") % path
             )
         parts = util.splitpath(path)
         if (
             os.path.splitdrive(path)[0]
             or _lowerclean(parts[0]) in (b'.hg', b'.hg.', b'')
             or pycompat.ospardir in parts
         ):
             raise error.InputError(
                 _(b"path contains illegal component: %s") % path
             )
         # Windows shortname aliases
         if b"~" in path:
             for p in parts:
                 if b"~" in p:
                     first, last = p.split(b"~", 1)
                     if last.isdigit() and first.upper() in [b"HG", b"HG8B6C"]:
                         raise error.InputError(
                             _(b"path contains illegal component: %s") % path
                         )
         if b'.hg' in _lowerclean(path):
             lparts = [_lowerclean(p) for p in parts]
             for p in b'.hg', b'.hg.':
                 if p in lparts[1:]:
                     pos = lparts.index(p)
                     base = os.path.join(*parts[:pos])
                     raise error.InputError(
                         _(b"path '%s' is inside nested repo %r")
                         % (path, pycompat.bytestr(base))
                     )
 
         if self._realfs:
             # It's important that we check the path parts starting from the root.
             # We don't want to add "foo/bar/baz" to auditeddir before checking if
             # there's a "foo/.hg" directory. This also means we won't accidentally
             # traverse a symlink into some other filesystem (which is potentially
             # expensive to access).
             for prefix in finddirs_rev_noroot(path):
                 if prefix in self.auditeddir:
                     res = self.auditeddir[prefix]
                 else:
                     res = pathauditor._checkfs_exists(
                         self.root, prefix, path, self.callback
                     )
                     if self._cached:
                         self.auditeddir[prefix] = res
                 if not res:
                     break
 
         if self._cached:
             self.audited.add(path)
 
     @staticmethod
     def _checkfs_exists(
         root,
         prefix: bytes,
         path: bytes,
         callback: Optional[Callable[[bytes], bool]] = None,
     ):
         """raise exception if a file system backed check fails.
 
         Return a bool that indicates that the directory (or file) exists."""
         curpath = os.path.join(root, prefix)
         try:
             st = os.lstat(curpath)
         except OSError as err:
             if err.errno == errno.ENOENT:
                 return False
             # EINVAL can be raised as invalid path syntax under win32.
             # They must be ignored for patterns can be checked too.
             if err.errno not in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
                 raise
         else:
             if stat.S_ISLNK(st.st_mode):
                 msg = _(b'path %r traverses symbolic link %r') % (
                     pycompat.bytestr(path),
                     pycompat.bytestr(prefix),
                 )
                 raise error.Abort(msg)
             elif stat.S_ISDIR(st.st_mode) and os.path.isdir(
                 os.path.join(curpath, b'.hg')
             ):
                 if not callback or not callback(curpath):
                     msg = _(b"path '%s' is inside nested repo %r")
                     raise error.Abort(msg % (path, pycompat.bytestr(prefix)))
         return True
 
     def check(self, path):
         # type: (bytes) -> bool
         try:
             self(path)
             return True
         except (OSError, error.Abort):
             return False
 
     @contextlib.contextmanager
     def cached(self):
         if self._cached:
             yield
         else:
             try:
                 self._cached = True
                 yield
             finally:
                 self.audited.clear()
                 self.auditeddir.clear()
                 self._cached = False
 
 
 def canonpath(root, cwd, myname, auditor=None):
     # type: (bytes, bytes, bytes, Optional[pathauditor]) -> bytes
     """return the canonical path of myname, given cwd and root
 
     >>> def check(root, cwd, myname):
     ...     a = pathauditor(root, realfs=False)
     ...     try:
     ...         return canonpath(root, cwd, myname, a)
     ...     except error.Abort:
     ...         return 'aborted'
     >>> def unixonly(root, cwd, myname, expected='aborted'):
     ...     if pycompat.iswindows:
     ...         return expected
     ...     return check(root, cwd, myname)
     >>> def winonly(root, cwd, myname, expected='aborted'):
     ...     if not pycompat.iswindows:
     ...         return expected
     ...     return check(root, cwd, myname)
     >>> winonly(b'd:\\\\repo', b'c:\\\\dir', b'filename')
     'aborted'
     >>> winonly(b'c:\\\\repo', b'c:\\\\dir', b'filename')
     'aborted'
     >>> winonly(b'c:\\\\repo', b'c:\\\\', b'filename')
     'aborted'
     >>> winonly(b'c:\\\\repo', b'c:\\\\', b'repo\\\\filename',
     ...         b'filename')
     'filename'
     >>> winonly(b'c:\\\\repo', b'c:\\\\repo', b'filename', b'filename')
     'filename'
     >>> winonly(b'c:\\\\repo', b'c:\\\\repo\\\\subdir', b'filename',
     ...         b'subdir/filename')
     'subdir/filename'
     >>> unixonly(b'/repo', b'/dir', b'filename')
     'aborted'
     >>> unixonly(b'/repo', b'/', b'filename')
     'aborted'
     >>> unixonly(b'/repo', b'/', b'repo/filename', b'filename')
     'filename'
     >>> unixonly(b'/repo', b'/repo', b'filename', b'filename')
     'filename'
     >>> unixonly(b'/repo', b'/repo/subdir', b'filename', b'subdir/filename')
     'subdir/filename'
     """
     if util.endswithsep(root):
         rootsep = root
     else:
         rootsep = root + pycompat.ossep
     name = myname
     if not os.path.isabs(name):
         name = os.path.join(root, cwd, name)
     name = os.path.normpath(name)
     if auditor is None:
         auditor = pathauditor(root)
     if name != rootsep and name.startswith(rootsep):
         name = name[len(rootsep) :]
         auditor(name)
         return util.pconvert(name)
     elif name == root:
         return b''
     else:
         # Determine whether `name' is in the hierarchy at or beneath `root',
         # by iterating name=dirname(name) until that causes no change (can't
         # check name == '/', because that doesn't work on windows). The list
         # `rel' holds the reversed list of components making up the relative
         # file name we want.
         rel = []
         while True:
             try:
                 s = util.samefile(name, root)
             except OSError:
                 s = False
             if s:
                 if not rel:
                     # name was actually the same as root (maybe a symlink)
                     return b''
                 rel.reverse()
                 name = os.path.join(*rel)
                 auditor(name)
                 return util.pconvert(name)
             dirname, basename = util.split(name)
             rel.append(basename)
             if dirname == name:
                 break
             name = dirname
 
         # A common mistake is to use -R, but specify a file relative to the repo
         # instead of cwd.  Detect that case, and provide a hint to the user.
         hint = None
         try:
             if cwd != root:
                 canonpath(root, root, myname, auditor)
                 relpath = util.pathto(root, cwd, b'')
                 if relpath.endswith(pycompat.ossep):
                     relpath = relpath[:-1]
                 hint = _(b"consider using '--cwd %s'") % relpath
         except error.Abort:
             pass
 
         raise error.Abort(
             _(b"%s not under root '%s'") % (myname, root), hint=hint
         )
 
 
 def normasprefix(path):
     # type: (bytes) -> bytes
     """normalize the specified path as path prefix
 
     Returned value can be used safely for "p.startswith(prefix)",
     "p[len(prefix):]", and so on.
 
     For efficiency, this expects "path" argument to be already
     normalized by "os.path.normpath", "os.path.realpath", and so on.
 
     See also issue3033 for detail about need of this function.
 
     >>> normasprefix(b'/foo/bar').replace(pycompat.ossep, b'/')
     '/foo/bar/'
     >>> normasprefix(b'/').replace(pycompat.ossep, b'/')
     '/'
     """
     d, p = os.path.splitdrive(path)
     if len(p) != len(pycompat.ossep):
         return path + pycompat.ossep
     else:
         return path
 
 
 def finddirs(path):
     # type: (bytes) -> Iterator[bytes]
     pos = path.rfind(b'/')
     while pos != -1:
         yield path[:pos]
         pos = path.rfind(b'/', 0, pos)
     yield b''
 
 
 def finddirs_rev_noroot(path: bytes) -> Iterator[bytes]:
     pos = path.find(pycompat.ossep)
     while pos != -1:
         yield path[:pos]
         pos = path.find(pycompat.ossep, pos + 1)
 
 
 class dirs:
     '''a multiset of directory names from a set of file paths'''
 
     def __init__(self, map, only_tracked=False):
         """
         a dict map indicates a dirstate while a list indicates a manifest
         """
         self._dirs = {}
         addpath = self.addpath
         if isinstance(map, dict) and only_tracked:
             for f, s in map.items():
                 if s.state != b'r':
                     addpath(f)
         elif only_tracked:
             msg = b"`only_tracked` is only supported with a dict source"
             raise error.ProgrammingError(msg)
         else:
             for f in map:
                 addpath(f)
 
     def addpath(self, path):
         # type: (bytes) -> None
         dirs = self._dirs
         for base in finddirs(path):
             if base.endswith(b'/'):
                 raise ValueError(
                     "found invalid consecutive slashes in path: %r" % base
                 )
             if base in dirs:
                 dirs[base] += 1
                 return
             dirs[base] = 1
 
     def delpath(self, path):
         # type: (bytes) -> None
         dirs = self._dirs
         for base in finddirs(path):
             if dirs[base] > 1:
                 dirs[base] -= 1
                 return
             del dirs[base]
 
     def __iter__(self):
         return iter(self._dirs)
 
     def __contains__(self, d):
         # type: (bytes) -> bool
         return d in self._dirs
 
 
 if hasattr(parsers, 'dirs'):
     dirs = parsers.dirs
 
 if rustdirs is not None:
     dirs = rustdirs
 
 
 # forward two methods from posixpath that do what we need, but we'd
 # rather not let our internals know that we're thinking in posix terms
 # - instead we'll let them be oblivious.
 join = posixpath.join
 dirname = posixpath.dirname  # type: Callable[[bytes], bytes]

mercurial/phases.py

@@ -1,979 +1,997 b''
 """ Mercurial phases support code
 
     ---
 
     Copyright 2011 Pierre-Yves David <[e-mail]>
                    Logilab SA        <[e-mail]>
                    Augie Fackler     <[e-mail]>
 
     This software may be used and distributed according to the terms
     of the GNU General Public License version 2 or any later version.
 
     ---
 
 This module implements most phase logic in mercurial.
 
 
 Basic Concept
 =============
 
 A 'changeset phase' is an indicator that tells us how a changeset is
 manipulated and communicated. The details of each phase is described
 below, here we describe the properties they have in common.
 
 Like bookmarks, phases are not stored in history and thus are not
 permanent and leave no audit trail.
 
 First, no changeset can be in two phases at once. Phases are ordered,
 so they can be considered from lowest to highest. The default, lowest
 phase is 'public' - this is the normal phase of existing changesets. A
 child changeset can not be in a lower phase than its parents.
 
 These phases share a hierarchy of traits:
 
             immutable shared
     public:     X        X
     draft:               X
     secret:
 
 Local commits are draft by default.
 
 Phase Movement and Exchange
 ===========================
 
 Phase data is exchanged by pushkey on pull and push. Some servers have
 a publish option set, we call such a server a "publishing server".
 Pushing a draft changeset to a publishing server changes the phase to
 public.
 
 A small list of fact/rules define the exchange of phase:
 
 * old client never changes server states
 * pull never changes server states
 * publish and old server changesets are seen as public by client
 * any secret changeset seen in another repository is lowered to at
   least draft
 
 Here is the final table summing up the 49 possible use cases of phase
 exchange:
 
                            server
                   old     publish      non-publish
                  N   X    N   D   P    N   D   P
     old client
     pull
      N           -   X/X  -   X/D X/P  -   X/D X/P
      X           -   X/X  -   X/D X/P  -   X/D X/P
     push
      X           X/X X/X  X/P X/P X/P  X/D X/D X/P
     new client
     pull
      N           -   P/X  -   P/D P/P  -   D/D P/P
      D           -   P/X  -   P/D P/P  -   D/D P/P
      P           -   P/X  -   P/D P/P  -   P/D P/P
     push
      D           P/X P/X  P/P P/P P/P  D/D D/D P/P
      P           P/X P/X  P/P P/P P/P  P/P P/P P/P
 
 Legend:
 
     A/B = final state on client / state on server
 
     * N = new/not present,
     * P = public,
     * D = draft,
     * X = not tracked (i.e., the old client or server has no internal
           way of recording the phase.)
 
     passive = only pushes
 
 
     A cell here can be read like this:
 
     "When a new client pushes a draft changeset (D) to a publishing
     server where it's not present (N), it's marked public on both
     sides (P/P)."
 
 Note: old client behave as a publishing server with draft only content
 - other people see it as public
 - content is pushed as draft
 
 """
 
 
 import struct
+import typing
+
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    Iterable,
+    List,
+    Optional,
+    Set,
+    Tuple,
+)
 
 from .i18n import _
 from .node import (
     bin,
     hex,
     nullrev,
     short,
     wdirrev,
 )
 from . import (
     error,
     pycompat,
     requirements,
     smartset,
     txnutil,
     util,
 )
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Any,
-        Callable,
-        Dict,
-        Iterable,
-        List,
-        Optional,
-        Set,
-        Tuple,
-    )
+# keeps pyflakes happy
+assert [
+    Any,
+    Callable,
+    Dict,
+    Iterable,
+    List,
+    Optional,
+    Set,
+    Tuple,
+]
+
+Phaseroots = Dict[int, Set[bytes]]
+
+if typing.TYPE_CHECKING:
     from . import (
         localrepo,
         ui as uimod,
     )
 
-    Phaseroots = Dict[int, Set[bytes]]
+    # keeps pyflakes happy
+    assert [uimod]
+
     Phasedefaults = List[
         Callable[[localrepo.localrepository, Phaseroots], Phaseroots]
     ]
 
 
 _fphasesentry = struct.Struct(b'>i20s')
 
 # record phase index
 public, draft, secret = range(3)  # type: int
 archived = 32  # non-continuous for compatibility
 internal = 96  # non-continuous for compatibility
 allphases = (public, draft, secret, archived, internal)
 trackedphases = (draft, secret, archived, internal)
 not_public_phases = trackedphases
 # record phase names
 cmdphasenames = [b'public', b'draft', b'secret']  # known to `hg phase` command
 phasenames = dict(enumerate(cmdphasenames))
 phasenames[archived] = b'archived'
 phasenames[internal] = b'internal'
 # map phase name to phase number
 phasenumber = {name: phase for phase, name in phasenames.items()}
 # like phasenumber, but also include maps for the numeric and binary
 # phase number to the phase number
 phasenumber2 = phasenumber.copy()
 phasenumber2.update({phase: phase for phase in phasenames})
 phasenumber2.update({b'%i' % phase: phase for phase in phasenames})
 # record phase property
 mutablephases = (draft, secret, archived, internal)
 relevant_mutable_phases = (draft, secret)  # could be obsolete or unstable
 remotehiddenphases = (secret, archived, internal)
 localhiddenphases = (internal, archived)
 
 all_internal_phases = tuple(p for p in allphases if p & internal)
 # We do not want any internal content to exit the repository, ever.
 no_bundle_phases = all_internal_phases
 
 
 def supportinternal(repo):
     # type: (localrepo.localrepository) -> bool
     """True if the internal phase can be used on a repository"""
     return requirements.INTERNAL_PHASE_REQUIREMENT in repo.requirements
 
 
 def supportarchived(repo):
     # type: (localrepo.localrepository) -> bool
     """True if the archived phase can be used on a repository"""
     return requirements.ARCHIVED_PHASE_REQUIREMENT in repo.requirements
 
 
 def _readroots(repo, phasedefaults=None):
     # type: (localrepo.localrepository, Optional[Phasedefaults]) -> Tuple[Phaseroots, bool]
     """Read phase roots from disk
 
     phasedefaults is a list of fn(repo, roots) callable, which are
     executed if the phase roots file does not exist. When phases are
     being initialized on an existing repository, this could be used to
     set selected changesets phase to something else than public.
 
     Return (roots, dirty) where dirty is true if roots differ from
     what is being stored.
     """
     repo = repo.unfiltered()
     dirty = False
     roots = {i: set() for i in allphases}
     try:
         f, pending = txnutil.trypending(repo.root, repo.svfs, b'phaseroots')
         try:
             for line in f:
                 phase, nh = line.split()
                 roots[int(phase)].add(bin(nh))
         finally:
             f.close()
     except FileNotFoundError:
         if phasedefaults:
             for f in phasedefaults:
                 roots = f(repo, roots)
         dirty = True
     return roots, dirty
 
 
 def binaryencode(phasemapping):
     # type: (Dict[int, List[bytes]]) -> bytes
     """encode a 'phase -> nodes' mapping into a binary stream
 
     The revision lists are encoded as (phase, root) pairs.
     """
     binarydata = []
     for phase, nodes in phasemapping.items():
         for head in nodes:
             binarydata.append(_fphasesentry.pack(phase, head))
     return b''.join(binarydata)
 
 
 def binarydecode(stream):
     # type: (...) -> Dict[int, List[bytes]]
     """decode a binary stream into a 'phase -> nodes' mapping
 
     The (phase, root) pairs are turned back into a dictionary with
     the phase as index and the aggregated roots of that phase as value."""
     headsbyphase = {i: [] for i in allphases}
     entrysize = _fphasesentry.size
     while True:
         entry = stream.read(entrysize)
         if len(entry) < entrysize:
             if entry:
                 raise error.Abort(_(b'bad phase-heads stream'))
             break
         phase, node = _fphasesentry.unpack(entry)
         headsbyphase[phase].append(node)
     return headsbyphase
 
 
 def _sortedrange_insert(data, idx, rev, t):
     merge_before = False
     if idx:
         r1, t1 = data[idx - 1]
         merge_before = r1[-1] + 1 == rev and t1 == t
     merge_after = False
     if idx < len(data):
         r2, t2 = data[idx]
         merge_after = r2[0] == rev + 1 and t2 == t
 
     if merge_before and merge_after:
         data[idx - 1] = (range(r1[0], r2[-1] + 1), t)
         data.pop(idx)
     elif merge_before:
         data[idx - 1] = (range(r1[0], rev + 1), t)
     elif merge_after:
         data[idx] = (range(rev, r2[-1] + 1), t)
     else:
         data.insert(idx, (range(rev, rev + 1), t))
 
 
 def _sortedrange_split(data, idx, rev, t):
     r1, t1 = data[idx]
     if t == t1:
         return
     t = (t1[0], t[1])
     if len(r1) == 1:
         data.pop(idx)
         _sortedrange_insert(data, idx, rev, t)
     elif r1[0] == rev:
         data[idx] = (range(rev + 1, r1[-1] + 1), t1)
         _sortedrange_insert(data, idx, rev, t)
     elif r1[-1] == rev:
         data[idx] = (range(r1[0], rev), t1)
         _sortedrange_insert(data, idx + 1, rev, t)
     else:
         data[idx : idx + 1] = [
             (range(r1[0], rev), t1),
             (range(rev, rev + 1), t),
             (range(rev + 1, r1[-1] + 1), t1),
         ]
 
 
 def _trackphasechange(data, rev, old, new):
     """add a phase move to the <data> list of ranges
 
     If data is None, nothing happens.
     """
     if data is None:
         return
 
     # If data is empty, create a one-revision range and done
     if not data:
         data.insert(0, (range(rev, rev + 1), (old, new)))
         return
 
     low = 0
     high = len(data)
     t = (old, new)
     while low < high:
         mid = (low + high) // 2
         revs = data[mid][0]
         revs_low = revs[0]
         revs_high = revs[-1]
 
         if rev >= revs_low and rev <= revs_high:
             _sortedrange_split(data, mid, rev, t)
             return
 
         if revs_low == rev + 1:
             if mid and data[mid - 1][0][-1] == rev:
                 _sortedrange_split(data, mid - 1, rev, t)
             else:
                 _sortedrange_insert(data, mid, rev, t)
             return
 
         if revs_high == rev - 1:
             if mid + 1 < len(data) and data[mid + 1][0][0] == rev:
                 _sortedrange_split(data, mid + 1, rev, t)
             else:
                 _sortedrange_insert(data, mid + 1, rev, t)
             return
 
         if revs_low > rev:
             high = mid
         else:
             low = mid + 1
 
     if low == len(data):
         data.append((range(rev, rev + 1), t))
         return
 
     r1, t1 = data[low]
     if r1[0] > rev:
         data.insert(low, (range(rev, rev + 1), t))
     else:
         data.insert(low + 1, (range(rev, rev + 1), t))
 
 
 class phasecache:
     def __init__(self, repo, phasedefaults, _load=True):
         # type: (localrepo.localrepository, Optional[Phasedefaults], bool) -> None
         if _load:
             # Cheap trick to allow shallow-copy without copy module
             self.phaseroots, self.dirty = _readroots(repo, phasedefaults)
             self._loadedrevslen = 0
             self._phasesets = None
             self.filterunknown(repo)
             self.opener = repo.svfs
 
     def hasnonpublicphases(self, repo):
         # type: (localrepo.localrepository) -> bool
         """detect if there are revisions with non-public phase"""
         repo = repo.unfiltered()
         cl = repo.changelog
         if len(cl) >= self._loadedrevslen:
             self.invalidate()
             self.loadphaserevs(repo)
         return any(
             revs for phase, revs in self.phaseroots.items() if phase != public
         )
 
     def nonpublicphaseroots(self, repo):
         # type: (localrepo.localrepository) -> Set[bytes]
         """returns the roots of all non-public phases
 
         The roots are not minimized, so if the secret revisions are
         descendants of draft revisions, their roots will still be present.
         """
         repo = repo.unfiltered()
         cl = repo.changelog
         if len(cl) >= self._loadedrevslen:
             self.invalidate()
             self.loadphaserevs(repo)
         return set().union(
             *[
                 revs
                 for phase, revs in self.phaseroots.items()
                 if phase != public
             ]
         )
 
     def getrevset(self, repo, phases, subset=None):
         # type: (localrepo.localrepository, Iterable[int], Optional[Any]) -> Any
         # TODO: finish typing this
         """return a smartset for the given phases"""
         self.loadphaserevs(repo)  # ensure phase's sets are loaded
         phases = set(phases)
         publicphase = public in phases
 
         if publicphase:
             # In this case, phases keeps all the *other* phases.
             phases = set(allphases).difference(phases)
             if not phases:
                 return smartset.fullreposet(repo)
 
         # fast path: _phasesets contains the interesting sets,
         # might only need a union and post-filtering.
         revsneedscopy = False
         if len(phases) == 1:
             [p] = phases
             revs = self._phasesets[p]
             revsneedscopy = True  # Don't modify _phasesets
         else:
             # revs has the revisions in all *other* phases.
             revs = set.union(*[self._phasesets[p] for p in phases])
 
         def _addwdir(wdirsubset, wdirrevs):
             if wdirrev in wdirsubset and repo[None].phase() in phases:
                 if revsneedscopy:
                     wdirrevs = wdirrevs.copy()
                 # The working dir would never be in the # cache, but it was in
                 # the subset being filtered for its phase (or filtered out,
                 # depending on publicphase), so add it to the output to be
                 # included (or filtered out).
                 wdirrevs.add(wdirrev)
             return wdirrevs
 
         if not publicphase:
             if repo.changelog.filteredrevs:
                 revs = revs - repo.changelog.filteredrevs
 
             if subset is None:
                 return smartset.baseset(revs)
             else:
                 revs = _addwdir(subset, revs)
                 return subset & smartset.baseset(revs)
         else:
             if subset is None:
                 subset = smartset.fullreposet(repo)
 
             revs = _addwdir(subset, revs)
 
             if not revs:
                 return subset
             return subset.filter(lambda r: r not in revs)
 
     def copy(self):
         # Shallow copy meant to ensure isolation in
         # advance/retractboundary(), nothing more.
         ph = self.__class__(None, None, _load=False)
         ph.phaseroots = self.phaseroots.copy()
         ph.dirty = self.dirty
         ph.opener = self.opener
         ph._loadedrevslen = self._loadedrevslen
         ph._phasesets = self._phasesets
         return ph
 
     def replace(self, phcache):
         """replace all values in 'self' with content of phcache"""
         for a in (
             'phaseroots',
             'dirty',
             'opener',
             '_loadedrevslen',
             '_phasesets',
         ):
             setattr(self, a, getattr(phcache, a))
 
     def _getphaserevsnative(self, repo):
         repo = repo.unfiltered()
         return repo.changelog.computephases(self.phaseroots)
 
     def _computephaserevspure(self, repo):
         repo = repo.unfiltered()
         cl = repo.changelog
         self._phasesets = {phase: set() for phase in allphases}
         lowerroots = set()
         for phase in reversed(trackedphases):
             roots = pycompat.maplist(cl.rev, self.phaseroots[phase])
             if roots:
                 ps = set(cl.descendants(roots))
                 for root in roots:
                     ps.add(root)
                 ps.difference_update(lowerroots)
                 lowerroots.update(ps)
                 self._phasesets[phase] = ps
         self._loadedrevslen = len(cl)
 
     def loadphaserevs(self, repo):
         # type: (localrepo.localrepository) -> None
         """ensure phase information is loaded in the object"""
         if self._phasesets is None:
             try:
                 res = self._getphaserevsnative(repo)
                 self._loadedrevslen, self._phasesets = res
             except AttributeError:
                 self._computephaserevspure(repo)
 
     def invalidate(self):
         self._loadedrevslen = 0
         self._phasesets = None
 
     def phase(self, repo, rev):
         # type: (localrepo.localrepository, int) -> int
         # We need a repo argument here to be able to build _phasesets
         # if necessary. The repository instance is not stored in
         # phasecache to avoid reference cycles. The changelog instance
         # is not stored because it is a filecache() property and can
         # be replaced without us being notified.
         if rev == nullrev:
             return public
         if rev < nullrev:
             raise ValueError(_(b'cannot lookup negative revision'))
         if rev >= self._loadedrevslen:
             self.invalidate()
             self.loadphaserevs(repo)
         for phase in trackedphases:
             if rev in self._phasesets[phase]:
                 return phase
         return public
 
     def write(self):
         if not self.dirty:
             return
         f = self.opener(b'phaseroots', b'w', atomictemp=True, checkambig=True)
         try:
             self._write(f)
         finally:
             f.close()
 
     def _write(self, fp):
         for phase, roots in self.phaseroots.items():
             for h in sorted(roots):
                 fp.write(b'%i %s\n' % (phase, hex(h)))
         self.dirty = False
 
     def _updateroots(self, phase, newroots, tr):
         self.phaseroots[phase] = newroots
         self.invalidate()
         self.dirty = True
 
         tr.addfilegenerator(b'phase', (b'phaseroots',), self._write)
         tr.hookargs[b'phases_moved'] = b'1'
 
     def registernew(self, repo, tr, targetphase, revs):
         repo = repo.unfiltered()
         self._retractboundary(repo, tr, targetphase, [], revs=revs)
         if tr is not None and b'phases' in tr.changes:
             phasetracking = tr.changes[b'phases']
             phase = self.phase
             for rev in sorted(revs):
                 revphase = phase(repo, rev)
                 _trackphasechange(phasetracking, rev, None, revphase)
         repo.invalidatevolatilesets()
 
     def advanceboundary(
         self, repo, tr, targetphase, nodes, revs=None, dryrun=None
     ):
         """Set all 'nodes' to phase 'targetphase'
 
         Nodes with a phase lower than 'targetphase' are not affected.
 
         If dryrun is True, no actions will be performed
 
         Returns a set of revs whose phase is changed or should be changed
         """
         # Be careful to preserve shallow-copied values: do not update
         # phaseroots values, replace them.
         if revs is None:
             revs = []
         if tr is None:
             phasetracking = None
         else:
             phasetracking = tr.changes.get(b'phases')
 
         repo = repo.unfiltered()
         revs = [repo[n].rev() for n in nodes] + [r for r in revs]
 
         changes = set()  # set of revisions to be changed
         delroots = []  # set of root deleted by this path
         for phase in (phase for phase in allphases if phase > targetphase):
             # filter nodes that are not in a compatible phase already
             revs = [rev for rev in revs if self.phase(repo, rev) >= phase]
             if not revs:
                 break  # no roots to move anymore
 
             olds = self.phaseroots[phase]
 
             affected = repo.revs(b'%ln::%ld', olds, revs)
             changes.update(affected)
             if dryrun:
                 continue
             for r in affected:
                 _trackphasechange(
                     phasetracking, r, self.phase(repo, r), targetphase
                 )
 
             roots = {
                 ctx.node()
                 for ctx in repo.set(b'roots((%ln::) - %ld)', olds, affected)
             }
             if olds != roots:
                 self._updateroots(phase, roots, tr)
                 # some roots may need to be declared for lower phases
                 delroots.extend(olds - roots)
         if not dryrun:
             # declare deleted root in the target phase
             if targetphase != 0:
                 self._retractboundary(repo, tr, targetphase, delroots)
             repo.invalidatevolatilesets()
         return changes
 
     def retractboundary(self, repo, tr, targetphase, nodes):
         oldroots = {
             phase: revs
             for phase, revs in self.phaseroots.items()
             if phase <= targetphase
         }
         if tr is None:
             phasetracking = None
         else:
             phasetracking = tr.changes.get(b'phases')
         repo = repo.unfiltered()
         if (
             self._retractboundary(repo, tr, targetphase, nodes)
             and phasetracking is not None
         ):
 
             # find the affected revisions
             new = self.phaseroots[targetphase]
             old = oldroots[targetphase]
             affected = set(repo.revs(b'(%ln::) - (%ln::)', new, old))
 
             # find the phase of the affected revision
             for phase in range(targetphase, -1, -1):
                 if phase:
                     roots = oldroots.get(phase, [])
                     revs = set(repo.revs(b'%ln::%ld', roots, affected))
                     affected -= revs
                 else:  # public phase
                     revs = affected
                 for r in sorted(revs):
                     _trackphasechange(phasetracking, r, phase, targetphase)
         repo.invalidatevolatilesets()
 
     def _retractboundary(self, repo, tr, targetphase, nodes, revs=None):
         # Be careful to preserve shallow-copied values: do not update
         # phaseroots values, replace them.
         if revs is None:
             revs = []
         if (
             targetphase == internal
             and not supportinternal(repo)
             or targetphase == archived
             and not supportarchived(repo)
         ):
             name = phasenames[targetphase]
             msg = b'this repository does not support the %s phase' % name
             raise error.ProgrammingError(msg)
 
         repo = repo.unfiltered()
         torev = repo.changelog.rev
         tonode = repo.changelog.node
         currentroots = {torev(node) for node in self.phaseroots[targetphase]}
         finalroots = oldroots = set(currentroots)
         newroots = [torev(node) for node in nodes] + [r for r in revs]
         newroots = [
             rev for rev in newroots if self.phase(repo, rev) < targetphase
         ]
 
         if newroots:
             if nullrev in newroots:
                 raise error.Abort(_(b'cannot change null revision phase'))
             currentroots.update(newroots)
 
             # Only compute new roots for revs above the roots that are being
             # retracted.
             minnewroot = min(newroots)
             aboveroots = [rev for rev in currentroots if rev >= minnewroot]
             updatedroots = repo.revs(b'roots(%ld::)', aboveroots)
 
             finalroots = {rev for rev in currentroots if rev < minnewroot}
             finalroots.update(updatedroots)
         if finalroots != oldroots:
             self._updateroots(
                 targetphase, {tonode(rev) for rev in finalroots}, tr
             )
             return True
         return False
 
     def filterunknown(self, repo):
         # type: (localrepo.localrepository) -> None
         """remove unknown nodes from the phase boundary
 
         Nothing is lost as unknown nodes only hold data for their descendants.
         """
         filtered = False
         has_node = repo.changelog.index.has_node  # to filter unknown nodes
         for phase, nodes in self.phaseroots.items():
             missing = sorted(node for node in nodes if not has_node(node))
             if missing:
                 for mnode in missing:
                     repo.ui.debug(
                         b'removing unknown node %s from %i-phase boundary\n'
                         % (short(mnode), phase)
                     )
                 nodes.symmetric_difference_update(missing)
                 filtered = True
         if filtered:
             self.dirty = True
         # filterunknown is called by repo.destroyed, we may have no changes in
         # root but _phasesets contents is certainly invalid (or at least we
         # have not proper way to check that). related to issue 3858.
         #
         # The other caller is __init__ that have no _phasesets initialized
         # anyway. If this change we should consider adding a dedicated
         # "destroyed" function to phasecache or a proper cache key mechanism
         # (see branchmap one)
         self.invalidate()
 
 
 def advanceboundary(repo, tr, targetphase, nodes, revs=None, dryrun=None):
     """Add nodes to a phase changing other nodes phases if necessary.
 
     This function move boundary *forward* this means that all nodes
     are set in the target phase or kept in a *lower* phase.
 
     Simplify boundary to contains phase roots only.
 
     If dryrun is True, no actions will be performed
 
     Returns a set of revs whose phase is changed or should be changed
     """
     if revs is None:
         revs = []
     phcache = repo._phasecache.copy()
     changes = phcache.advanceboundary(
         repo, tr, targetphase, nodes, revs=revs, dryrun=dryrun
     )
     if not dryrun:
         repo._phasecache.replace(phcache)
     return changes
 
 
 def retractboundary(repo, tr, targetphase, nodes):
     """Set nodes back to a phase changing other nodes phases if
     necessary.
 
     This function move boundary *backward* this means that all nodes
     are set in the target phase or kept in a *higher* phase.
 
     Simplify boundary to contains phase roots only."""
     phcache = repo._phasecache.copy()
     phcache.retractboundary(repo, tr, targetphase, nodes)
     repo._phasecache.replace(phcache)
 
 
 def registernew(repo, tr, targetphase, revs):
     """register a new revision and its phase
 
     Code adding revisions to the repository should use this function to
     set new changeset in their target phase (or higher).
     """
     phcache = repo._phasecache.copy()
     phcache.registernew(repo, tr, targetphase, revs)
     repo._phasecache.replace(phcache)
 
 
 def listphases(repo):
     # type: (localrepo.localrepository) -> Dict[bytes, bytes]
     """List phases root for serialization over pushkey"""
     # Use ordered dictionary so behavior is deterministic.
     keys = util.sortdict()
     value = b'%i' % draft
     cl = repo.unfiltered().changelog
     for root in repo._phasecache.phaseroots[draft]:
         if repo._phasecache.phase(repo, cl.rev(root)) <= draft:
             keys[hex(root)] = value
 
     if repo.publishing():
         # Add an extra data to let remote know we are a publishing
         # repo. Publishing repo can't just pretend they are old repo.
         # When pushing to a publishing repo, the client still need to
         # push phase boundary
         #
         # Push do not only push changeset. It also push phase data.
         # New phase data may apply to common changeset which won't be
         # push (as they are common). Here is a very simple example:
         #
         # 1) repo A push changeset X as draft to repo B
         # 2) repo B make changeset X public
         # 3) repo B push to repo A. X is not pushed but the data that
         #    X as now public should
         #
         # The server can't handle it on it's own as it has no idea of
         # client phase data.
         keys[b'publishing'] = b'True'
     return keys
 
 
 def pushphase(repo, nhex, oldphasestr, newphasestr):
     # type: (localrepo.localrepository, bytes, bytes, bytes) -> bool
     """List phases root for serialization over pushkey"""
     repo = repo.unfiltered()
     with repo.lock():
         currentphase = repo[nhex].phase()
         newphase = abs(int(newphasestr))  # let's avoid negative index surprise
         oldphase = abs(int(oldphasestr))  # let's avoid negative index surprise
         if currentphase == oldphase and newphase < oldphase:
             with repo.transaction(b'pushkey-phase') as tr:
                 advanceboundary(repo, tr, newphase, [bin(nhex)])
             return True
         elif currentphase == newphase:
             # raced, but got correct result
             return True
         else:
             return False
 
 
 def subsetphaseheads(repo, subset):
     """Finds the phase heads for a subset of a history
 
     Returns a list indexed by phase number where each item is a list of phase
     head nodes.
     """
     cl = repo.changelog
 
     headsbyphase = {i: [] for i in allphases}
     for phase in allphases:
         revset = b"heads(%%ln & _phase(%d))" % phase
         headsbyphase[phase] = [cl.node(r) for r in repo.revs(revset, subset)]
     return headsbyphase
 
 
 def updatephases(repo, trgetter, headsbyphase):
     """Updates the repo with the given phase heads"""
     # Now advance phase boundaries of all phases
     #
     # run the update (and fetch transaction) only if there are actually things
     # to update. This avoid creating empty transaction during no-op operation.
 
     for phase in allphases:
         revset = b'%ln - _phase(%s)'
         heads = [c.node() for c in repo.set(revset, headsbyphase[phase], phase)]
         if heads:
             advanceboundary(repo, trgetter(), phase, heads)
 
 
 def analyzeremotephases(repo, subset, roots):
     """Compute phases heads and root in a subset of node from root dict
 
     * subset is heads of the subset
     * roots is {<nodeid> => phase} mapping. key and value are string.
 
     Accept unknown element input
     """
     repo = repo.unfiltered()
     # build list from dictionary
     draftroots = []
     has_node = repo.changelog.index.has_node  # to filter unknown nodes
     for nhex, phase in roots.items():
         if nhex == b'publishing':  # ignore data related to publish option
             continue
         node = bin(nhex)
         phase = int(phase)
         if phase == public:
             if node != repo.nullid:
                 repo.ui.warn(
                     _(
                         b'ignoring inconsistent public root'
                         b' from remote: %s\n'
                     )
                     % nhex
                 )
         elif phase == draft:
             if has_node(node):
                 draftroots.append(node)
         else:
             repo.ui.warn(
                 _(b'ignoring unexpected root from remote: %i %s\n')
                 % (phase, nhex)
             )
     # compute heads
     publicheads = newheads(repo, subset, draftroots)
     return publicheads, draftroots
 
 
 class remotephasessummary:
     """summarize phase information on the remote side
 
     :publishing: True is the remote is publishing
     :publicheads: list of remote public phase heads (nodes)
     :draftheads: list of remote draft phase heads (nodes)
     :draftroots: list of remote draft phase root (nodes)
     """
 
     def __init__(self, repo, remotesubset, remoteroots):
         unfi = repo.unfiltered()
         self._allremoteroots = remoteroots
 
         self.publishing = remoteroots.get(b'publishing', False)
 
         ana = analyzeremotephases(repo, remotesubset, remoteroots)
         self.publicheads, self.draftroots = ana
         # Get the list of all "heads" revs draft on remote
         dheads = unfi.set(b'heads(%ln::%ln)', self.draftroots, remotesubset)
         self.draftheads = [c.node() for c in dheads]
 
 
 def newheads(repo, heads, roots):
     """compute new head of a subset minus another
 
     * `heads`: define the first subset
     * `roots`: define the second we subtract from the first"""
     # prevent an import cycle
     # phases > dagop > patch > copies > scmutil > obsolete > obsutil > phases
     from . import dagop
 
     repo = repo.unfiltered()
     cl = repo.changelog
     rev = cl.index.get_rev
     if not roots:
         return heads
     if not heads or heads == [repo.nullid]:
         return []
     # The logic operated on revisions, convert arguments early for convenience
     new_heads = {rev(n) for n in heads if n != repo.nullid}
     roots = [rev(n) for n in roots]
     # compute the area we need to remove
     affected_zone = repo.revs(b"(%ld::%ld)", roots, new_heads)
     # heads in the area are no longer heads
     new_heads.difference_update(affected_zone)
     # revisions in the area have children outside of it,
     # They might be new heads
     candidates = repo.revs(
         b"parents(%ld + (%ld and merge())) and not null", roots, affected_zone
     )
     candidates -= affected_zone
     if new_heads or candidates:
         # remove candidate that are ancestors of other heads
         new_heads.update(candidates)
         prunestart = repo.revs(b"parents(%ld) and not null", new_heads)
         pruned = dagop.reachableroots(repo, candidates, prunestart)
         new_heads.difference_update(pruned)
 
     return pycompat.maplist(cl.node, sorted(new_heads))
 
 
 def newcommitphase(ui):
     # type: (uimod.ui) -> int
     """helper to get the target phase of new commit
 
     Handle all possible values for the phases.new-commit options.
 
     """
     v = ui.config(b'phases', b'new-commit')
     try:
         return phasenumber2[v]
     except KeyError:
         raise error.ConfigError(
             _(b"phases.new-commit: not a valid phase name ('%s')") % v
         )
 
 
 def hassecret(repo):
     # type: (localrepo.localrepository) -> bool
     """utility function that check if a repo have any secret changeset."""
     return bool(repo._phasecache.phaseroots[secret])
 
 
 def preparehookargs(node, old, new):
     # type: (bytes, Optional[int], Optional[int]) -> Dict[bytes, bytes]
     if old is None:
         old = b''
     else:
         old = phasenames[old]
     return {b'node': node, b'oldphase': old, b'phase': phasenames[new]}

mercurial/posix.py

@@ -1,816 +1,809 b''
 # posix.py - Posix utility function implementations for Mercurial
 #
 #  Copyright 2005-2009 Olivia Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import errno
 import fcntl
 import getpass
 import grp
 import os
 import pwd
 import re
 import select
 import stat
 import sys
 import tempfile
 import typing
 import unicodedata
 
 from typing import (
     Any,
     AnyStr,
     Iterable,
     Iterator,
     List,
     Match,
     NoReturn,
     Optional,
     Sequence,
     Tuple,
     Union,
 )
 
 from .i18n import _
 from .pycompat import (
     open,
 )
 from . import (
     encoding,
     error,
     policy,
     pycompat,
 )
 
 osutil = policy.importmod('osutil')
 
 normpath = os.path.normpath
 samestat = os.path.samestat
 abspath = os.path.abspath  # re-exports
 
 try:
     oslink = os.link
 except AttributeError:
     # Some platforms build Python without os.link on systems that are
     # vaguely unix-like but don't have hardlink support. For those
     # poor souls, just say we tried and that it failed so we fall back
     # to copies.
     def oslink(src: bytes, dst: bytes) -> NoReturn:
         raise OSError(
             errno.EINVAL, b'hardlinks not supported: %s to %s' % (src, dst)
         )
 
 
 readlink = os.readlink
 unlink = os.unlink
 rename = os.rename
 removedirs = os.removedirs
 
 if typing.TYPE_CHECKING:
-    # Replace the various overloads that come along with aliasing stdlib methods
-    # with the narrow definition that we care about in the type checking phase
-    # only.  This ensures that both Windows and POSIX see only the definition
-    # that is actually available.
-    #
-    # Note that if we check pycompat.TYPE_CHECKING here, it is always False, and
-    # the methods aren't replaced.
 
     def normpath(path: bytes) -> bytes:
         raise NotImplementedError
 
     def abspath(path: AnyStr) -> AnyStr:
         raise NotImplementedError
 
     def oslink(src: bytes, dst: bytes) -> None:
         raise NotImplementedError
 
     def readlink(path: bytes) -> bytes:
         raise NotImplementedError
 
     def unlink(path: bytes) -> None:
         raise NotImplementedError
 
     def rename(src: bytes, dst: bytes) -> None:
         raise NotImplementedError
 
     def removedirs(name: bytes) -> None:
         raise NotImplementedError
 
 
 expandglobs: bool = False
 
 umask: int = os.umask(0)
 os.umask(umask)
 
 posixfile = open
 
 
 def split(p: bytes) -> Tuple[bytes, bytes]:
     """Same as posixpath.split, but faster
 
     >>> import posixpath
     >>> for f in [b'/absolute/path/to/file',
     ...           b'relative/path/to/file',
     ...           b'file_alone',
     ...           b'path/to/directory/',
     ...           b'/multiple/path//separators',
     ...           b'/file_at_root',
     ...           b'///multiple_leading_separators_at_root',
     ...           b'']:
     ...     assert split(f) == posixpath.split(f), f
     """
     ht = p.rsplit(b'/', 1)
     if len(ht) == 1:
         return b'', p
     nh = ht[0].rstrip(b'/')
     if nh:
         return nh, ht[1]
     return ht[0] + b'/', ht[1]
 
 
 def openhardlinks() -> bool:
     '''return true if it is safe to hold open file handles to hardlinks'''
     return True
 
 
 def nlinks(name: bytes) -> int:
     '''return number of hardlinks for the given file'''
     return os.lstat(name).st_nlink
 
 
 def parsepatchoutput(output_line: bytes) -> bytes:
     """parses the output produced by patch and returns the filename"""
     pf = output_line[14:]
     if pycompat.sysplatform == b'OpenVMS':
         if pf[0] == b'`':
             pf = pf[1:-1]  # Remove the quotes
     else:
         if pf.startswith(b"'") and pf.endswith(b"'") and b" " in pf:
             pf = pf[1:-1]  # Remove the quotes
     return pf
 
 
 def sshargs(
     sshcmd: bytes, host: bytes, user: Optional[bytes], port: Optional[bytes]
 ) -> bytes:
     '''Build argument list for ssh'''
     args = user and (b"%s@%s" % (user, host)) or host
     if b'-' in args[:1]:
         raise error.Abort(
             _(b'illegal ssh hostname or username starting with -: %s') % args
         )
     args = shellquote(args)
     if port:
         args = b'-p %s %s' % (shellquote(port), args)
     return args
 
 
 def isexec(f: bytes) -> bool:
     """check whether a file is executable"""
     return os.lstat(f).st_mode & 0o100 != 0
 
 
 def setflags(f: bytes, l: bool, x: bool) -> None:
     st = os.lstat(f)
     s = st.st_mode
     if l:
         if not stat.S_ISLNK(s):
             # switch file to link
             with open(f, b'rb') as fp:
                 data = fp.read()
             unlink(f)
             try:
                 os.symlink(data, f)
             except OSError:
                 # failed to make a link, rewrite file
                 with open(f, b"wb") as fp:
                     fp.write(data)
 
         # no chmod needed at this point
         return
     if stat.S_ISLNK(s):
         # switch link to file
         data = os.readlink(f)
         unlink(f)
         with open(f, b"wb") as fp:
             fp.write(data)
         s = 0o666 & ~umask  # avoid restatting for chmod
 
     sx = s & 0o100
     if st.st_nlink > 1 and bool(x) != bool(sx):
         # the file is a hardlink, break it
         with open(f, b"rb") as fp:
             data = fp.read()
         unlink(f)
         with open(f, b"wb") as fp:
             fp.write(data)
 
     if x and not sx:
         # Turn on +x for every +r bit when making a file executable
         # and obey umask.
         os.chmod(f, s | (s & 0o444) >> 2 & ~umask)
     elif not x and sx:
         # Turn off all +x bits
         os.chmod(f, s & 0o666)
 
 
 def copymode(
     src: bytes,
     dst: bytes,
     mode: Optional[bytes] = None,
     enforcewritable: bool = False,
 ) -> None:
     """Copy the file mode from the file at path src to dst.
     If src doesn't exist, we're using mode instead. If mode is None, we're
     using umask."""
     try:
         st_mode = os.lstat(src).st_mode & 0o777
     except FileNotFoundError:
         st_mode = mode
         if st_mode is None:
             st_mode = ~umask
         st_mode &= 0o666
 
     new_mode = st_mode
 
     if enforcewritable:
         new_mode |= stat.S_IWUSR
 
     os.chmod(dst, new_mode)
 
 
 def checkexec(path: bytes) -> bool:
     """
     Check whether the given path is on a filesystem with UNIX-like exec flags
 
     Requires a directory (like /foo/.hg)
     """
 
     # VFAT on some Linux versions can flip mode but it doesn't persist
     # a FS remount. Frequently we can detect it if files are created
     # with exec bit on.
 
     try:
         EXECFLAGS = stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH
         basedir = os.path.join(path, b'.hg')
         cachedir = os.path.join(basedir, b'wcache')
         storedir = os.path.join(basedir, b'store')
         if not os.path.exists(cachedir):
             try:
                 # we want to create the 'cache' directory, not the '.hg' one.
                 # Automatically creating '.hg' directory could silently spawn
                 # invalid Mercurial repositories. That seems like a bad idea.
                 os.mkdir(cachedir)
                 if os.path.exists(storedir):
                     copymode(storedir, cachedir)
                 else:
                     copymode(basedir, cachedir)
             except (IOError, OSError):
                 # we other fallback logic triggers
                 pass
         if os.path.isdir(cachedir):
             checkisexec = os.path.join(cachedir, b'checkisexec')
             checknoexec = os.path.join(cachedir, b'checknoexec')
 
             try:
                 m = os.stat(checkisexec).st_mode
             except FileNotFoundError:
                 # checkisexec does not exist - fall through ...
                 pass
             else:
                 # checkisexec exists, check if it actually is exec
                 if m & EXECFLAGS != 0:
                     # ensure checknoexec exists, check it isn't exec
                     try:
                         m = os.stat(checknoexec).st_mode
                     except FileNotFoundError:
                         open(checknoexec, b'w').close()  # might fail
                         m = os.stat(checknoexec).st_mode
                     if m & EXECFLAGS == 0:
                         # check-exec is exec and check-no-exec is not exec
                         return True
                     # checknoexec exists but is exec - delete it
                     unlink(checknoexec)
                 # checkisexec exists but is not exec - delete it
                 unlink(checkisexec)
 
             # check using one file, leave it as checkisexec
             checkdir = cachedir
         else:
             # check directly in path and don't leave checkisexec behind
             checkdir = path
             checkisexec = None
         fh, fn = pycompat.mkstemp(dir=checkdir, prefix=b'hg-checkexec-')
         try:
             os.close(fh)
             m = os.stat(fn).st_mode
             if m & EXECFLAGS == 0:
                 os.chmod(fn, m & 0o777 | EXECFLAGS)
                 if os.stat(fn).st_mode & EXECFLAGS != 0:
                     if checkisexec is not None:
                         os.rename(fn, checkisexec)
                         fn = None
                     return True
         finally:
             if fn is not None:
                 unlink(fn)
     except (IOError, OSError):
         # we don't care, the user probably won't be able to commit anyway
         return False
 
 
 def checklink(path: bytes) -> bool:
     """check whether the given path is on a symlink-capable filesystem"""
     # mktemp is not racy because symlink creation will fail if the
     # file already exists
     while True:
         cachedir = os.path.join(path, b'.hg', b'wcache')
         checklink = os.path.join(cachedir, b'checklink')
         # try fast path, read only
         if os.path.islink(checklink):
             return True
         if os.path.isdir(cachedir):
             checkdir = cachedir
         else:
             checkdir = path
             cachedir = None
         name = tempfile.mktemp(
             dir=pycompat.fsdecode(checkdir), prefix=r'checklink-'
         )
         name = pycompat.fsencode(name)
         try:
             fd = None
             if cachedir is None:
                 fd = pycompat.namedtempfile(
                     dir=checkdir, prefix=b'hg-checklink-'
                 )
                 target = os.path.basename(fd.name)
             else:
                 # create a fixed file to link to; doesn't matter if it
                 # already exists.
                 target = b'checklink-target'
                 try:
                     fullpath = os.path.join(cachedir, target)
                     open(fullpath, b'w').close()
                 except PermissionError:
                     # If we can't write to cachedir, just pretend
                     # that the fs is readonly and by association
                     # that the fs won't support symlinks. This
                     # seems like the least dangerous way to avoid
                     # data loss.
                     return False
             try:
                 os.symlink(target, name)
                 if cachedir is None:
                     unlink(name)
                 else:
                     try:
                         os.rename(name, checklink)
                     except OSError:
                         unlink(name)
                 return True
             except FileExistsError:
                 # link creation might race, try again
                 continue
             finally:
                 if fd is not None:
                     fd.close()
         except AttributeError:
             return False
         except OSError as inst:
             # sshfs might report failure while successfully creating the link
             if inst.errno == errno.EIO and os.path.exists(name):
                 unlink(name)
             return False
 
 
 def checkosfilename(path: bytes) -> Optional[bytes]:
     """Check that the base-relative path is a valid filename on this platform.
     Returns None if the path is ok, or a UI string describing the problem."""
     return None  # on posix platforms, every path is ok
 
 
 def getfsmountpoint(dirpath: bytes) -> Optional[bytes]:
     """Get the filesystem mount point from a directory (best-effort)
 
     Returns None if we are unsure. Raises OSError on ENOENT, EPERM, etc.
     """
     return getattr(osutil, 'getfsmountpoint', lambda x: None)(dirpath)
 
 
 def getfstype(dirpath: bytes) -> Optional[bytes]:
     """Get the filesystem type name from a directory (best-effort)
 
     Returns None if we are unsure. Raises OSError on ENOENT, EPERM, etc.
     """
     return getattr(osutil, 'getfstype', lambda x: None)(dirpath)
 
 
 def get_password() -> bytes:
     return encoding.strtolocal(getpass.getpass(''))
 
 
 def setbinary(fd) -> None:
     pass
 
 
 def pconvert(path: bytes) -> bytes:
     return path
 
 
 def localpath(path: bytes) -> bytes:
     return path
 
 
 def samefile(fpath1: bytes, fpath2: bytes) -> bool:
     """Returns whether path1 and path2 refer to the same file. This is only
     guaranteed to work for files, not directories."""
     return os.path.samefile(fpath1, fpath2)
 
 
 def samedevice(fpath1: bytes, fpath2: bytes) -> bool:
     """Returns whether fpath1 and fpath2 are on the same device. This is only
     guaranteed to work for files, not directories."""
     st1 = os.lstat(fpath1)
     st2 = os.lstat(fpath2)
     return st1.st_dev == st2.st_dev
 
 
 # os.path.normcase is a no-op, which doesn't help us on non-native filesystems
 def normcase(path: bytes) -> bytes:
     return path.lower()
 
 
 # what normcase does to ASCII strings
 normcasespec: int = encoding.normcasespecs.lower
 # fallback normcase function for non-ASCII strings
 normcasefallback = normcase
 
 if pycompat.isdarwin:
 
     def normcase(path: bytes) -> bytes:
         """
         Normalize a filename for OS X-compatible comparison:
         - escape-encode invalid characters
         - decompose to NFD
         - lowercase
         - omit ignored characters [200c-200f, 202a-202e, 206a-206f,feff]
 
         >>> normcase(b'UPPER')
         'upper'
         >>> normcase(b'Caf\\xc3\\xa9')
         'cafe\\xcc\\x81'
         >>> normcase(b'\\xc3\\x89')
         'e\\xcc\\x81'
         >>> normcase(b'\\xb8\\xca\\xc3\\xca\\xbe\\xc8.JPG') # issue3918
         '%b8%ca%c3\\xca\\xbe%c8.jpg'
         """
 
         try:
             return encoding.asciilower(path)  # exception for non-ASCII
         except UnicodeDecodeError:
             return normcasefallback(path)
 
     normcasespec = encoding.normcasespecs.lower
 
     def normcasefallback(path: bytes) -> bytes:
         try:
             u = path.decode('utf-8')
         except UnicodeDecodeError:
             # OS X percent-encodes any bytes that aren't valid utf-8
             s = b''
             pos = 0
             l = len(path)
             while pos < l:
                 try:
                     c = encoding.getutf8char(path, pos)
                     pos += len(c)
                 except ValueError:
                     c = b'%%%02X' % ord(path[pos : pos + 1])
                     pos += 1
                 s += c
 
             u = s.decode('utf-8')
 
         # Decompose then lowercase (HFS+ technote specifies lower)
         enc = unicodedata.normalize('NFD', u).lower().encode('utf-8')
         # drop HFS+ ignored characters
         return encoding.hfsignoreclean(enc)
 
 
 if pycompat.sysplatform == b'cygwin':
     # workaround for cygwin, in which mount point part of path is
     # treated as case sensitive, even though underlying NTFS is case
     # insensitive.
 
     # default mount points
     cygwinmountpoints = sorted(
         [
             b"/usr/bin",
             b"/usr/lib",
             b"/cygdrive",
         ],
         reverse=True,
     )
 
     # use upper-ing as normcase as same as NTFS workaround
     def normcase(path: bytes) -> bytes:
         pathlen = len(path)
         if (pathlen == 0) or (path[0] != pycompat.ossep):
             # treat as relative
             return encoding.upper(path)
 
         # to preserve case of mountpoint part
         for mp in cygwinmountpoints:
             if not path.startswith(mp):
                 continue
 
             mplen = len(mp)
             if mplen == pathlen:  # mount point itself
                 return mp
             if path[mplen] == pycompat.ossep:
                 return mp + encoding.upper(path[mplen:])
 
         return encoding.upper(path)
 
     normcasespec = encoding.normcasespecs.other
     normcasefallback = normcase
 
     # Cygwin translates native ACLs to POSIX permissions,
     # but these translations are not supported by native
     # tools, so the exec bit tends to be set erroneously.
     # Therefore, disable executable bit access on Cygwin.
     def checkexec(path: bytes) -> bool:
         return False
 
     # Similarly, Cygwin's symlink emulation is likely to create
     # problems when Mercurial is used from both Cygwin and native
     # Windows, with other native tools, or on shared volumes
     def checklink(path: bytes) -> bool:
         return False
 
 
 if pycompat.sysplatform == b'OpenVMS':
     # OpenVMS's symlink emulation is broken on some OpenVMS versions.
     def checklink(path):
         return False
 
 
 _needsshellquote: Optional[Match[bytes]] = None
 
 
 def shellquote(s: bytes) -> bytes:
     if pycompat.sysplatform == b'OpenVMS':
         return b'"%s"' % s
     global _needsshellquote
     if _needsshellquote is None:
         _needsshellquote = re.compile(br'[^a-zA-Z0-9._/+-]').search
     if s and not _needsshellquote(s):
         # "s" shouldn't have to be quoted
         return s
     else:
         return b"'%s'" % s.replace(b"'", b"'\\''")
 
 
 def shellsplit(s: bytes) -> List[bytes]:
     """Parse a command string in POSIX shell way (best-effort)"""
     return pycompat.shlexsplit(s, posix=True)
 
 
 def testpid(pid: int) -> bool:
     '''return False if pid dead, True if running or not sure'''
     if pycompat.sysplatform == b'OpenVMS':
         return True
     try:
         os.kill(pid, 0)
         return True
     except OSError as inst:
         return inst.errno != errno.ESRCH
 
 
 def isowner(st: os.stat_result) -> bool:
     """Return True if the stat object st is from the current user."""
     return st.st_uid == os.getuid()
 
 
 def findexe(command: bytes) -> Optional[bytes]:
     """Find executable for command searching like which does.
     If command is a basename then PATH is searched for command.
     PATH isn't searched if command is an absolute or relative path.
     If command isn't found None is returned."""
     if pycompat.sysplatform == b'OpenVMS':
         return command
 
     def findexisting(executable: bytes) -> Optional[bytes]:
         b'Will return executable if existing file'
         if os.path.isfile(executable) and os.access(executable, os.X_OK):
             return executable
         return None
 
     if pycompat.ossep in command:
         return findexisting(command)
 
     if pycompat.sysplatform == b'plan9':
         return findexisting(os.path.join(b'/bin', command))
 
     for path in encoding.environ.get(b'PATH', b'').split(pycompat.ospathsep):
         executable = findexisting(os.path.join(path, command))
         if executable is not None:
             return executable
     return None
 
 
 def setsignalhandler() -> None:
     pass
 
 
 _wantedkinds = {stat.S_IFREG, stat.S_IFLNK}
 
 
 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."""
     lstat = os.lstat
     getkind = stat.S_IFMT
     for nf in files:
         try:
             st = lstat(nf)
             if getkind(st.st_mode) not in _wantedkinds:
                 st = None
         except (FileNotFoundError, NotADirectoryError):
             st = None
         yield st
 
 
 def getuser() -> bytes:
     '''return name of current user'''
     return pycompat.fsencode(getpass.getuser())
 
 
 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 uid is None:
         uid = os.getuid()
     try:
         return pycompat.fsencode(pwd.getpwuid(uid)[0])
     except KeyError:
         return b'%d' % uid
 
 
 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."""
 
     if gid is None:
         gid = os.getgid()
     try:
         return pycompat.fsencode(grp.getgrgid(gid)[0])
     except KeyError:
         return pycompat.bytestr(gid)
 
 
 def groupmembers(name: bytes) -> List[bytes]:
     """Return the list of members of the group with the given
     name, KeyError if the group does not exist.
     """
     name = pycompat.fsdecode(name)
     return pycompat.rapply(pycompat.fsencode, list(grp.getgrnam(name).gr_mem))
 
 
 def spawndetached(args: List[bytes]) -> int:
     return os.spawnvp(os.P_NOWAIT | getattr(os, 'P_DETACH', 0), args[0], args)
 
 
 def gethgcmd():  # TODO: convert to bytes, like on Windows?
     return sys.argv[:1]
 
 
 def makedir(path: bytes, notindexed: bool) -> None:
     os.mkdir(path)
 
 
 def lookupreg(
     key: bytes,
     name: Optional[bytes] = None,
     scope: Optional[Union[int, Iterable[int]]] = None,
 ) -> Optional[bytes]:
     return None
 
 
 def hidewindow() -> None:
     """Hide current shell window.
 
     Used to hide the window opened when starting asynchronous
     child process under Windows, unneeded on other systems.
     """
     pass
 
 
 class cachestat:
     def __init__(self, path: bytes) -> None:
         self.stat = os.stat(path)
 
     def cacheable(self) -> bool:
         return bool(self.stat.st_ino)
 
     __hash__ = object.__hash__
 
     def __eq__(self, other: Any) -> bool:
         try:
             # Only dev, ino, size, mtime and atime are likely to change. Out
             # of these, we shouldn't compare atime but should compare the
             # rest. However, one of the other fields changing indicates
             # something fishy going on, so return False if anything but atime
             # changes.
             return (
                 self.stat.st_mode == other.stat.st_mode
                 and self.stat.st_ino == other.stat.st_ino
                 and self.stat.st_dev == other.stat.st_dev
                 and self.stat.st_nlink == other.stat.st_nlink
                 and self.stat.st_uid == other.stat.st_uid
                 and self.stat.st_gid == other.stat.st_gid
                 and self.stat.st_size == other.stat.st_size
                 and self.stat[stat.ST_MTIME] == other.stat[stat.ST_MTIME]
                 and self.stat[stat.ST_CTIME] == other.stat[stat.ST_CTIME]
             )
         except AttributeError:
             return False
 
     def __ne__(self, other: Any) -> bool:
         return not self == other
 
 
 def statislink(st: Optional[os.stat_result]) -> bool:
     '''check whether a stat result is a symlink'''
     return stat.S_ISLNK(st.st_mode) if st else False
 
 
 def statisexec(st: Optional[os.stat_result]) -> bool:
     '''check whether a stat result is an executable file'''
     return (st.st_mode & 0o100 != 0) if st else False
 
 
 def poll(fds):
     """block until something happens on any file descriptor
 
     This is a generic helper that will check for any activity
     (read, write.  exception) and return the list of touched files.
 
     In unsupported cases, it will raise a NotImplementedError"""
     try:
         res = select.select(fds, fds, fds)
     except ValueError:  # out of range file descriptor
         raise NotImplementedError()
     return sorted(list(set(sum(res, []))))
 
 
 def readpipe(pipe) -> bytes:
     """Read all available data from a pipe."""
     # We can't fstat() a pipe because Linux will always report 0.
     # So, we set the pipe to non-blocking mode and read everything
     # that's available.
     flags = fcntl.fcntl(pipe, fcntl.F_GETFL)
     flags |= os.O_NONBLOCK
     oldflags = fcntl.fcntl(pipe, fcntl.F_SETFL, flags)
 
     try:
         chunks = []
         while True:
             try:
                 s = pipe.read()
                 if not s:
                     break
                 chunks.append(s)
             except IOError:
                 break
 
         return b''.join(chunks)
     finally:
         fcntl.fcntl(pipe, fcntl.F_SETFL, oldflags)
 
 
 def bindunixsocket(sock, path: bytes) -> None:
     """Bind the UNIX domain socket to the specified path"""
     # use relative path instead of full path at bind() if possible, since
     # AF_UNIX path has very small length limit (107 chars) on common
     # platforms (see sys/un.h)
     dirname, basename = os.path.split(path)
     bakwdfd = None
 
     try:
         if dirname:
             bakwdfd = os.open(b'.', os.O_DIRECTORY)
             os.chdir(dirname)
         sock.bind(basename)
         if bakwdfd:
             os.fchdir(bakwdfd)
     finally:
         if bakwdfd:
             os.close(bakwdfd)

mercurial/scmposix.py

@@ -1,102 +1,103 b''
 import array
 import errno
 import fcntl
 import os
 import sys
+import typing
 
 from typing import (
     List,
     Tuple,
 )
 
 from . import (
     encoding,
     pycompat,
     util,
 )
 
-if pycompat.TYPE_CHECKING:
+if typing.TYPE_CHECKING:
     from . import ui as uimod
 
 # BSD 'more' escapes ANSI color sequences by default. This can be disabled by
 # $MORE variable, but there's no compatible option with Linux 'more'. Given
 # OS X is widely used and most modern Unix systems would have 'less', setting
 # 'less' as the default seems reasonable.
 fallbackpager = b'less'
 
 
 def _rcfiles(path: bytes) -> List[bytes]:
     rcs = [os.path.join(path, b'hgrc')]
     rcdir = os.path.join(path, b'hgrc.d')
     try:
         rcs.extend(
             [
                 os.path.join(rcdir, f)
                 for f, kind in sorted(util.listdir(rcdir))
                 if f.endswith(b".rc")
             ]
         )
     except OSError:
         pass
     return rcs
 
 
 def systemrcpath() -> List[bytes]:
     path = []
     if pycompat.sysplatform == b'plan9':
         root = b'lib/mercurial'
     else:
         root = b'etc/mercurial'
     # old mod_python does not set sys.argv
     if len(getattr(sys, 'argv', [])) > 0:
         p = os.path.dirname(os.path.dirname(pycompat.sysargv[0]))
         if p != b'/':
             path.extend(_rcfiles(os.path.join(p, root)))
     path.extend(_rcfiles(b'/' + root))
     return path
 
 
 def userrcpath() -> List[bytes]:
     if pycompat.sysplatform == b'plan9':
         return [encoding.environ[b'home'] + b'/lib/hgrc']
     elif pycompat.isdarwin:
         return [os.path.expanduser(b'~/.hgrc')]
     else:
         confighome = encoding.environ.get(b'XDG_CONFIG_HOME')
         if confighome is None or not os.path.isabs(confighome):
             confighome = os.path.expanduser(b'~/.config')
 
         return [
             os.path.expanduser(b'~/.hgrc'),
             os.path.join(confighome, b'hg', b'hgrc'),
         ]
 
 
 def termsize(ui: "uimod.ui") -> Tuple[int, int]:
     try:
         import termios
 
         TIOCGWINSZ = termios.TIOCGWINSZ  # unavailable on IRIX (issue3449)
     except (AttributeError, ImportError):
         return 80, 24
 
     for dev in (ui.ferr, ui.fout, ui.fin):
         try:
             try:
                 fd = dev.fileno()
             except AttributeError:
                 continue
             if not os.isatty(fd):
                 continue
             arri = fcntl.ioctl(fd, TIOCGWINSZ, b'\0' * 8)
             height, width = array.array('h', arri)[:2]
             if width > 0 and height > 0:
                 return width, height
         except ValueError:
             pass
         except IOError as e:
             if e.errno == errno.EINVAL:
                 pass
             else:
                 raise
     return 80, 24

mercurial/scmwindows.py

@@ -1,116 +1,117 b''
 import os
 import winreg  # pytype: disable=import-error
 
 from typing import (
     List,
+    TYPE_CHECKING,
     Tuple,
 )
 
 from . import (
     encoding,
     pycompat,
     util,
     win32,
 )
 
-if pycompat.TYPE_CHECKING:
+if TYPE_CHECKING:
     from . import ui as uimod
 
 # MS-DOS 'more' is the only pager available by default on Windows.
 fallbackpager = b'more'
 
 
 def systemrcpath() -> List[bytes]:
     '''return default os-specific hgrc search path'''
     rcpath = []
     filename = win32.executablepath()
     # Use mercurial.ini found in directory with hg.exe
     progrc = os.path.join(os.path.dirname(filename), b'mercurial.ini')
     rcpath.append(progrc)
 
     def _processdir(progrcd: bytes) -> None:
         if os.path.isdir(progrcd):
             for f, kind in sorted(util.listdir(progrcd)):
                 if f.endswith(b'.rc'):
                     rcpath.append(os.path.join(progrcd, f))
 
     # Use hgrc.d found in directory with hg.exe
     _processdir(os.path.join(os.path.dirname(filename), b'hgrc.d'))
 
     # treat a PROGRAMDATA directory as equivalent to /etc/mercurial
     programdata = encoding.environ.get(b'PROGRAMDATA')
     if programdata:
         programdata = os.path.join(programdata, b'Mercurial')
         _processdir(os.path.join(programdata, b'hgrc.d'))
 
         ini = os.path.join(programdata, b'mercurial.ini')
         if os.path.isfile(ini):
             rcpath.append(ini)
 
         ini = os.path.join(programdata, b'hgrc')
         if os.path.isfile(ini):
             rcpath.append(ini)
 
     # next look for a system rcpath in the registry
     value = util.lookupreg(
         # pytype: disable=module-attr
         b'SOFTWARE\\Mercurial',
         None,
         winreg.HKEY_LOCAL_MACHINE
         # pytype: enable=module-attr
     )
     if value and isinstance(value, bytes):
         value = util.localpath(value)
         for p in value.split(pycompat.ospathsep):
             if p.lower().endswith(b'mercurial.ini'):
                 rcpath.append(p)
             else:
                 _processdir(p)
     return rcpath
 
 
 def userrcpath() -> List[bytes]:
     '''return os-specific hgrc search path to the user dir'''
     home = _legacy_expanduser(b'~')
     path = [os.path.join(home, b'mercurial.ini'), os.path.join(home, b'.hgrc')]
     userprofile = encoding.environ.get(b'USERPROFILE')
     if userprofile and userprofile != home:
         path.append(os.path.join(userprofile, b'mercurial.ini'))
         path.append(os.path.join(userprofile, b'.hgrc'))
     return path
 
 
 def _legacy_expanduser(path: bytes) -> bytes:
     """Expand ~ and ~user constructs in the pre 3.8 style"""
 
     # Python 3.8+ changed the expansion of '~' from HOME to USERPROFILE.  See
     # https://bugs.python.org/issue36264.  It also seems to capitalize the drive
     # letter, as though it was processed through os.path.realpath().
     if not path.startswith(b'~'):
         return path
 
     i, n = 1, len(path)
     while i < n and path[i] not in b'\\/':
         i += 1
 
     if b'HOME' in encoding.environ:
         userhome = encoding.environ[b'HOME']
     elif b'USERPROFILE' in encoding.environ:
         userhome = encoding.environ[b'USERPROFILE']
     elif b'HOMEPATH' not in encoding.environ:
         return path
     else:
         try:
             drive = encoding.environ[b'HOMEDRIVE']
         except KeyError:
             drive = b''
         userhome = os.path.join(drive, encoding.environ[b'HOMEPATH'])
 
     if i != 1:  # ~user
         userhome = os.path.join(os.path.dirname(userhome), path[1:i])
 
     return userhome + path[i:]
 
 
 def termsize(ui: "uimod.ui") -> Tuple[int, int]:
     return win32.termsize()

mercurial/state.py

@@ -1,385 +1,384 b''
 # state.py - writing and reading state files in Mercurial
 #
 # Copyright 2018 Pulkit Goyal <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """
 This file contains class to wrap the state for commands and other
 related logic.
 
 All the data related to the command state is stored as dictionary in the object.
 The class has methods using which the data can be stored to disk in a file under
 .hg/ directory.
 
 We store the data on disk in cbor, for which we use the CBOR format to encode
 the data.
 """
 
 
 import contextlib
 
+from typing import (
+    Any,
+    Dict,
+)
+
 from .i18n import _
 
 from . import (
     error,
-    pycompat,
     util,
 )
 from .utils import cborutil
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Any,
-        Dict,
-    )
-
-    for t in (Any, Dict):
-        assert t
+# keeps pyflakes happy
+for t in (Any, Dict):
+    assert t
 
 
 class cmdstate:
     """a wrapper class to store the state of commands like `rebase`, `graft`,
     `histedit`, `shelve` etc. Extensions can also use this to write state files.
 
     All the data for the state is stored in the form of key-value pairs in a
     dictionary.
 
     The class object can write all the data to a file in .hg/ directory and
     can populate the object data reading that file.
 
     Uses cbor to serialize and deserialize data while writing and reading from
     disk.
     """
 
     def __init__(self, repo, fname):
         """repo is the repo object
         fname is the file name in which data should be stored in .hg directory
         """
         self._repo = repo
         self.fname = fname
 
     def read(self):
         # type: () -> Dict[bytes, Any]
         """read the existing state file and return a dict of data stored"""
         return self._read()
 
     def save(self, version, data):
         """write all the state data stored to .hg/<filename> file
 
         we use third-party library cbor to serialize data to write in the file.
         """
         if not isinstance(version, int):
             raise error.ProgrammingError(
                 b"version of state file should be an integer"
             )
 
         with self._repo.vfs(self.fname, b'wb', atomictemp=True) as fp:
             fp.write(b'%d\n' % version)
             for chunk in cborutil.streamencode(data):
                 fp.write(chunk)
 
     def _read(self):
         """reads the state file and returns a dictionary which contain
         data in the same format as it was before storing"""
         with self._repo.vfs(self.fname, b'rb') as fp:
             try:
                 int(fp.readline())
             except ValueError:
                 raise error.CorruptedState(
                     b"unknown version of state file found"
                 )
 
             return cborutil.decodeall(fp.read())[0]
 
     def delete(self):
         """drop the state file if exists"""
         util.unlinkpath(self._repo.vfs.join(self.fname), ignoremissing=True)
 
     def exists(self):
         """check whether the state file exists or not"""
         return self._repo.vfs.exists(self.fname)
 
 
 class _statecheck:
     """a utility class that deals with multistep operations like graft,
     histedit, bisect, update etc and check whether such commands
     are in an unfinished conditition or not and return appropriate message
     and hint.
     It also has the ability to register and determine the states of any new
     multistep operation or multistep command extension.
     """
 
     def __init__(
         self,
         opname,
         fname,
         clearable,
         allowcommit,
         reportonly,
         continueflag,
         stopflag,
         childopnames,
         cmdmsg,
         cmdhint,
         statushint,
         abortfunc,
         continuefunc,
     ):
         self._opname = opname
         self._fname = fname
         self._clearable = clearable
         self._allowcommit = allowcommit
         self._reportonly = reportonly
         self._continueflag = continueflag
         self._stopflag = stopflag
         self._childopnames = childopnames
         self._delegating = False
         self._cmdmsg = cmdmsg
         self._cmdhint = cmdhint
         self._statushint = statushint
         self.abortfunc = abortfunc
         self.continuefunc = continuefunc
 
     def statusmsg(self):
         """returns the hint message corresponding to the command for
         hg status --verbose
         """
         if not self._statushint:
             hint = _(
                 b'To continue:    hg %s --continue\n'
                 b'To abort:       hg %s --abort'
             ) % (self._opname, self._opname)
             if self._stopflag:
                 hint = hint + (
                     _(b'\nTo stop:        hg %s --stop') % (self._opname)
                 )
             return hint
         return self._statushint
 
     def hint(self):
         """returns the hint message corresponding to an interrupted
         operation
         """
         if not self._cmdhint:
             if not self._stopflag:
                 return _(b"use 'hg %s --continue' or 'hg %s --abort'") % (
                     self._opname,
                     self._opname,
                 )
             else:
                 return _(
                     b"use 'hg %s --continue', 'hg %s --abort', "
                     b"or 'hg %s --stop'"
                 ) % (
                     self._opname,
                     self._opname,
                     self._opname,
                 )
 
         return self._cmdhint
 
     def msg(self):
         """returns the status message corresponding to the command"""
         if not self._cmdmsg:
             return _(b'%s in progress') % (self._opname)
         return self._cmdmsg
 
     def continuemsg(self):
         """returns appropriate continue message corresponding to command"""
         return _(b'hg %s --continue') % (self._opname)
 
     def isunfinished(self, repo):
         """determines whether a multi-step operation is in progress
         or not
         """
         if self._opname == b'merge':
             return len(repo[None].parents()) > 1
         elif self._delegating:
             return False
         else:
             return repo.vfs.exists(self._fname)
 
 
 # A list of statecheck objects for multistep operations like graft.
 _unfinishedstates = []
 _unfinishedstatesbyname = {}
 
 
 def addunfinished(
     opname,
     fname,
     clearable=False,
     allowcommit=False,
     reportonly=False,
     continueflag=False,
     stopflag=False,
     childopnames=None,
     cmdmsg=b"",
     cmdhint=b"",
     statushint=b"",
     abortfunc=None,
     continuefunc=None,
 ):
     """this registers a new command or operation to unfinishedstates
     opname is the name the command or operation
     fname is the file name in which data should be stored in .hg directory.
     It is None for merge command.
     clearable boolean determines whether or not interrupted states can be
     cleared by running `hg update -C .` which in turn deletes the
     state file.
     allowcommit boolean decides whether commit is allowed during interrupted
     state or not.
     reportonly flag is used for operations like bisect where we just
     need to detect the operation using 'hg status --verbose'
     continueflag is a boolean determines whether or not a command supports
     `--continue` option or not.
     stopflag is a boolean that determines whether or not a command supports
     --stop flag
     childopnames is a list of other opnames this op uses as sub-steps of its
     own execution. They must already be added.
     cmdmsg is used to pass a different status message in case standard
     message of the format "abort: cmdname in progress" is not desired.
     cmdhint is used to pass a different hint message in case standard
     message of the format "To continue: hg cmdname --continue
     To abort: hg cmdname --abort" is not desired.
     statushint is used to pass a different status message in case standard
     message of the format ('To continue:    hg cmdname --continue'
     'To abort:       hg cmdname --abort') is not desired
     abortfunc stores the function required to abort an unfinished state.
     continuefunc stores the function required to finish an interrupted
     operation.
     """
     childopnames = childopnames or []
     statecheckobj = _statecheck(
         opname,
         fname,
         clearable,
         allowcommit,
         reportonly,
         continueflag,
         stopflag,
         childopnames,
         cmdmsg,
         cmdhint,
         statushint,
         abortfunc,
         continuefunc,
     )
 
     if opname == b'merge':
         _unfinishedstates.append(statecheckobj)
     else:
         # This check enforces that for any op 'foo' which depends on op 'bar',
         # 'foo' comes before 'bar' in _unfinishedstates. This ensures that
         # getrepostate() always returns the most specific applicable answer.
         for childopname in childopnames:
             if childopname not in _unfinishedstatesbyname:
                 raise error.ProgrammingError(
                     _(b'op %s depends on unknown op %s') % (opname, childopname)
                 )
 
         _unfinishedstates.insert(0, statecheckobj)
 
     if opname in _unfinishedstatesbyname:
         raise error.ProgrammingError(_(b'op %s registered twice') % opname)
     _unfinishedstatesbyname[opname] = statecheckobj
 
 
 def _getparentandchild(opname, childopname):
     p = _unfinishedstatesbyname.get(opname, None)
     if not p:
         raise error.ProgrammingError(_(b'unknown op %s') % opname)
     if childopname not in p._childopnames:
         raise error.ProgrammingError(
             _(b'op %s does not delegate to %s') % (opname, childopname)
         )
     c = _unfinishedstatesbyname[childopname]
     return p, c
 
 
 @contextlib.contextmanager
 def delegating(repo, opname, childopname):
     """context wrapper for delegations from opname to childopname.
 
     requires that childopname was specified when opname was registered.
 
     Usage:
       def my_command_foo_that_uses_rebase(...):
         ...
         with state.delegating(repo, 'foo', 'rebase'):
           _run_rebase(...)
         ...
     """
 
     p, c = _getparentandchild(opname, childopname)
     if p._delegating:
         raise error.ProgrammingError(
             _(b'cannot delegate from op %s recursively') % opname
         )
     p._delegating = True
     try:
         yield
     except error.ConflictResolutionRequired as e:
         # Rewrite conflict resolution advice for the parent opname.
         if e.opname == childopname:
             raise error.ConflictResolutionRequired(opname)
         raise e
     finally:
         p._delegating = False
 
 
 def ischildunfinished(repo, opname, childopname):
     """Returns true if both opname and childopname are unfinished."""
 
     p, c = _getparentandchild(opname, childopname)
     return (p._delegating or p.isunfinished(repo)) and c.isunfinished(repo)
 
 
 def continuechild(ui, repo, opname, childopname):
     """Checks that childopname is in progress, and continues it."""
 
     p, c = _getparentandchild(opname, childopname)
     if not ischildunfinished(repo, opname, childopname):
         raise error.ProgrammingError(
             _(b'child op %s of parent %s is not unfinished')
             % (childopname, opname)
         )
     if not c.continuefunc:
         raise error.ProgrammingError(
             _(b'op %s has no continue function') % childopname
         )
     return c.continuefunc(ui, repo)
 
 
 addunfinished(
     b'update',
     fname=b'updatestate',
     clearable=True,
     cmdmsg=_(b'last update was interrupted'),
     cmdhint=_(b"use 'hg update' to get a consistent checkout"),
     statushint=_(b"To continue:    hg update ."),
 )
 addunfinished(
     b'bisect',
     fname=b'bisect.state',
     allowcommit=True,
     reportonly=True,
     cmdhint=_(b"use 'hg bisect --reset'"),
     statushint=_(
         b'To mark the changeset good:    hg bisect --good\n'
         b'To mark the changeset bad:     hg bisect --bad\n'
         b'To abort:                      hg bisect --reset\n'
     ),
 )
 
 
 def getrepostate(repo):
     # experimental config: commands.status.skipstates
     skip = set(repo.ui.configlist(b'commands', b'status.skipstates'))
     for state in _unfinishedstates:
         if state._opname in skip:
             continue
         if state.isunfinished(repo):
             return (state._opname, state.statusmsg())

mercurial/subrepoutil.py

@@ -1,504 +1,525 b''
 # subrepoutil.py - sub-repository operations and substate handling
 #
 # Copyright 2009-2010 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import os
 import posixpath
 import re
+import typing
+
+from typing import (
+    Any,
+    Dict,
+    List,
+    Optional,
+    Set,
+    Tuple,
+)
 
 from .i18n import _
 from . import (
     config,
     error,
     filemerge,
     pathutil,
     phases,
-    pycompat,
     util,
 )
 from .utils import (
     stringutil,
     urlutil,
 )
 
+# keeps pyflakes happy
+assert [
+    Any,
+    Dict,
+    List,
+    Optional,
+    Set,
+    Tuple,
+]
+
 nullstate = (b'', b'', b'empty')
 
-if pycompat.TYPE_CHECKING:
-    from typing import (
-        Any,
-        Dict,
-        List,
-        Optional,
-        Set,
-        Tuple,
-    )
+if typing.TYPE_CHECKING:
     from . import (
         context,
         localrepo,
         match as matchmod,
         scmutil,
         subrepo,
         ui as uimod,
     )
 
-    Substate = Dict[bytes, Tuple[bytes, bytes, bytes]]
+    # keeps pyflakes happy
+    assert [
+        context,
+        localrepo,
+        matchmod,
+        scmutil,
+        subrepo,
+        uimod,
+    ]
+
+Substate = Dict[bytes, Tuple[bytes, bytes, bytes]]
 
 
 def state(ctx, ui):
     # type: (context.changectx, uimod.ui) -> Substate
     """return a state dict, mapping subrepo paths configured in .hgsub
     to tuple: (source from .hgsub, revision from .hgsubstate, kind
     (key in types dict))
     """
     p = config.config()
     repo = ctx.repo()
 
     def read(f, sections=None, remap=None):
         if f in ctx:
             try:
                 data = ctx[f].data()
             except FileNotFoundError:
                 # handle missing subrepo spec files as removed
                 ui.warn(
                     _(b"warning: subrepo spec file \'%s\' not found\n")
                     % repo.pathto(f)
                 )
                 return
             p.parse(f, data, sections, remap, read)
         else:
             raise error.Abort(
                 _(b"subrepo spec file \'%s\' not found") % repo.pathto(f)
             )
 
     if b'.hgsub' in ctx:
         read(b'.hgsub')
 
     for path, src in ui.configitems(b'subpaths'):
         p.set(b'subpaths', path, src, ui.configsource(b'subpaths', path))
 
     rev = {}
     if b'.hgsubstate' in ctx:
         try:
             for i, l in enumerate(ctx[b'.hgsubstate'].data().splitlines()):
                 l = l.lstrip()
                 if not l:
                     continue
                 try:
                     revision, path = l.split(b" ", 1)
                 except ValueError:
                     raise error.Abort(
                         _(
                             b"invalid subrepository revision "
                             b"specifier in \'%s\' line %d"
                         )
                         % (repo.pathto(b'.hgsubstate'), (i + 1))
                     )
                 rev[path] = revision
         except FileNotFoundError:
             pass
 
     def remap(src):
         # type: (bytes) -> bytes
         for pattern, repl in p.items(b'subpaths'):
             # Turn r'C:\foo\bar' into r'C:\\foo\\bar' since re.sub
             # does a string decode.
             repl = stringutil.escapestr(repl)
             # However, we still want to allow back references to go
             # through unharmed, so we turn r'\\1' into r'\1'. Again,
             # extra escapes are needed because re.sub string decodes.
             repl = re.sub(br'\\\\([0-9]+)', br'\\\1', repl)
             try:
                 src = re.sub(pattern, repl, src, 1)
             except re.error as e:
                 raise error.Abort(
                     _(b"bad subrepository pattern in %s: %s")
                     % (
                         p.source(b'subpaths', pattern),
                         stringutil.forcebytestr(e),
                     )
                 )
         return src
 
     state = {}
     for path, src in p.items(b''):  # type: bytes
         kind = b'hg'
         if src.startswith(b'['):
             if b']' not in src:
                 raise error.Abort(_(b'missing ] in subrepository source'))
             kind, src = src.split(b']', 1)
             kind = kind[1:]
             src = src.lstrip()  # strip any extra whitespace after ']'
 
         if not urlutil.url(src).isabs():
             parent = _abssource(repo, abort=False)
             if parent:
                 parent = urlutil.url(parent)
                 parent.path = posixpath.join(parent.path or b'', src)
                 parent.path = posixpath.normpath(parent.path)
                 joined = bytes(parent)
                 # Remap the full joined path and use it if it changes,
                 # else remap the original source.
                 remapped = remap(joined)
                 if remapped == joined:
                     src = remap(src)
                 else:
                     src = remapped
 
         src = remap(src)
         state[util.pconvert(path)] = (src.strip(), rev.get(path, b''), kind)
 
     return state
 
 
 def writestate(repo, state):
     # type: (localrepo.localrepository, Substate) -> None
     """rewrite .hgsubstate in (outer) repo with these subrepo states"""
     lines = [
         b'%s %s\n' % (state[s][1], s)
         for s in sorted(state)
         if state[s][1] != nullstate[1]
     ]
     repo.wwrite(b'.hgsubstate', b''.join(lines), b'')
 
 
 def submerge(repo, wctx, mctx, actx, overwrite, labels=None):
     # type: (localrepo.localrepository, context.workingctx, context.changectx, context.changectx, bool, Optional[Any]) -> Substate
     # TODO: type the `labels` arg
     """delegated from merge.applyupdates: merging of .hgsubstate file
     in working context, merging context and ancestor context"""
     if mctx == actx:  # backwards?
         actx = wctx.p1()
     s1 = wctx.substate
     s2 = mctx.substate
     sa = actx.substate
     sm = {}
 
     repo.ui.debug(b"subrepo merge %s %s %s\n" % (wctx, mctx, actx))
 
     def debug(s, msg, r=b""):
         if r:
             r = b"%s:%s:%s" % r
         repo.ui.debug(b"  subrepo %s: %s %s\n" % (s, msg, r))
 
     promptssrc = filemerge.partextras(labels)
     for s, l in sorted(s1.items()):
         a = sa.get(s, nullstate)
         ld = l  # local state with possible dirty flag for compares
         if wctx.sub(s).dirty():
             ld = (l[0], l[1] + b"+")
         if wctx == actx:  # overwrite
             a = ld
 
         prompts = promptssrc.copy()
         prompts[b's'] = s
         if s in s2:
             r = s2[s]
             if ld == r or r == a:  # no change or local is newer
                 sm[s] = l
                 continue
             elif ld == a:  # other side changed
                 debug(s, b"other changed, get", r)
                 wctx.sub(s).get(r, overwrite)
                 sm[s] = r
             elif ld[0] != r[0]:  # sources differ
                 prompts[b'lo'] = l[0]
                 prompts[b'ro'] = r[0]
                 if repo.ui.promptchoice(
                     _(
                         b' subrepository sources for %(s)s differ\n'
                         b'you can use (l)ocal%(l)s source (%(lo)s)'
                         b' or (r)emote%(o)s source (%(ro)s).\n'
                         b'what do you want to do?'
                         b'$$ &Local $$ &Remote'
                     )
                     % prompts,
                     0,
                 ):
                     debug(s, b"prompt changed, get", r)
                     wctx.sub(s).get(r, overwrite)
                     sm[s] = r
             elif ld[1] == a[1]:  # local side is unchanged
                 debug(s, b"other side changed, get", r)
                 wctx.sub(s).get(r, overwrite)
                 sm[s] = r
             else:
                 debug(s, b"both sides changed")
                 srepo = wctx.sub(s)
                 prompts[b'sl'] = srepo.shortid(l[1])
                 prompts[b'sr'] = srepo.shortid(r[1])
                 option = repo.ui.promptchoice(
                     _(
                         b' subrepository %(s)s diverged (local revision: %(sl)s, '
                         b'remote revision: %(sr)s)\n'
                         b'you can (m)erge, keep (l)ocal%(l)s or keep '
                         b'(r)emote%(o)s.\n'
                         b'what do you want to do?'
                         b'$$ &Merge $$ &Local $$ &Remote'
                     )
                     % prompts,
                     0,
                 )
                 if option == 0:
                     wctx.sub(s).merge(r)
                     sm[s] = l
                     debug(s, b"merge with", r)
                 elif option == 1:
                     sm[s] = l
                     debug(s, b"keep local subrepo revision", l)
                 else:
                     wctx.sub(s).get(r, overwrite)
                     sm[s] = r
                     debug(s, b"get remote subrepo revision", r)
         elif ld == a:  # remote removed, local unchanged
             debug(s, b"remote removed, remove")
             wctx.sub(s).remove()
         elif a == nullstate:  # not present in remote or ancestor
             debug(s, b"local added, keep")
             sm[s] = l
             continue
         else:
             if repo.ui.promptchoice(
                 _(
                     b' local%(l)s changed subrepository %(s)s'
                     b' which remote%(o)s removed\n'
                     b'use (c)hanged version or (d)elete?'
                     b'$$ &Changed $$ &Delete'
                 )
                 % prompts,
                 0,
             ):
                 debug(s, b"prompt remove")
                 wctx.sub(s).remove()
 
     for s, r in sorted(s2.items()):
         if s in s1:
             continue
         elif s not in sa:
             debug(s, b"remote added, get", r)
             mctx.sub(s).get(r)
             sm[s] = r
         elif r != sa[s]:
             prompts = promptssrc.copy()
             prompts[b's'] = s
             if (
                 repo.ui.promptchoice(
                     _(
                         b' remote%(o)s changed subrepository %(s)s'
                         b' which local%(l)s removed\n'
                         b'use (c)hanged version or (d)elete?'
                         b'$$ &Changed $$ &Delete'
                     )
                     % prompts,
                     0,
                 )
                 == 0
             ):
                 debug(s, b"prompt recreate", r)
                 mctx.sub(s).get(r)
                 sm[s] = r
 
     # record merged .hgsubstate
     writestate(repo, sm)
     return sm
 
 
 def precommit(ui, wctx, status, match, force=False):
     # type: (uimod.ui, context.workingcommitctx, scmutil.status, matchmod.basematcher, bool) -> Tuple[List[bytes], Set[bytes], Substate]
     """Calculate .hgsubstate changes that should be applied before committing
 
     Returns (subs, commitsubs, newstate) where
     - subs: changed subrepos (including dirty ones)
     - commitsubs: dirty subrepos which the caller needs to commit recursively
     - newstate: new state dict which the caller must write to .hgsubstate
 
     This also updates the given status argument.
     """
     subs = []
     commitsubs = set()
     newstate = wctx.substate.copy()
 
     # only manage subrepos and .hgsubstate if .hgsub is present
     if b'.hgsub' in wctx:
         # we'll decide whether to track this ourselves, thanks
         for c in status.modified, status.added, status.removed:
             if b'.hgsubstate' in c:
                 c.remove(b'.hgsubstate')
 
         # compare current state to last committed state
         # build new substate based on last committed state
         oldstate = wctx.p1().substate
         for s in sorted(newstate.keys()):
             if not match(s):
                 # ignore working copy, use old state if present
                 if s in oldstate:
                     newstate[s] = oldstate[s]
                     continue
                 if not force:
                     raise error.Abort(
                         _(b"commit with new subrepo %s excluded") % s
                     )
             dirtyreason = wctx.sub(s).dirtyreason(True)
             if dirtyreason:
                 if not ui.configbool(b'ui', b'commitsubrepos'):
                     raise error.Abort(
                         dirtyreason,
                         hint=_(b"use --subrepos for recursive commit"),
                     )
                 subs.append(s)
                 commitsubs.add(s)
             else:
                 bs = wctx.sub(s).basestate()
                 newstate[s] = (newstate[s][0], bs, newstate[s][2])
                 if oldstate.get(s, (None, None, None))[1] != bs:
                     subs.append(s)
 
         # check for removed subrepos
         for p in wctx.parents():
             r = [s for s in p.substate if s not in newstate]
             subs += [s for s in r if match(s)]
         if subs:
             if not match(b'.hgsub') and b'.hgsub' in (
                 wctx.modified() + wctx.added()
             ):
                 raise error.Abort(_(b"can't commit subrepos without .hgsub"))
             status.modified.insert(0, b'.hgsubstate')
 
     elif b'.hgsub' in status.removed:
         # clean up .hgsubstate when .hgsub is removed
         if b'.hgsubstate' in wctx and b'.hgsubstate' not in (
             status.modified + status.added + status.removed
         ):
             status.removed.insert(0, b'.hgsubstate')
 
     return subs, commitsubs, newstate
 
 
 def repo_rel_or_abs_source(repo):
     """return the source of this repo
 
     Either absolute or relative the outermost repo"""
     parent = repo
     chunks = []
     while hasattr(parent, '_subparent'):
         source = urlutil.url(parent._subsource)
         chunks.append(bytes(source))
         if source.isabs():
             break
         parent = parent._subparent
 
     chunks.reverse()
     path = posixpath.join(*chunks)
     return posixpath.normpath(path)
 
 
 def reporelpath(repo):
     # type: (localrepo.localrepository) -> bytes
     """return path to this (sub)repo as seen from outermost repo"""
     parent = repo
     while hasattr(parent, '_subparent'):
         parent = parent._subparent
     return repo.root[len(pathutil.normasprefix(parent.root)) :]
 
 
 def subrelpath(sub):
     # type: (subrepo.abstractsubrepo) -> bytes
     """return path to this subrepo as seen from outermost repo"""
     return sub._relpath
 
 
 def _abssource(repo, push=False, abort=True):
     # type: (localrepo.localrepository, bool, bool) -> Optional[bytes]
     """return pull/push path of repo - either based on parent repo .hgsub info
     or on the top repo config. Abort or return None if no source found."""
     if hasattr(repo, '_subparent'):
         source = urlutil.url(repo._subsource)
         if source.isabs():
             return bytes(source)
         source.path = posixpath.normpath(source.path)
         parent = _abssource(repo._subparent, push, abort=False)
         if parent:
             parent = urlutil.url(util.pconvert(parent))
             parent.path = posixpath.join(parent.path or b'', source.path)
             parent.path = posixpath.normpath(parent.path)
             return bytes(parent)
     else:  # recursion reached top repo
         path = None
         if hasattr(repo, '_subtoppath'):
             path = repo._subtoppath
         elif push and repo.ui.config(b'paths', b'default-push'):
             path = repo.ui.config(b'paths', b'default-push')
         elif repo.ui.config(b'paths', b'default'):
             path = repo.ui.config(b'paths', b'default')
         elif repo.shared():
             # chop off the .hg component to get the default path form.  This has
             # already run through vfsmod.vfs(..., realpath=True), so it doesn't
             # have problems with 'C:'
             return os.path.dirname(repo.sharedpath)
         if path:
             # issue5770: 'C:\' and 'C:' are not equivalent paths.  The former is
             # as expected: an absolute path to the root of the C: drive.  The
             # latter is a relative path, and works like so:
             #
             #   C:\>cd C:\some\path
             #   C:\>D:
             #   D:\>python -c "import os; print os.path.abspath('C:')"
             #   C:\some\path
             #
             #   D:\>python -c "import os; print os.path.abspath('C:relative')"
             #   C:\some\path\relative
             if urlutil.hasdriveletter(path):
                 if len(path) == 2 or path[2:3] not in br'\/':
                     path = util.abspath(path)
             return path
 
     if abort:
         raise error.Abort(_(b"default path for subrepository not found"))
 
 
 def newcommitphase(ui, ctx):
     # type: (uimod.ui, context.changectx) -> int
     commitphase = phases.newcommitphase(ui)
     substate = getattr(ctx, "substate", None)
     if not substate:
         return commitphase
     check = ui.config(b'phases', b'checksubrepos')
     if check not in (b'ignore', b'follow', b'abort'):
         raise error.Abort(
             _(b'invalid phases.checksubrepos configuration: %s') % check
         )
     if check == b'ignore':
         return commitphase
     maxphase = phases.public
     maxsub = None
     for s in sorted(substate):
         sub = ctx.sub(s)
         subphase = sub.phase(substate[s][1])
         if maxphase < subphase:
             maxphase = subphase
             maxsub = s
     if commitphase < maxphase:
         if check == b'abort':
             raise error.Abort(
                 _(
                     b"can't commit in %s phase"
                     b" conflicting %s from subrepository %s"
                 )
                 % (
                     phases.phasenames[commitphase],
                     phases.phasenames[maxphase],
                     maxsub,
                 )
             )
         ui.warn(
             _(
                 b"warning: changes are committed in"
                 b" %s phase from subrepository %s\n"
             )
             % (phases.phasenames[maxphase], maxsub)
         )
         return maxphase
     return commitphase

mercurial/ui.py

@@ -1,2346 +1,2347 b''
 # ui.py - user interface bits for mercurial
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import collections
 import contextlib
 import datetime
 import errno
 import inspect
 import os
 import re
 import signal
 import socket
 import subprocess
 import sys
 import traceback
+import typing
 
 from typing import (
     Any,
     Callable,
     Dict,
     List,
     NoReturn,
     Optional,
     Tuple,
     Type,
     TypeVar,
     Union,
     cast,
     overload,
 )
 
 from .i18n import _
 from .node import hex
 from .pycompat import (
     open,
 )
 
 from . import (
     color,
     config,
     configitems,
     encoding,
     error,
     extensions,
     formatter,
     loggingutil,
     progress,
     pycompat,
     rcutil,
     scmutil,
     util,
 )
 from .utils import (
     dateutil,
     procutil,
     resourceutil,
     stringutil,
     urlutil,
 )
 
 _ConfigItems = Dict[Tuple[bytes, bytes], object]  # {(section, name) : value}
 # The **opts args of the various write() methods can be basically anything, but
 # there's no way to express it as "anything but str".  So type it to be the
 # handful of known types that are used.
 _MsgOpts = Union[bytes, bool, List["_PromptChoice"]]
 _PromptChoice = Tuple[bytes, bytes]
 _Tui = TypeVar('_Tui', bound="ui")
 
 urlreq = util.urlreq
 
 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
 _keepalnum: bytes = b''.join(
     c for c in map(pycompat.bytechr, range(256)) if not c.isalnum()
 )
 
 # The config knobs that will be altered (if unset) by ui.tweakdefaults.
 tweakrc: bytes = b"""
 [ui]
 # The rollback command is dangerous. As a rule, don't use it.
 rollback = False
 # Make `hg status` report copy information
 statuscopies = yes
 # Prefer curses UIs when available. Revert to plain-text with `text`.
 interface = curses
 # Make compatible commands emit cwd-relative paths by default.
 relative-paths = yes
 
 [commands]
 # Grep working directory by default.
 grep.all-files = True
 # Refuse to perform an `hg update` that would cause a file content merge
 update.check = noconflict
 # Show conflicts information in `hg status`
 status.verbose = True
 # Make `hg resolve` with no action (like `-m`) fail instead of re-merging.
 resolve.explicit-re-merge = True
 
 [diff]
 git = 1
 showfunc = 1
 word-diff = 1
 """
 
 samplehgrcs: Dict[bytes, bytes] = {
     b'user': b"""# example user config (see 'hg help config' for more info)
 [ui]
 # name and email, e.g.
 # username = Jane Doe <[e-mail]>
 username =
 
 # We recommend enabling tweakdefaults to get slight improvements to
 # the UI over time. Make sure to set HGPLAIN in the environment when
 # writing scripts!
 # tweakdefaults = True
 
 # uncomment to disable color in command output
 # (see 'hg help color' for details)
 # color = never
 
 # uncomment to disable command output pagination
 # (see 'hg help pager' for details)
 # paginate = never
 
 [extensions]
 # uncomment the lines below to enable some popular extensions
 # (see 'hg help extensions' for more info)
 #
 # histedit =
 # rebase =
 # uncommit =
 """,
     b'cloned': b"""# example repository config (see 'hg help config' for more info)
 [paths]
 default = %s
 
 # path aliases to other clones of this repo in URLs or filesystem paths
 # (see 'hg help config.paths' for more info)
 #
 # default:pushurl = ssh://[e-mail]/hg/jdoes-fork
 # my-fork         = ssh://[e-mail]/hg/jdoes-fork
 # my-clone        = /home/jdoe/jdoes-clone
 
 [ui]
 # name and email (local to this repository, optional), e.g.
 # username = Jane Doe <[e-mail]>
 """,
     b'local': b"""# example repository config (see 'hg help config' for more info)
 [paths]
 # path aliases to other clones of this repo in URLs or filesystem paths
 # (see 'hg help config.paths' for more info)
 #
 # default         = http://example.com/hg/example-repo
 # default:pushurl = ssh://[e-mail]/hg/jdoes-fork
 # my-fork         = ssh://[e-mail]/hg/jdoes-fork
 # my-clone        = /home/jdoe/jdoes-clone
 
 [ui]
 # name and email (local to this repository, optional), e.g.
 # username = Jane Doe <[e-mail]>
 """,
     b'global': b"""# example system-wide hg config (see 'hg help config' for more info)
 
 [ui]
 # uncomment to disable color in command output
 # (see 'hg help color' for details)
 # color = never
 
 # uncomment to disable command output pagination
 # (see 'hg help pager' for details)
 # paginate = never
 
 [extensions]
 # uncomment the lines below to enable some popular extensions
 # (see 'hg help extensions' for more info)
 #
 # blackbox =
 # churn =
 """,
 }
 
 
 def _maybestrurl(maybebytes):
     return pycompat.rapply(pycompat.strurl, maybebytes)
 
 
 def _maybebytesurl(maybestr):
     return pycompat.rapply(pycompat.bytesurl, maybestr)
 
 
 class httppasswordmgrdbproxy:
     """Delays loading urllib2 until it's needed."""
 
     def __init__(self) -> None:
         self._mgr = None
 
     def _get_mgr(self):
         if self._mgr is None:
             self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
         return self._mgr
 
     def add_password(self, realm, uris, user, passwd):
         return self._get_mgr().add_password(
             _maybestrurl(realm),
             _maybestrurl(uris),
             _maybestrurl(user),
             _maybestrurl(passwd),
         )
 
     def find_user_password(self, realm, uri):
         mgr = self._get_mgr()
         return _maybebytesurl(
             mgr.find_user_password(_maybestrurl(realm), _maybestrurl(uri))
         )
 
 
 def _catchterm(*args) -> NoReturn:
     raise error.SignalInterrupt
 
 
 # unique object used to detect no default value has been provided when
 # retrieving configuration value.
 _unset = object()
 
 # _reqexithandlers: callbacks run at the end of a request
 _reqexithandlers: List = []
 
 
 class ui:
     def __init__(self, src: Optional["ui"] = None) -> None:
         """Create a fresh new ui object if no src given
 
         Use uimod.ui.load() to create a ui which knows global and user configs.
         In most cases, you should use ui.copy() to create a copy of an existing
         ui object.
         """
         # _buffers: used for temporary capture of output
         self._buffers = []
         # 3-tuple describing how each buffer in the stack behaves.
         # Values are (capture stderr, capture subprocesses, apply labels).
         self._bufferstates = []
         # When a buffer is active, defines whether we are expanding labels.
         # This exists to prevent an extra list lookup.
         self._bufferapplylabels = None
         self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
         self._reportuntrusted = True
         self._knownconfig = configitems.coreitems
         self._ocfg = config.config()  # overlay
         self._tcfg = config.config()  # trusted
         self._ucfg = config.config()  # untrusted
         self._trustusers = set()
         self._trustgroups = set()
         self.callhooks = True
         # hold the root to use for each [paths] entry
         self._path_to_root = {}
         # Insecure server connections requested.
         self.insecureconnections = False
         # Blocked time
         self.logblockedtimes = False
         # color mode: see mercurial/color.py for possible value
         self._colormode = None
         self._terminfoparams = {}
         self._styles = {}
         self._uninterruptible = False
         self.showtimestamp = False
 
         if src:
             self._fout = src._fout
             self._ferr = src._ferr
             self._fin = src._fin
             self._fmsg = src._fmsg
             self._fmsgout = src._fmsgout
             self._fmsgerr = src._fmsgerr
             self._finoutredirected = src._finoutredirected
             self._loggers = src._loggers.copy()
             self.pageractive = src.pageractive
             self._disablepager = src._disablepager
             self._tweaked = src._tweaked
 
             self._tcfg = src._tcfg.copy()
             self._ucfg = src._ucfg.copy()
             self._ocfg = src._ocfg.copy()
             self._trustusers = src._trustusers.copy()
             self._trustgroups = src._trustgroups.copy()
             self.environ = src.environ
             self.callhooks = src.callhooks
             self._path_to_root = src._path_to_root
             self.insecureconnections = src.insecureconnections
             self._colormode = src._colormode
             self._terminfoparams = src._terminfoparams.copy()
             self._styles = src._styles.copy()
 
             self.fixconfig()
 
             self.httppasswordmgrdb = src.httppasswordmgrdb
             self._blockedtimes = src._blockedtimes
         else:
             self._fout = procutil.stdout
             self._ferr = procutil.stderr
             self._fin = procutil.stdin
             self._fmsg = None
             self._fmsgout = self.fout  # configurable
             self._fmsgerr = self.ferr  # configurable
             self._finoutredirected = False
             self._loggers = {}
             self.pageractive = False
             self._disablepager = False
             self._tweaked = False
 
             # shared read-only environment
             self.environ = encoding.environ
 
             self.httppasswordmgrdb = httppasswordmgrdbproxy()
             self._blockedtimes = collections.defaultdict(int)
 
         allowed = self.configlist(b'experimental', b'exportableenviron')
         if b'*' in allowed:
             self._exportableenviron = self.environ
         else:
             self._exportableenviron = {}
             for k in allowed:
                 if k in self.environ:
                     self._exportableenviron[k] = self.environ[k]
 
     def _new_source(self) -> None:
         self._ocfg.new_source()
         self._tcfg.new_source()
         self._ucfg.new_source()
 
     @classmethod
     def load(cls: Type[_Tui]) -> _Tui:
         """Create a ui and load global and user configs"""
         u = cls()
         # we always trust global config files and environment variables
         for t, f in rcutil.rccomponents():
             if t == b'path':
                 u.readconfig(f, trust=True)
             elif t == b'resource':
                 u.read_resource_config(f, trust=True)
             elif t == b'items':
                 u._new_source()
                 sections = set()
                 for section, name, value, source in f:
                     # do not set u._ocfg
                     # XXX clean this up once immutable config object is a thing
                     u._tcfg.set(section, name, value, source)
                     u._ucfg.set(section, name, value, source)
                     sections.add(section)
                 for section in sections:
                     u.fixconfig(section=section)
             else:
                 raise error.ProgrammingError(b'unknown rctype: %s' % t)
         u._maybetweakdefaults()
         u._new_source()  # anything after that is a different level
         return u
 
     def _maybetweakdefaults(self) -> None:
         if not self.configbool(b'ui', b'tweakdefaults'):
             return
         if self._tweaked or self.plain(b'tweakdefaults'):
             return
 
         # Note: it is SUPER IMPORTANT that you set self._tweaked to
         # True *before* any calls to setconfig(), otherwise you'll get
         # infinite recursion between setconfig and this method.
         #
         # TODO: We should extract an inner method in setconfig() to
         # avoid this weirdness.
         self._tweaked = True
         tmpcfg = config.config()
         tmpcfg.parse(b'<tweakdefaults>', tweakrc)
         for section in tmpcfg:
             for name, value in tmpcfg.items(section):
                 if not self.hasconfig(section, name):
                     self.setconfig(section, name, value, b"<tweakdefaults>")
 
     def copy(self: _Tui) -> _Tui:
         return self.__class__(self)
 
     def resetstate(self) -> None:
         """Clear internal state that shouldn't persist across commands"""
         if self._progbar:
             self._progbar.resetstate()  # reset last-print time of progress bar
         self.httppasswordmgrdb = httppasswordmgrdbproxy()
 
     @contextlib.contextmanager
     def timeblockedsection(self, key: bytes):
         # this is open-coded below - search for timeblockedsection to find them
         starttime = util.timer()
         try:
             yield
         finally:
             self._blockedtimes[key + b'_blocked'] += (
                 util.timer() - starttime
             ) * 1000
 
     @contextlib.contextmanager
     def uninterruptible(self):
         """Mark an operation as unsafe.
 
         Most operations on a repository are safe to interrupt, but a
         few are risky (for example repair.strip). This context manager
         lets you advise Mercurial that something risky is happening so
         that control-C etc can be blocked if desired.
         """
         enabled = self.configbool(b'experimental', b'nointerrupt')
         if enabled and self.configbool(
             b'experimental', b'nointerrupt-interactiveonly'
         ):
             enabled = self.interactive()
         if self._uninterruptible or not enabled:
             # if nointerrupt support is turned off, the process isn't
             # interactive, or we're already in an uninterruptible
             # block, do nothing.
             yield
             return
 
         def warn():
             self.warn(_(b"shutting down cleanly\n"))
             self.warn(
                 _(b"press ^C again to terminate immediately (dangerous)\n")
             )
             return True
 
         with procutil.uninterruptible(warn):
             try:
                 self._uninterruptible = True
                 yield
             finally:
                 self._uninterruptible = False
 
     def formatter(self, topic: bytes, opts):
         return formatter.formatter(self, self, topic, opts)
 
     def _trusted(self, fp, f: bytes) -> bool:
         st = util.fstat(fp)
         if util.isowner(st):
             return True
 
         tusers, tgroups = self._trustusers, self._trustgroups
         if b'*' in tusers or b'*' in tgroups:
             return True
 
         user = util.username(st.st_uid)
         group = util.groupname(st.st_gid)
         if user in tusers or group in tgroups or user == util.username():
             return True
 
         if self._reportuntrusted:
             self.warn(
                 _(
                     b'not trusting file %s from untrusted '
                     b'user %s, group %s\n'
                 )
                 % (f, user, group)
             )
         return False
 
     def read_resource_config(
         self, name, root=None, trust=False, sections=None, remap=None
     ) -> None:
         try:
             fp = resourceutil.open_resource(name[0], name[1])
         except IOError:
             if not sections:  # ignore unless we were looking for something
                 return
             raise
 
         self._readconfig(
             b'resource:%s.%s' % name, fp, root, trust, sections, remap
         )
 
     def readconfig(
         self, filename, root=None, trust=False, sections=None, remap=None
     ) -> None:
         try:
             fp = open(filename, 'rb')
         except IOError:
             if not sections:  # ignore unless we were looking for something
                 return
             raise
 
         self._readconfig(filename, fp, root, trust, sections, remap)
 
     def _readconfig(
         self, filename, fp, root=None, trust=False, sections=None, remap=None
     ) -> None:
         with fp:
             cfg = config.config()
             trusted = sections or trust or self._trusted(fp, filename)
 
             try:
                 cfg.read(filename, fp, sections=sections, remap=remap)
             except error.ConfigError as inst:
                 if trusted:
                     raise
                 self.warn(
                     _(b'ignored %s: %s\n') % (inst.location, inst.message)
                 )
 
         self._applyconfig(cfg, trusted, root)
 
     def applyconfig(
         self, configitems: _ConfigItems, source=b"", root=None
     ) -> None:
         """Add configitems from a non-file source.  Unlike with ``setconfig()``,
         they can be overridden by subsequent config file reads.  The items are
         in the same format as ``configoverride()``, namely a dict of the
         following structures: {(section, name) : value}
 
         Typically this is used by extensions that inject themselves into the
         config file load procedure by monkeypatching ``localrepo.loadhgrc()``.
         """
         cfg = config.config()
 
         for (section, name), value in configitems.items():
             cfg.set(section, name, value, source)
 
         self._applyconfig(cfg, True, root)
 
     def _applyconfig(self, cfg, trusted, root) -> None:
         if self.plain():
             for k in (
                 b'debug',
                 b'fallbackencoding',
                 b'quiet',
                 b'slash',
                 b'logtemplate',
                 b'message-output',
                 b'statuscopies',
                 b'style',
                 b'traceback',
                 b'verbose',
             ):
                 if k in cfg[b'ui']:
                     del cfg[b'ui'][k]
             for k, v in cfg.items(b'defaults'):
                 del cfg[b'defaults'][k]
             for k, v in cfg.items(b'commands'):
                 del cfg[b'commands'][k]
             for k, v in cfg.items(b'command-templates'):
                 del cfg[b'command-templates'][k]
         # Don't remove aliases from the configuration if in the exceptionlist
         if self.plain(b'alias'):
             for k, v in cfg.items(b'alias'):
                 del cfg[b'alias'][k]
         if self.plain(b'revsetalias'):
             for k, v in cfg.items(b'revsetalias'):
                 del cfg[b'revsetalias'][k]
         if self.plain(b'templatealias'):
             for k, v in cfg.items(b'templatealias'):
                 del cfg[b'templatealias'][k]
 
         if trusted:
             self._tcfg.update(cfg)
             self._tcfg.update(self._ocfg)
         self._ucfg.update(cfg)
         self._ucfg.update(self._ocfg)
 
         if root is None:
             root = os.path.expanduser(b'~')
         self.fixconfig(root=root)
 
     def fixconfig(self, root=None, section=None) -> None:
         if section in (None, b'paths'):
             # expand vars and ~
             # translate paths relative to root (or home) into absolute paths
             root = root or encoding.getcwd()
             for c in self._tcfg, self._ucfg, self._ocfg:
                 for n, p in c.items(b'paths'):
                     old_p = p
                     s = self.configsource(b'paths', n) or b'none'
                     root_key = (n, p, s)
                     if root_key not in self._path_to_root:
                         self._path_to_root[root_key] = root
                     # Ignore sub-options.
                     if b':' in n:
                         continue
                     if not p:
                         continue
                     if b'%%' in p:
                         if s is None:
                             s = 'none'
                         self.warn(
                             _(b"(deprecated '%%' in path %s=%s from %s)\n")
                             % (n, p, s)
                         )
                         p = p.replace(b'%%', b'%')
                     if p != old_p:
                         c.alter(b"paths", n, p)
 
         if section in (None, b'ui'):
             # update ui options
             self._fmsgout, self._fmsgerr = _selectmsgdests(self)
             self.debugflag = self.configbool(b'ui', b'debug')
             self.verbose = self.debugflag or self.configbool(b'ui', b'verbose')
             self.quiet = not self.debugflag and self.configbool(b'ui', b'quiet')
             if self.verbose and self.quiet:
                 self.quiet = self.verbose = False
             self._reportuntrusted = self.debugflag or self.configbool(
                 b"ui", b"report_untrusted"
             )
             self.showtimestamp = self.configbool(b'ui', b'timestamp-output')
             self.tracebackflag = self.configbool(b'ui', b'traceback')
             self.logblockedtimes = self.configbool(b'ui', b'logblockedtimes')
 
         if section in (None, b'trusted'):
             # update trust information
             self._trustusers.update(self.configlist(b'trusted', b'users'))
             self._trustgroups.update(self.configlist(b'trusted', b'groups'))
 
         if section in (None, b'devel', b'ui') and self.debugflag:
             tracked = set()
             if self.configbool(b'devel', b'debug.extensions'):
                 tracked.add(b'extension')
             if tracked:
                 logger = loggingutil.fileobjectlogger(self._ferr, tracked)
                 self.setlogger(b'debug', logger)
 
     def backupconfig(self, section, item):
         return (
             self._ocfg.backup(section, item),
             self._tcfg.backup(section, item),
             self._ucfg.backup(section, item),
         )
 
     def restoreconfig(self, data) -> None:
         self._ocfg.restore(data[0])
         self._tcfg.restore(data[1])
         self._ucfg.restore(data[2])
 
     def setconfig(self, section, name, value, source=b'') -> None:
         for cfg in (self._ocfg, self._tcfg, self._ucfg):
             cfg.set(section, name, value, source)
         self.fixconfig(section=section)
         self._maybetweakdefaults()
 
     def _data(self, untrusted):
         return untrusted and self._ucfg or self._tcfg
 
     def configsource(self, section, name, untrusted=False):
         return self._data(untrusted).source(section, name)
 
     def config(self, section, name, default=_unset, untrusted=False):
         """return the plain string version of a config"""
         value = self._config(
             section, name, default=default, untrusted=untrusted
         )
         if value is _unset:
             return None
         return value
 
     def _config(self, section, name, default=_unset, untrusted=False):
         value = itemdefault = default
         item = self._knownconfig.get(section, {}).get(name)
         alternates = [(section, name)]
 
         if item is not None and item.in_core_extension is not None:
             # Only return the default for an in-core extension item if said
             # extension is enabled
             if item.in_core_extension in extensions.extensions(self):
                 item = None
 
         if item is not None:
             alternates.extend(item.alias)
             if callable(item.default):
                 itemdefault = item.default()
             else:
                 itemdefault = item.default
         else:
             msg = b"accessing unregistered config item: '%s.%s'"
             msg %= (section, name)
             self.develwarn(msg, 2, b'warn-config-unknown')
 
         if default is _unset:
             if item is None:
                 value = default
             elif item.default is configitems.dynamicdefault:
                 value = None
                 msg = b"config item requires an explicit default value: '%s.%s'"
                 msg %= (section, name)
                 self.develwarn(msg, 2, b'warn-config-default')
             else:
                 value = itemdefault
         elif (
             item is not None
             and item.default is not configitems.dynamicdefault
             and default != itemdefault
         ):
             msg = (
                 b"specifying a mismatched default value for a registered "
                 b"config item: '%s.%s' '%s'"
             )
             msg %= (section, name, pycompat.bytestr(default))
             self.develwarn(msg, 2, b'warn-config-default')
 
         candidates = []
         config = self._data(untrusted)
         for s, n in alternates:
             candidate = config.get(s, n, None)
             if candidate is not None:
                 candidates.append((s, n, candidate))
         if candidates:
 
             def level(x):
                 return config.level(x[0], x[1])
 
             value = max(candidates, key=level)[2]
 
         if self.debugflag and not untrusted and self._reportuntrusted:
             for s, n in alternates:
                 uvalue = self._ucfg.get(s, n)
                 if uvalue is not None and uvalue != value:
                     self.debug(
                         b"ignoring untrusted configuration option "
                         b"%s.%s = %s\n" % (s, n, uvalue)
                     )
         return value
 
     def config_default(self, section, name):
         """return the default value for a config option
 
         The default is returned "raw", for example if it is a callable, the
         callable was not called.
         """
         item = self._knownconfig.get(section, {}).get(name)
 
         if item is None:
             raise KeyError((section, name))
         return item.default
 
     def configsuboptions(self, section, name, default=_unset, untrusted=False):
         """Get a config option and all sub-options.
 
         Some config options have sub-options that are declared with the
         format "key:opt = value". This method is used to return the main
         option and all its declared sub-options.
 
         Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
         is a dict of defined sub-options where keys and values are strings.
         """
         main = self.config(section, name, default, untrusted=untrusted)
         data = self._data(untrusted)
         sub = {}
         prefix = b'%s:' % name
         for k, v in data.items(section):
             if k.startswith(prefix):
                 sub[k[len(prefix) :]] = v
 
         if self.debugflag and not untrusted and self._reportuntrusted:
             for k, v in sub.items():
                 uvalue = self._ucfg.get(section, b'%s:%s' % (name, k))
                 if uvalue is not None and uvalue != v:
                     self.debug(
                         b'ignoring untrusted configuration option '
                         b'%s:%s.%s = %s\n' % (section, name, k, uvalue)
                     )
 
         return main, sub
 
     def configpath(self, section, name, default=_unset, untrusted=False):
         """get a path config item, expanded relative to repo root or config
         file"""
         v = self.config(section, name, default, untrusted)
         if v is None:
             return None
         if not os.path.isabs(v) or b"://" not in v:
             src = self.configsource(section, name, untrusted)
             if b':' in src:
                 base = os.path.dirname(src.rsplit(b':')[0])
                 v = os.path.join(base, os.path.expanduser(v))
         return v
 
     def configbool(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a boolean
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'true', b'yes')
         >>> u.configbool(s, b'true')
         True
         >>> u.setconfig(s, b'false', b'no')
         >>> u.configbool(s, b'false')
         False
         >>> u.configbool(s, b'unknown')
         False
         >>> u.configbool(s, b'unknown', True)
         True
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configbool(s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a boolean ('somevalue')
         """
 
         v = self._config(section, name, default, untrusted=untrusted)
         if v is None:
             return v
         if v is _unset:
             if default is _unset:
                 return False
             return default
         if isinstance(v, bool):
             return v
         b = stringutil.parsebool(v)
         if b is None:
             raise error.ConfigError(
                 _(b"%s.%s is not a boolean ('%s')") % (section, name, v)
             )
         return b
 
     def configwith(
         self, convert, section, name, default=_unset, desc=None, untrusted=False
     ):
         """parse a configuration element with a conversion function
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'float1', b'42')
         >>> u.configwith(float, s, b'float1')
         42.0
         >>> u.setconfig(s, b'float2', b'-4.25')
         >>> u.configwith(float, s, b'float2')
         -4.25
         >>> u.configwith(float, s, b'unknown', 7)
         7.0
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configwith(float, s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a valid float ('somevalue')
         >>> u.configwith(float, s, b'invalid', desc=b'womble')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a valid womble ('somevalue')
         """
 
         v = self.config(section, name, default, untrusted)
         if v is None:
             return v  # do not attempt to convert None
         try:
             return convert(v)
         except (ValueError, error.ParseError):
             if desc is None:
                 desc = pycompat.sysbytes(convert.__name__)
             raise error.ConfigError(
                 _(b"%s.%s is not a valid %s ('%s')") % (section, name, desc, v)
             )
 
     def configint(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as an integer
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'int1', b'42')
         >>> u.configint(s, b'int1')
         42
         >>> u.setconfig(s, b'int2', b'-42')
         >>> u.configint(s, b'int2')
         -42
         >>> u.configint(s, b'unknown', 7)
         7
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configint(s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a valid integer ('somevalue')
         """
 
         return self.configwith(
             int, section, name, default, b'integer', untrusted
         )
 
     def configbytes(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a quantity in bytes
 
         Units can be specified as b (bytes), k or kb (kilobytes), m or
         mb (megabytes), g or gb (gigabytes).
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'val1', b'42')
         >>> u.configbytes(s, b'val1')
         42
         >>> u.setconfig(s, b'val2', b'42.5 kb')
         >>> u.configbytes(s, b'val2')
         43520
         >>> u.configbytes(s, b'unknown', b'7 MB')
         7340032
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configbytes(s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a byte quantity ('somevalue')
         """
 
         value = self._config(section, name, default, untrusted)
         if value is _unset:
             if default is _unset:
                 default = 0
             value = default
         if not isinstance(value, bytes):
             return value
         try:
             return util.sizetoint(value)
         except error.ParseError:
             raise error.ConfigError(
                 _(b"%s.%s is not a byte quantity ('%s')")
                 % (section, name, value)
             )
 
     def configlist(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a list of comma/space separated
         strings
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'list1', b'this,is "a small" ,test')
         >>> u.configlist(s, b'list1')
         ['this', 'is', 'a small', 'test']
         >>> u.setconfig(s, b'list2', b'this, is "a small" , test ')
         >>> u.configlist(s, b'list2')
         ['this', 'is', 'a small', 'test']
         """
         # default is not always a list
         v = self.configwith(
             stringutil.parselist, section, name, default, b'list', untrusted
         )
         if isinstance(v, bytes):
             return stringutil.parselist(v)
         elif v is None:
             return []
         return v
 
     def configdate(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a tuple of ints
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'date', b'0 0')
         >>> u.configdate(s, b'date')
         (0, 0)
         """
         if self.config(section, name, default, untrusted):
             return self.configwith(
                 dateutil.parsedate, section, name, default, b'date', untrusted
             )
         if default is _unset:
             return None
         return default
 
     def configdefault(self, section, name):
         """returns the default value of the config item"""
         item = self._knownconfig.get(section, {}).get(name)
         itemdefault = None
         if item is not None:
             if callable(item.default):
                 itemdefault = item.default()
             else:
                 itemdefault = item.default
         return itemdefault
 
     def hasconfig(self, section, name, untrusted=False):
         return self._data(untrusted).hasitem(section, name)
 
     def has_section(self, section, untrusted=False):
         '''tell whether section exists in config.'''
         return section in self._data(untrusted)
 
     def configitems(self, section, untrusted=False, ignoresub=False):
         items = self._data(untrusted).items(section)
         if ignoresub:
             items = [i for i in items if b':' not in i[0]]
         if self.debugflag and not untrusted and self._reportuntrusted:
             for k, v in self._ucfg.items(section):
                 if self._tcfg.get(section, k) != v:
                     self.debug(
                         b"ignoring untrusted configuration option "
                         b"%s.%s = %s\n" % (section, k, v)
                     )
         return items
 
     def walkconfig(self, untrusted=False, all_known=False):
         defined = self._walk_config(untrusted)
         if not all_known:
             for d in defined:
                 yield d
             return
         known = self._walk_known()
         current_defined = next(defined, None)
         current_known = next(known, None)
         while current_defined is not None or current_known is not None:
             if current_defined is None:
                 yield current_known
                 current_known = next(known, None)
             elif current_known is None:
                 yield current_defined
                 current_defined = next(defined, None)
             elif current_known[0:2] == current_defined[0:2]:
                 yield current_defined
                 current_defined = next(defined, None)
                 current_known = next(known, None)
             elif current_known[0:2] < current_defined[0:2]:
                 yield current_known
                 current_known = next(known, None)
             else:
                 yield current_defined
                 current_defined = next(defined, None)
 
     def _walk_known(self):
         for section, items in sorted(self._knownconfig.items()):
             for k, i in sorted(items.items()):
                 # We don't have a way to display generic well, so skip them
                 if i.generic:
                     continue
                 if callable(i.default):
                     default = i.default()
                 elif i.default is configitems.dynamicdefault:
                     default = b'<DYNAMIC>'
                 else:
                     default = i.default
                 yield section, i.name, default
 
     def _walk_config(self, untrusted):
         cfg = self._data(untrusted)
         for section in cfg.sections():
             for name, value in self.configitems(section, untrusted):
                 yield section, name, value
 
     def plain(self, feature: Optional[bytes] = None) -> bool:
         """is plain mode active?
 
         Plain mode means that all configuration variables which affect
         the behavior and output of Mercurial should be
         ignored. Additionally, the output should be stable,
         reproducible and suitable for use in scripts or applications.
 
         The only way to trigger plain mode is by setting either the
         `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
 
         The return value can either be
         - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
         - False if feature is disabled by default and not included in HGPLAIN
         - True otherwise
         """
         if (
             b'HGPLAIN' not in encoding.environ
             and b'HGPLAINEXCEPT' not in encoding.environ
         ):
             return False
         exceptions = (
             encoding.environ.get(b'HGPLAINEXCEPT', b'').strip().split(b',')
         )
         # TODO: add support for HGPLAIN=+feature,-feature syntax
         if b'+strictflags' not in encoding.environ.get(b'HGPLAIN', b'').split(
             b','
         ):
             exceptions.append(b'strictflags')
         if feature and exceptions:
             return feature not in exceptions
         return True
 
     def username(self, acceptempty=False):
         """Return default username to be used in commits.
 
         Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
         and stop searching if one of these is set.
         If not found and acceptempty is True, returns None.
         If not found and ui.askusername is True, ask the user, else use
         ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
         If no username could be found, raise an Abort error.
         """
         user = encoding.environ.get(b"HGUSER")
         if user is None:
             user = self.config(b"ui", b"username")
             if user is not None:
                 user = os.path.expandvars(user)
         if user is None:
             user = encoding.environ.get(b"EMAIL")
         if user is None and acceptempty:
             return user
         if user is None and self.configbool(b"ui", b"askusername"):
             user = self.prompt(_(b"enter a commit username:"), default=None)
         if user is None and not self.interactive():
             try:
                 user = b'%s@%s' % (
                     procutil.getuser(),
                     encoding.strtolocal(socket.getfqdn()),
                 )
                 self.warn(_(b"no username found, using '%s' instead\n") % user)
             except KeyError:
                 pass
         if not user:
             raise error.Abort(
                 _(b'no username supplied'),
                 hint=_(b"use 'hg config --edit' " b'to set your username'),
             )
         if b"\n" in user:
             raise error.Abort(
                 _(b"username %r contains a newline\n") % pycompat.bytestr(user)
             )
         return user
 
     def shortuser(self, user: bytes) -> bytes:
         """Return a short representation of a user name or email address."""
         if not self.verbose:
             user = stringutil.shortuser(user)
         return user
 
     @util.propertycache
     def paths(self):
         return urlutil.paths(self)
 
     @property
     def fout(self):
         return self._fout
 
     @util.propertycache
     def _fout_is_a_tty(self):
         self._isatty(self._fout)
 
     @fout.setter
     def fout(self, f):
         self._fout = f
         self._fmsgout, self._fmsgerr = _selectmsgdests(self)
         if '_fout_is_a_tty' in vars(self):
             del self._fout_is_a_tty
 
     @property
     def ferr(self):
         return self._ferr
 
     @ferr.setter
     def ferr(self, f):
         self._ferr = f
         self._fmsgout, self._fmsgerr = _selectmsgdests(self)
 
     @property
     def fin(self):
         return self._fin
 
     @fin.setter
     def fin(self, f):
         self._fin = f
 
     @property
     def fmsg(self):
         """Stream dedicated for status/error messages; may be None if
         fout/ferr are used"""
         return self._fmsg
 
     @fmsg.setter
     def fmsg(self, f):
         self._fmsg = f
         self._fmsgout, self._fmsgerr = _selectmsgdests(self)
 
     @contextlib.contextmanager
     def silent(
         self, error: bool = False, subproc: bool = False, labeled: bool = False
     ):
         self.pushbuffer(error=error, subproc=subproc, labeled=labeled)
         try:
             yield
         finally:
             self.popbuffer()
 
     def pushbuffer(
         self, error: bool = False, subproc: bool = False, labeled: bool = False
     ) -> None:
         """install a buffer to capture standard output of the ui object
 
         If error is True, the error output will be captured too.
 
         If subproc is True, output from subprocesses (typically hooks) will be
         captured too.
 
         If labeled is True, any labels associated with buffered
         output will be handled. By default, this has no effect
         on the output returned, but extensions and GUI tools may
         handle this argument and returned styled output. If output
         is being buffered so it can be captured and parsed or
         processed, labeled should not be set to True.
         """
         self._buffers.append([])
         self._bufferstates.append((error, subproc, labeled))
         self._bufferapplylabels = labeled
 
     def popbuffer(self) -> bytes:
         '''pop the last buffer and return the buffered output'''
         self._bufferstates.pop()
         if self._bufferstates:
             self._bufferapplylabels = self._bufferstates[-1][2]
         else:
             self._bufferapplylabels = None
 
         return b"".join(self._buffers.pop())
 
     def _isbuffered(self, dest) -> bool:
         if dest is self._fout:
             return bool(self._buffers)
         if dest is self._ferr:
             return bool(self._bufferstates and self._bufferstates[-1][0])
         return False
 
     def canwritewithoutlabels(self) -> bool:
         '''check if write skips the label'''
         if self._buffers and not self._bufferapplylabels:
             return True
         return self._colormode is None
 
     def canbatchlabeledwrites(self) -> bool:
         '''check if write calls with labels are batchable'''
         # Windows color printing is special, see ``write``.
         return self._colormode != b'win32'
 
     def write(self, *args: bytes, **opts: _MsgOpts) -> None:
         """write args to output
 
         By default, this method simply writes to the buffer or stdout.
         Color mode can be set on the UI class to have the output decorated
         with color modifier before being written to stdout.
 
         The color used is controlled by an optional keyword argument, "label".
         This should be a string containing label names separated by space.
         Label names take the form of "topic.type". For example, ui.debug()
         issues a label of "ui.debug".
 
         Progress reports via stderr are normally cleared before writing as
         stdout and stderr go to the same terminal. This can be skipped with
         the optional keyword argument "keepprogressbar". The progress bar
         will continue to occupy a partial line on stderr in that case.
         This functionality is intended when Mercurial acts as data source
         in a pipe.
 
         When labeling output for a specific command, a label of
         "cmdname.type" is recommended. For example, status issues
         a label of "status.modified" for modified files.
         """
         dest = self._fout
 
         # inlined _write() for speed
         if self._buffers:
             label = opts.get('label', b'')
             if label and self._bufferapplylabels:
                 self._buffers[-1].extend(self.label(a, label) for a in args)
             else:
                 self._buffers[-1].extend(args)
             return
 
         # inlined _writenobuf() for speed
         if not opts.get('keepprogressbar', self._fout_is_a_tty):
             self._progclear()
         msg = b''.join(args)
 
         # opencode timeblockedsection because this is a critical path
         starttime = util.timer()
         try:
             if self._colormode == b'win32':
                 # windows color printing is its own can of crab, defer to
                 # the color module and that is it.
                 color.win32print(self, dest.write, msg, **opts)
             else:
                 if self._colormode is not None:
                     label = opts.get('label', b'')
                     msg = self.label(msg, label)
                 dest.write(msg)
         except IOError as err:
             raise error.StdioError(err)
         finally:
             self._blockedtimes[b'stdio_blocked'] += (
                 util.timer() - starttime
             ) * 1000
 
     def write_err(self, *args: bytes, **opts: _MsgOpts) -> None:
         self._write(self._ferr, *args, **opts)
 
     def _write(self, dest, *args: bytes, **opts: _MsgOpts) -> None:
         # update write() as well if you touch this code
         if self._isbuffered(dest):
             label = opts.get('label', b'')
             if label and self._bufferapplylabels:
                 self._buffers[-1].extend(self.label(a, label) for a in args)
             else:
                 self._buffers[-1].extend(args)
         else:
             self._writenobuf(dest, *args, **opts)
 
     def _writenobuf(self, dest, *args: bytes, **opts: _MsgOpts) -> None:
         # update write() as well if you touch this code
         if not opts.get('keepprogressbar', self._fout_is_a_tty):
             self._progclear()
         msg = b''.join(args)
 
         # opencode timeblockedsection because this is a critical path
         starttime = util.timer()
         try:
             if dest is self._ferr and not getattr(self._fout, 'closed', False):
                 self._fout.flush()
             if getattr(dest, 'structured', False):
                 # channel for machine-readable output with metadata, where
                 # no extra colorization is necessary.
                 dest.write(msg, **opts)
             elif self._colormode == b'win32':
                 # windows color printing is its own can of crab, defer to
                 # the color module and that is it.
                 color.win32print(self, dest.write, msg, **opts)
             else:
                 if self._colormode is not None:
                     label = opts.get('label', b'')
                     msg = self.label(msg, label)
                 dest.write(msg)
             # stderr may be buffered under win32 when redirected to files,
             # including stdout.
             if dest is self._ferr and not getattr(dest, 'closed', False):
                 dest.flush()
         except IOError as err:
             if dest is self._ferr and err.errno in (
                 errno.EPIPE,
                 errno.EIO,
                 errno.EBADF,
             ):
                 # no way to report the error, so ignore it
                 return
             raise error.StdioError(err)
         finally:
             self._blockedtimes[b'stdio_blocked'] += (
                 util.timer() - starttime
             ) * 1000
 
     def _writemsg(self, dest, *args: bytes, **opts: _MsgOpts) -> None:
         timestamp = self.showtimestamp and opts.get('type') in {
             b'debug',
             b'error',
             b'note',
             b'status',
             b'warning',
         }
         if timestamp:
             args = (
                 b'[%s] '
                 % pycompat.bytestr(datetime.datetime.now().isoformat()),
             ) + args
         _writemsgwith(self._write, dest, *args, **opts)
         if timestamp:
             dest.flush()
 
     def _writemsgnobuf(self, dest, *args: bytes, **opts: _MsgOpts) -> None:
         _writemsgwith(self._writenobuf, dest, *args, **opts)
 
     def flush(self) -> None:
         # opencode timeblockedsection because this is a critical path
         starttime = util.timer()
         try:
             try:
                 self._fout.flush()
             except IOError as err:
                 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
                     raise error.StdioError(err)
             finally:
                 try:
                     self._ferr.flush()
                 except IOError as err:
                     if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
                         raise error.StdioError(err)
         finally:
             self._blockedtimes[b'stdio_blocked'] += (
                 util.timer() - starttime
             ) * 1000
 
     def _isatty(self, fh) -> bool:
         if self.configbool(b'ui', b'nontty'):
             return False
         return procutil.isatty(fh)
 
     def protectfinout(self):
         """Duplicate ui streams and redirect original if they are stdio
 
         Returns (fin, fout) which point to the original ui fds, but may be
         copy of them. The returned streams can be considered "owned" in that
         print(), exec(), etc. never reach to them.
         """
         if self._finoutredirected:
             # if already redirected, protectstdio() would just create another
             # nullfd pair, which is equivalent to returning self._fin/_fout.
             return self._fin, self._fout
         fin, fout = procutil.protectstdio(self._fin, self._fout)
         self._finoutredirected = (fin, fout) != (self._fin, self._fout)
         return fin, fout
 
     def restorefinout(self, fin, fout):
         """Restore ui streams from possibly duplicated (fin, fout)"""
         if (fin, fout) == (self._fin, self._fout):
             return
         procutil.restorestdio(self._fin, self._fout, fin, fout)
         # protectfinout() won't create more than one duplicated streams,
         # so we can just turn the redirection flag off.
         self._finoutredirected = False
 
     @contextlib.contextmanager
     def protectedfinout(self):
         """Run code block with protected standard streams"""
         fin, fout = self.protectfinout()
         try:
             yield fin, fout
         finally:
             self.restorefinout(fin, fout)
 
     def disablepager(self) -> None:
         self._disablepager = True
 
     def pager(self, command: bytes) -> None:
         """Start a pager for subsequent command output.
 
         Commands which produce a long stream of output should call
         this function to activate the user's preferred pagination
         mechanism (which may be no pager). Calling this function
         precludes any future use of interactive functionality, such as
         prompting the user or activating curses.
 
         Args:
           command: The full, non-aliased name of the command. That is, "log"
                    not "history, "summary" not "summ", etc.
         """
         if self._disablepager or self.pageractive:
             # how pager should do is already determined
             return
 
         if not command.startswith(b'internal-always-') and (
             # explicit --pager=on (= 'internal-always-' prefix) should
             # take precedence over disabling factors below
             command in self.configlist(b'pager', b'ignore')
             or not self.configbool(b'ui', b'paginate')
             or not self.configbool(b'pager', b'attend-' + command, True)
             or encoding.environ.get(b'TERM') == b'dumb'
             # TODO: if we want to allow HGPLAINEXCEPT=pager,
             # formatted() will need some adjustment.
             or not self.formatted()
             or self.plain()
             or self._buffers
             # TODO: expose debugger-enabled on the UI object
             or b'--debugger' in pycompat.sysargv
         ):
             # We only want to paginate if the ui appears to be
             # interactive, the user didn't say HGPLAIN or
             # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
             return
 
         # py2exe doesn't appear to be able to use legacy I/O, and nothing is
         # output to the pager for paged commands.  Piping to `more` in cmd.exe
         # works, but is easy to forget.  Just disable pager for py2exe, but
         # leave it working for pyoxidizer and exewrapper builds.
         if pycompat.iswindows and getattr(sys, "frozen", None) == "console_exe":
             self.debug(b"pager is unavailable with py2exe packaging\n")
             return
 
         pagercmd = self.config(b'pager', b'pager', rcutil.fallbackpager)
         if not pagercmd:
             return
 
         pagerenv = {}
         for name, value in rcutil.defaultpagerenv().items():
             if name not in encoding.environ:
                 pagerenv[name] = value
 
         self.debug(
             b'starting pager for command %s\n' % stringutil.pprint(command)
         )
         self.flush()
 
         wasformatted = self.formatted()
         if hasattr(signal, "SIGPIPE"):
             signal.signal(signal.SIGPIPE, _catchterm)
         if self._runpager(pagercmd, pagerenv):
             self.pageractive = True
             # Preserve the formatted-ness of the UI. This is important
             # because we mess with stdout, which might confuse
             # auto-detection of things being formatted.
             self.setconfig(b'ui', b'formatted', wasformatted, b'pager')
             self.setconfig(b'ui', b'interactive', False, b'pager')
 
             # If pagermode differs from color.mode, reconfigure color now that
             # pageractive is set.
             cm = self._colormode
             if cm != self.config(b'color', b'pagermode', cm):
                 color.setup(self)
         else:
             # If the pager can't be spawned in dispatch when --pager=on is
             # given, don't try again when the command runs, to avoid a duplicate
             # warning about a missing pager command.
             self.disablepager()
 
     def _runpager(self, command: bytes, env=None) -> bool:
         """Actually start the pager and set up file descriptors.
 
         This is separate in part so that extensions (like chg) can
         override how a pager is invoked.
         """
         if command == b'cat':
             # Save ourselves some work.
             return False
         # If the command doesn't contain any of these characters, we
         # assume it's a binary and exec it directly. This means for
         # simple pager command configurations, we can degrade
         # gracefully and tell the user about their broken pager.
         shell = any(c in command for c in b"|&;<>()$`\\\"' \t\n*?[#~=%")
 
         if pycompat.iswindows and not shell:
             # Window's built-in `more` cannot be invoked with shell=False, but
             # its `more.com` can.  Hide this implementation detail from the
             # user so we can also get sane bad PAGER behavior.  MSYS has
             # `more.exe`, so do a cmd.exe style resolution of the executable to
             # determine which one to use.
             fullcmd = procutil.findexe(command)
             if not fullcmd:
                 self.warn(
                     _(b"missing pager command '%s', skipping pager\n") % command
                 )
                 return False
 
             command = fullcmd
 
         try:
             pager = subprocess.Popen(
                 procutil.tonativestr(command),
                 shell=shell,
                 bufsize=-1,
                 close_fds=procutil.closefds,
                 stdin=subprocess.PIPE,
                 stdout=procutil.stdout,
                 stderr=procutil.stderr,
                 env=procutil.tonativeenv(procutil.shellenviron(env)),
             )
         except FileNotFoundError:
             if not shell:
                 self.warn(
                     _(b"missing pager command '%s', skipping pager\n") % command
                 )
                 return False
             raise
 
         # back up original file descriptors
         if pycompat.sysplatform != b'OpenVMS':
             stdoutfd = os.dup(procutil.stdout.fileno())
             stderrfd = os.dup(procutil.stderr.fileno())
 
         os.dup2(pager.stdin.fileno(), procutil.stdout.fileno())
         if self._isatty(procutil.stderr):
             os.dup2(pager.stdin.fileno(), procutil.stderr.fileno())
 
         @self.atexit
         def killpager():
             if hasattr(signal, "SIGINT"):
                 signal.signal(signal.SIGINT, signal.SIG_IGN)
             # restore original fds, closing pager.stdin copies in the process
             if pycompat.sysplatform == b'OpenVMS':
                 pager.kill()
             os.dup2(stdoutfd, procutil.stdout.fileno())
             os.dup2(stderrfd, procutil.stderr.fileno())
             pager.stdin.close()
             pager.wait()
 
         return True
 
     @property
     def _exithandlers(self):
         return _reqexithandlers
 
     def atexit(self, func, *args, **kwargs):
         """register a function to run after dispatching a request
 
         Handlers do not stay registered across request boundaries."""
         self._exithandlers.append((func, args, kwargs))
         return func
 
     def interface(self, feature: bytes) -> bytes:
         """what interface to use for interactive console features?
 
         The interface is controlled by the value of `ui.interface` but also by
         the value of feature-specific configuration. For example:
 
         ui.interface.histedit = text
         ui.interface.chunkselector = curses
 
         Here the features are "histedit" and "chunkselector".
 
         The configuration above means that the default interfaces for commands
         is curses, the interface for histedit is text and the interface for
         selecting chunk is crecord (the best curses interface available).
 
         Consider the following example:
         ui.interface = curses
         ui.interface.histedit = text
 
         Then histedit will use the text interface and chunkselector will use
         the default curses interface (crecord at the moment).
         """
         alldefaults = frozenset([b"text", b"curses"])
 
         featureinterfaces = {
             b"chunkselector": [
                 b"text",
                 b"curses",
             ],
             b"histedit": [
                 b"text",
                 b"curses",
             ],
         }
 
         # Feature-specific interface
         if feature not in featureinterfaces.keys():
             # Programming error, not user error
             raise ValueError(b"Unknown feature requested %s" % feature)
 
         availableinterfaces = frozenset(featureinterfaces[feature])
         if alldefaults > availableinterfaces:
             # Programming error, not user error. We need a use case to
             # define the right thing to do here.
             raise ValueError(
                 b"Feature %s does not handle all default interfaces" % feature
             )
 
         if self.plain() or encoding.environ.get(b'TERM') == b'dumb':
             return b"text"
 
         # Default interface for all the features
         defaultinterface = b"text"
         i = self.config(b"ui", b"interface")
         if i in alldefaults:
             defaultinterface = cast(bytes, i)  # cast to help pytype
 
         choseninterface: bytes = defaultinterface
         f = self.config(b"ui", b"interface.%s" % feature)
         if f in availableinterfaces:
             choseninterface = cast(bytes, f)  # cast to help pytype
 
         if i is not None and defaultinterface != i:
             if f is not None:
                 self.warn(_(b"invalid value for ui.interface: %s\n") % (i,))
             else:
                 self.warn(
                     _(b"invalid value for ui.interface: %s (using %s)\n")
                     % (i, choseninterface)
                 )
         if f is not None and choseninterface != f:
             self.warn(
                 _(b"invalid value for ui.interface.%s: %s (using %s)\n")
                 % (feature, f, choseninterface)
             )
 
         return choseninterface
 
     def interactive(self):
         """is interactive input allowed?
 
         An interactive session is a session where input can be reasonably read
         from `sys.stdin'. If this function returns false, any attempt to read
         from stdin should fail with an error, unless a sensible default has been
         specified.
 
         Interactiveness is triggered by the value of the `ui.interactive'
         configuration variable or - if it is unset - when `sys.stdin' points
         to a terminal device.
 
         This function refers to input only; for output, see `ui.formatted()'.
         """
         i = self.configbool(b"ui", b"interactive")
         if i is None:
             # some environments replace stdin without implementing isatty
             # usually those are non-interactive
             return self._isatty(self._fin)
 
         return i
 
     def termwidth(self) -> int:
         """how wide is the terminal in columns?"""
         if b'COLUMNS' in encoding.environ:
             try:
                 return int(encoding.environ[b'COLUMNS'])
             except ValueError:
                 pass
         return scmutil.termsize(self)[0]
 
     def formatted(self):
         """should formatted output be used?
 
         It is often desirable to format the output to suite the output medium.
         Examples of this are truncating long lines or colorizing messages.
         However, this is not often not desirable when piping output into other
         utilities, e.g. `grep'.
 
         Formatted output is triggered by the value of the `ui.formatted'
         configuration variable or - if it is unset - when `sys.stdout' points
         to a terminal device. Please note that `ui.formatted' should be
         considered an implementation detail; it is not intended for use outside
         Mercurial or its extensions.
 
         This function refers to output only; for input, see `ui.interactive()'.
         This function always returns false when in plain mode, see `ui.plain()'.
         """
         if self.plain():
             return False
 
         i = self.configbool(b"ui", b"formatted")
         if i is None:
             # some environments replace stdout without implementing isatty
             # usually those are non-interactive
             return self._isatty(self._fout)
 
         return i
 
     def _readline(
         self,
         prompt: bytes = b' ',
         promptopts: Optional[Dict[str, _MsgOpts]] = None,
     ) -> bytes:
         # Replacing stdin/stdout temporarily is a hard problem on Python 3
         # because they have to be text streams with *no buffering*. Instead,
         # we use rawinput() only if call_readline() will be invoked by
         # PyOS_Readline(), so no I/O will be made at Python layer.
         usereadline = (
             self._isatty(self._fin)
             and self._isatty(self._fout)
             and procutil.isstdin(self._fin)
             and procutil.isstdout(self._fout)
         )
         if usereadline:
             try:
                 # magically add command line editing support, where
                 # available
                 import readline
 
                 # force demandimport to really load the module
                 readline.read_history_file
                 # windows sometimes raises something other than ImportError
             except Exception:
                 usereadline = False
 
         if self._colormode == b'win32' or not usereadline:
             if not promptopts:
                 promptopts = {}
             self._writemsgnobuf(
                 self._fmsgout, prompt, type=b'prompt', **promptopts
             )
             self.flush()
             prompt = b' '
         else:
             prompt = self.label(prompt, b'ui.prompt') + b' '
 
         # prompt ' ' must exist; otherwise readline may delete entire line
         # - http://bugs.python.org/issue12833
         with self.timeblockedsection(b'stdio'):
             if usereadline:
                 self.flush()
                 prompt = encoding.strfromlocal(prompt)
                 line = encoding.strtolocal(input(prompt))
                 # When stdin is in binary mode on Windows, it can cause
                 # input() to emit an extra trailing carriage return
                 if pycompat.oslinesep == b'\r\n' and line.endswith(b'\r'):
                     line = line[:-1]
             else:
                 self._fout.write(pycompat.bytestr(prompt))
                 self._fout.flush()
                 line = self._fin.readline()
                 if not line:
                     raise EOFError
                 line = line.rstrip(pycompat.oslinesep)
 
         return line
 
-    if pycompat.TYPE_CHECKING:
+    if typing.TYPE_CHECKING:
 
         @overload
         def prompt(self, msg: bytes, default: bytes) -> bytes:
             pass
 
         @overload
         def prompt(self, msg: bytes, default: None) -> Optional[bytes]:
             pass
 
     def prompt(self, msg, default=b"y"):
         """Prompt user with msg, read response.
         If ui is not interactive, the default is returned.
         """
         return self._prompt(msg, default=default)
 
-    if pycompat.TYPE_CHECKING:
+    if typing.TYPE_CHECKING:
 
         @overload
         def _prompt(
             self, msg: bytes, default: bytes, **opts: _MsgOpts
         ) -> bytes:
             pass
 
         @overload
         def _prompt(
             self, msg: bytes, default: None, **opts: _MsgOpts
         ) -> Optional[bytes]:
             pass
 
     def _prompt(self, msg, default=b'y', **opts):
         opts = {**opts, 'default': default}
         if not self.interactive():
             self._writemsg(self._fmsgout, msg, b' ', type=b'prompt', **opts)
             self._writemsg(
                 self._fmsgout, default or b'', b"\n", type=b'promptecho'
             )
             return default
         try:
             r = self._readline(prompt=msg, promptopts=opts)
             if not r:
                 r = default
             if self.configbool(b'ui', b'promptecho'):
                 self._writemsg(
                     self._fmsgout, r or b'', b"\n", type=b'promptecho'
                 )
             return r
         except EOFError:
             raise error.ResponseExpected()
 
     @staticmethod
     def extractchoices(prompt: bytes) -> Tuple[bytes, List[_PromptChoice]]:
         """Extract prompt message and list of choices from specified prompt.
 
         This returns tuple "(message, choices)", and "choices" is the
         list of tuple "(response character, text without &)".
 
         >>> ui.extractchoices(b"awake? $$ &Yes $$ &No")
         ('awake? ', [('y', 'Yes'), ('n', 'No')])
         >>> ui.extractchoices(b"line\\nbreak? $$ &Yes $$ &No")
         ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
         >>> ui.extractchoices(b"want lots of $$money$$?$$Ye&s$$N&o")
         ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
         """
 
         # Sadly, the prompt string may have been built with a filename
         # containing "$$" so let's try to find the first valid-looking
         # prompt to start parsing. Sadly, we also can't rely on
         # choices containing spaces, ASCII, or basically anything
         # except an ampersand followed by a character.
         m = re.match(br'(?s)(.+?)\$\$([^$]*&[^ $].*)', prompt)
 
         assert m is not None  # help pytype
 
         msg = m.group(1)
         choices = [p.strip(b' ') for p in m.group(2).split(b'$$')]
 
         def choicetuple(s):
             ampidx = s.index(b'&')
             return s[ampidx + 1 : ampidx + 2].lower(), s.replace(b'&', b'', 1)
 
         return (msg, [choicetuple(s) for s in choices])
 
     def promptchoice(self, prompt: bytes, default: int = 0) -> int:
         """Prompt user with a message, read response, and ensure it matches
         one of the provided choices. The prompt is formatted as follows:
 
            "would you like fries with that (Yn)? $$ &Yes $$ &No"
 
         The index of the choice is returned. Responses are case
         insensitive. If ui is not interactive, the default is
         returned.
         """
 
         msg, choices = self.extractchoices(prompt)
         resps = [r for r, t in choices]
         while True:
             r = self._prompt(msg, default=resps[default], choices=choices)
             if r.lower() in resps:
                 return resps.index(r.lower())
             # TODO: shouldn't it be a warning?
             self._writemsg(self._fmsgout, _(b"unrecognized response\n"))
 
     def getpass(
         self, prompt: Optional[bytes] = None, default: Optional[bytes] = None
     ) -> Optional[bytes]:
         if not self.interactive():
             return default
         try:
             self._writemsg(
                 self._fmsgerr,
                 prompt or _(b'password: '),
                 type=b'prompt',
                 password=True,
             )
             # disable getpass() only if explicitly specified. it's still valid
             # to interact with tty even if fin is not a tty.
             with self.timeblockedsection(b'stdio'):
                 if self.configbool(b'ui', b'nontty'):
                     l = self._fin.readline()
                     if not l:
                         raise EOFError
                     return l.rstrip(b'\n')
                 else:
                     return util.get_password()
         except EOFError:
             raise error.ResponseExpected()
 
     def status(self, *msg: bytes, **opts: _MsgOpts) -> None:
         """write status message to output (if ui.quiet is False)
 
         This adds an output label of "ui.status".
         """
         if not self.quiet:
             self._writemsg(self._fmsgout, type=b'status', *msg, **opts)
 
     def warn(self, *msg: bytes, **opts: _MsgOpts) -> None:
         """write warning message to output (stderr)
 
         This adds an output label of "ui.warning".
         """
         self._writemsg(self._fmsgerr, type=b'warning', *msg, **opts)
 
     def error(self, *msg: bytes, **opts: _MsgOpts) -> None:
         """write error message to output (stderr)
 
         This adds an output label of "ui.error".
         """
         self._writemsg(self._fmsgerr, type=b'error', *msg, **opts)
 
     def note(self, *msg: bytes, **opts: _MsgOpts) -> None:
         """write note to output (if ui.verbose is True)
 
         This adds an output label of "ui.note".
         """
         if self.verbose:
             self._writemsg(self._fmsgout, type=b'note', *msg, **opts)
 
     def debug(self, *msg: bytes, **opts: _MsgOpts) -> None:
         """write debug message to output (if ui.debugflag is True)
 
         This adds an output label of "ui.debug".
         """
         if self.debugflag:
             self._writemsg(self._fmsgout, type=b'debug', *msg, **opts)
             self.log(b'debug', b'%s', b''.join(msg))
 
     # Aliases to defeat check-code.
     statusnoi18n = status
     notenoi18n = note
     warnnoi18n = warn
     writenoi18n = write
 
     def edit(
         self,
         text: bytes,
         user: bytes,
         extra: Optional[Dict[bytes, Any]] = None,  # TODO: value type of bytes?
         editform=None,
         pending=None,
         repopath: Optional[bytes] = None,
         action: Optional[bytes] = None,
     ) -> bytes:
         if action is None:
             self.develwarn(
                 b'action is None but will soon be a required '
                 b'parameter to ui.edit()'
             )
         extra_defaults = {
             b'prefix': b'editor',
             b'suffix': b'.txt',
         }
         if extra is not None:
             if extra.get(b'suffix') is not None:
                 self.develwarn(
                     b'extra.suffix is not None but will soon be '
                     b'ignored by ui.edit()'
                 )
             extra_defaults.update(extra)
         extra = extra_defaults
 
         if action == b'diff':
             suffix = b'.diff'
         elif action:
             suffix = b'.%s.hg.txt' % action
         else:
             suffix = extra[b'suffix']
 
         rdir = None
         if self.configbool(b'experimental', b'editortmpinhg'):
             rdir = repopath
         (fd, name) = pycompat.mkstemp(
             prefix=b'hg-' + extra[b'prefix'] + b'-', suffix=suffix, dir=rdir
         )
         try:
             with os.fdopen(fd, 'wb') as f:
                 f.write(util.tonativeeol(text))
 
             environ = {b'HGUSER': user}
             if b'transplant_source' in extra:
                 environ.update(
                     {b'HGREVISION': hex(extra[b'transplant_source'])}
                 )
             for label in (b'intermediate-source', b'source', b'rebase_source'):
                 if label in extra:
                     environ.update({b'HGREVISION': extra[label]})
                     break
             if editform:
                 environ.update({b'HGEDITFORM': editform})
             if pending:
                 environ.update({b'HG_PENDING': pending})
 
             editor = self.geteditor()
 
             self.system(
                 b"%s \"%s\"" % (editor, name),
                 environ=environ,
                 onerr=error.CanceledError,
                 errprefix=_(b"edit failed"),
                 blockedtag=b'editor',
             )
 
             with open(name, 'rb') as f:
                 t = util.fromnativeeol(f.read())
         finally:
             os.unlink(name)
 
         return t
 
     def system(
         self,
         cmd: bytes,
         environ=None,
         cwd: Optional[bytes] = None,
         onerr: Optional[Callable[[bytes], Exception]] = None,
         errprefix: Optional[bytes] = None,
         blockedtag: Optional[bytes] = None,
     ) -> int:
         """execute shell command with appropriate output stream. command
         output will be redirected if fout is not stdout.
 
         if command fails and onerr is None, return status, else raise onerr
         object as exception.
         """
         if blockedtag is None:
             # Long cmds tend to be because of an absolute path on cmd. Keep
             # the tail end instead
             cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
             blockedtag = b'unknown_system_' + cmdsuffix
         out = self._fout
         if any(s[1] for s in self._bufferstates):
             out = self
         with self.timeblockedsection(blockedtag):
             rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
         if rc and onerr:
             errmsg = b'%s %s' % (
                 procutil.shellsplit(cmd)[0],
                 procutil.explainexit(rc),
             )
             if errprefix:
                 errmsg = b'%s: %s' % (errprefix, errmsg)
             raise onerr(errmsg)
         return rc
 
     def _runsystem(self, cmd: bytes, environ, cwd: Optional[bytes], out) -> int:
         """actually execute the given shell command (can be overridden by
         extensions like chg)"""
         return procutil.system(cmd, environ=environ, cwd=cwd, out=out)
 
     def traceback(self, exc=None, force: bool = False):
         """print exception traceback if traceback printing enabled or forced.
         only to call in exception handler. returns true if traceback
         printed."""
         if self.tracebackflag or force:
             if exc is None:
                 exc = sys.exc_info()
             cause = getattr(exc[1], 'cause', None)
 
             if cause is not None:
                 causetb = traceback.format_tb(cause[2])
                 exctb = traceback.format_tb(exc[2])
                 exconly = traceback.format_exception_only(cause[0], cause[1])
 
                 # exclude frame where 'exc' was chained and rethrown from exctb
                 self.write_err(
                     b'Traceback (most recent call last):\n',
                     encoding.strtolocal(''.join(exctb[:-1])),
                     encoding.strtolocal(''.join(causetb)),
                     encoding.strtolocal(''.join(exconly)),
                 )
             else:
                 output = traceback.format_exception(exc[0], exc[1], exc[2])
                 self.write_err(encoding.strtolocal(''.join(output)))
         return self.tracebackflag or force
 
     def geteditor(self):
         '''return editor to use'''
         if pycompat.sysplatform == b'plan9':
             # vi is the MIPS instruction simulator on Plan 9. We
             # instead default to E to plumb commit messages to
             # avoid confusion.
             editor = b'E'
         elif pycompat.isdarwin:
             # vi on darwin is POSIX compatible to a fault, and that includes
             # exiting non-zero if you make any mistake when running an ex
             # command. Proof: `vi -c ':unknown' -c ':qa'; echo $?` produces 1,
             # while s/vi/vim/ doesn't.
             editor = b'vim'
         else:
             editor = b'vi'
         return encoding.environ.get(b"HGEDITOR") or self.config(
             b"ui", b"editor", editor
         )
 
     @util.propertycache
     def _progbar(self) -> Optional[progress.progbar]:
         """setup the progbar singleton to the ui object"""
         if (
             self.quiet
             or self.debugflag
             or self.configbool(b'progress', b'disable')
             or not progress.shouldprint(self)
         ):
             return None
         return getprogbar(self)
 
     def _progclear(self) -> None:
         """clear progress bar output if any. use it before any output"""
         if not haveprogbar():  # nothing loaded yet
             return
         if self._progbar is not None and self._progbar.printed:
             self._progbar.clear()
 
     def makeprogress(
         self, topic: bytes, unit: bytes = b"", total: Optional[int] = None
     ) -> scmutil.progress:
         """Create a progress helper for the specified topic"""
         if getattr(self._fmsgerr, 'structured', False):
             # channel for machine-readable output with metadata, just send
             # raw information
             # TODO: consider porting some useful information (e.g. estimated
             # time) from progbar. we might want to support update delay to
             # reduce the cost of transferring progress messages.
             def updatebar(topic, pos, item, unit, total):
                 self._fmsgerr.write(
                     None,
                     type=b'progress',
                     topic=topic,
                     pos=pos,
                     item=item,
                     unit=unit,
                     total=total,
                 )
 
         elif self._progbar is not None:
             updatebar = self._progbar.progress
         else:
 
             def updatebar(topic, pos, item, unit, total):
                 pass
 
         return scmutil.progress(self, updatebar, topic, unit, total)
 
     def getlogger(self, name):
         """Returns a logger of the given name; or None if not registered"""
         return self._loggers.get(name)
 
     def setlogger(self, name, logger) -> None:
         """Install logger which can be identified later by the given name
 
         More than one loggers can be registered. Use extension or module
         name to uniquely identify the logger instance.
         """
         self._loggers[name] = logger
 
     def log(self, event, msgfmt, *msgargs, **opts) -> None:
         """hook for logging facility extensions
 
         event should be a readily-identifiable subsystem, which will
         allow filtering.
 
         msgfmt should be a newline-terminated format string to log, and
         *msgargs are %-formatted into it.
 
         **opts currently has no defined meanings.
         """
         if not self._loggers:
             return
         activeloggers = [l for l in self._loggers.values() if l.tracked(event)]
         if not activeloggers:
             return
         msg = msgfmt % msgargs
         opts = pycompat.byteskwargs(opts)
         # guard against recursion from e.g. ui.debug()
         registeredloggers = self._loggers
         self._loggers = {}
         try:
             for logger in activeloggers:
                 logger.log(self, event, msg, opts)
         finally:
             self._loggers = registeredloggers
 
     def label(self, msg: bytes, label: bytes) -> bytes:
         """style msg based on supplied label
 
         If some color mode is enabled, this will add the necessary control
         characters to apply such color. In addition, 'debug' color mode adds
         markup showing which label affects a piece of text.
 
         ui.write(s, 'label') is equivalent to
         ui.write(ui.label(s, 'label')).
         """
         if self._colormode is not None:
             return color.colorlabel(self, msg, label)
         return msg
 
     def develwarn(
         self, msg: bytes, stacklevel: int = 1, config: Optional[bytes] = None
     ) -> None:
         """issue a developer warning message
 
         Use 'stacklevel' to report the offender some layers further up in the
         stack.
         """
         if not self.configbool(b'devel', b'all-warnings'):
             if config is None or not self.configbool(b'devel', config):
                 return
         msg = b'devel-warn: ' + msg
         stacklevel += 1  # get in develwarn
         if self.tracebackflag:
             util.debugstacktrace(msg, stacklevel, self._ferr, self._fout)
             self.log(
                 b'develwarn',
                 b'%s at:\n%s'
                 % (msg, b''.join(util.getstackframes(stacklevel))),
             )
         else:
             curframe = inspect.currentframe()
             calframe = inspect.getouterframes(curframe, 2)
             fname, lineno, fmsg = calframe[stacklevel][1:4]
             fname, fmsg = pycompat.sysbytes(fname), pycompat.sysbytes(fmsg)
             self.write_err(b'%s at: %s:%d (%s)\n' % (msg, fname, lineno, fmsg))
             self.log(
                 b'develwarn', b'%s at: %s:%d (%s)\n', msg, fname, lineno, fmsg
             )
 
             # avoid cycles
             del curframe
             del calframe
 
     def deprecwarn(
         self,
         msg: bytes,
         version: bytes,
         stacklevel: int = 2,
     ) -> None:
         """issue a deprecation warning
 
         - msg: message explaining what is deprecated and how to upgrade,
         - version: last version where the API will be supported,
         """
         if not (
             self.configbool(b'devel', b'all-warnings')
             or self.configbool(b'devel', b'deprec-warn')
         ):
             return
         msg += (
             b"\n(compatibility will be dropped after Mercurial-%s,"
             b" update your code.)"
         ) % version
         self.develwarn(msg, stacklevel=stacklevel, config=b'deprec-warn')
 
     def exportableenviron(self):
         """The environment variables that are safe to export, e.g. through
         hgweb.
         """
         return self._exportableenviron
 
     @contextlib.contextmanager
     def configoverride(self, overrides: _ConfigItems, source: bytes = b""):
         """Context manager for temporary config overrides
         `overrides` must be a dict of the following structure:
         {(section, name) : value}"""
         backups = {}
         try:
             for (section, name), value in overrides.items():
                 backups[(section, name)] = self.backupconfig(section, name)
                 self.setconfig(section, name, value, source)
             yield
         finally:
             for __, backup in backups.items():
                 self.restoreconfig(backup)
             # just restoring ui.quiet config to the previous value is not enough
             # as it does not update ui.quiet class member
             if (b'ui', b'quiet') in overrides:
                 self.fixconfig(section=b'ui')
 
     def estimatememory(self) -> Optional[int]:
         """Provide an estimate for the available system memory in Bytes.
 
         This can be overriden via ui.available-memory. It returns None, if
         no estimate can be computed.
         """
         value = self.config(b'ui', b'available-memory')
         if value is not None:
             try:
                 return util.sizetoint(value)
             except error.ParseError:
                 raise error.ConfigError(
                     _(b"ui.available-memory value is invalid ('%s')") % value
                 )
         return util._estimatememory()
 
 
 # we instantiate one globally shared progress bar to avoid
 # competing progress bars when multiple UI objects get created
 _progresssingleton: Optional[progress.progbar] = None
 
 
 def getprogbar(ui: ui) -> progress.progbar:
     global _progresssingleton
     if _progresssingleton is None:
         # passing 'ui' object to the singleton is fishy,
         # this is how the extension used to work but feel free to rework it.
         _progresssingleton = progress.progbar(ui)
     return _progresssingleton
 
 
 def haveprogbar() -> bool:
     return _progresssingleton is not None
 
 
 def _selectmsgdests(ui: ui):
     name = ui.config(b'ui', b'message-output')
     if name == b'channel':
         if ui.fmsg:
             return ui.fmsg, ui.fmsg
         else:
             # fall back to ferr if channel isn't ready so that status/error
             # messages can be printed
             return ui.ferr, ui.ferr
     if name == b'stdio':
         return ui.fout, ui.ferr
     if name == b'stderr':
         return ui.ferr, ui.ferr
     raise error.Abort(b'invalid ui.message-output destination: %s' % name)
 
 
 def _writemsgwith(write, dest, *args: bytes, **opts: _MsgOpts) -> None:
     """Write ui message with the given ui._write*() function
 
     The specified message type is translated to 'ui.<type>' label if the dest
     isn't a structured channel, so that the message will be colorized.
     """
     # TODO: maybe change 'type' to a mandatory option
     if 'type' in opts and not getattr(dest, 'structured', False):
         opts['label'] = opts.get('label', b'') + b' ui.%s' % opts.pop('type')
     write(dest, *args, **opts)