py3: fix type of some elements of __all__ lists

hgext/highlight/__init__.py

@@ -1,108 +1,108 b''
 # highlight - syntax highlighting in hgweb, based on Pygments
 #
 #  Copyright 2008, 2009 Patrick Mezard <[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.
 #
 # The original module was split in an interface and an implementation
 # file to defer pygments loading and speedup extension setup.
 
 """syntax highlighting for hgweb (requires Pygments)
 
 It depends on the Pygments syntax highlighting library:
 http://pygments.org/
 
 There are the following configuration options::
 
   [web]
   pygments_style = <style> (default: colorful)
   highlightfiles = <fileset> (default: size('<5M'))
   highlightonlymatchfilename = <bool> (default False)
 
 ``highlightonlymatchfilename`` will only highlight files if their type could
 be identified by their filename. When this is not enabled (the default),
 Pygments will try very hard to identify the file type from content and any
 match (even matches with a low confidence score) will be used.
 """
 
 
 from . import highlight
 from mercurial.hgweb import (
     webcommands,
     webutil,
 )
 
 from mercurial import (
     extensions,
     pycompat,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
 # be specifying the version(s) of Mercurial they are tested with, or
 # leave the attribute unspecified.
 testedwith = b'ships-with-hg-core'
 
 
 def pygmentize(web, field, fctx, tmpl):
     style = web.config(b'web', b'pygments_style', b'colorful')
     expr = web.config(b'web', b'highlightfiles', b"size('<5M')")
     filenameonly = web.configbool(b'web', b'highlightonlymatchfilename', False)
 
     ctx = fctx.changectx()
     m = ctx.matchfileset(fctx.repo().root, expr)
     if m(fctx.path()):
         highlight.pygmentize(
             field, fctx, style, tmpl, guessfilenameonly=filenameonly
         )
 
 
 def filerevision_highlight(orig, web, fctx):
     mt = web.res.headers[b'Content-Type']
     # only pygmentize for mimetype containing 'html' so we both match
     # 'text/html' and possibly 'application/xhtml+xml' in the future
     # so that we don't have to touch the extension when the mimetype
     # for a template changes; also hgweb optimizes the case that a
     # raw file is sent using rawfile() and doesn't call us, so we
     # can't clash with the file's content-type here in case we
     # pygmentize a html file
     if b'html' in mt:
         pygmentize(web, b'fileline', fctx, web.tmpl)
 
     return orig(web, fctx)
 
 
 def annotate_highlight(orig, web):
     mt = web.res.headers[b'Content-Type']
     if b'html' in mt:
         fctx = webutil.filectx(web.repo, web.req)
         pygmentize(web, b'annotateline', fctx, web.tmpl)
 
     return orig(web)
 
 
 def generate_css(web):
     pg_style = web.config(b'web', b'pygments_style', b'colorful')
     fmter = highlight.HtmlFormatter(style=pycompat.sysstr(pg_style))
     web.res.headers[b'Content-Type'] = b'text/css'
     style_defs = fmter.get_style_defs(pycompat.sysstr(b''))
     web.res.setbodybytes(
         b''.join(
             [
                 b'/* pygments_style = %s */\n\n' % pg_style,
                 pycompat.bytestr(style_defs),
             ]
         )
     )
     return web.res.sendresponse()
 
 
 def extsetup(ui):
     # monkeypatch in the new version
     extensions.wrapfunction(
         webcommands, '_filerevision', filerevision_highlight
     )
     extensions.wrapfunction(webcommands, 'annotate', annotate_highlight)
     webcommands.highlightcss = generate_css
-    webcommands.__all__.append(b'highlightcss')
+    webcommands.__all__.append('highlightcss')

hgext/zeroconf/Zeroconf.py

@@ -1,1890 +1,1890 b''
 """ Multicast DNS Service Discovery for Python, v0.12
     Copyright (C) 2003, Paul Scott-Murphy
 
     This module provides a framework for the use of DNS Service Discovery
     using IP multicast.  It has been tested against the JRendezvous
     implementation from <a href="http://strangeberry.com">StrangeBerry</a>,
     and against the mDNSResponder from Mac OS X 10.3.8.
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
     License as published by the Free Software Foundation; either
     version 2.1 of the License, or (at your option) any later version.
 
     This library is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     Lesser General Public License for more details.
 
     You should have received a copy of the GNU Lesser General Public
     License along with this library; if not, see
     <http://www.gnu.org/licenses/>.
 
 """
 
 """0.12 update - allow selection of binding interface
          typo fix - Thanks A. M. Kuchlingi
          removed all use of word 'Rendezvous' - this is an API change"""
 
 """0.11 update - correction to comments for addListener method
                  support for new record types seen from OS X
                   - IPv6 address
                   - hostinfo
                  ignore unknown DNS record types
                  fixes to name decoding
                  works alongside other processes using port 5353 (e.g. Mac OS X)
                  tested against Mac OS X 10.3.2's mDNSResponder
                  corrections to removal of list entries for service browser"""
 
 """0.10 update - Jonathon Paisley contributed these corrections:
                  always multicast replies, even when query is unicast
                  correct a pointer encoding problem
                  can now write records in any order
                  traceback shown on failure
                  better TXT record parsing
                  server is now separate from name
                  can cancel a service browser
 
                  modified some unit tests to accommodate these changes"""
 
 """0.09 update - remove all records on service unregistration
                  fix DOS security problem with readName"""
 
 """0.08 update - changed licensing to LGPL"""
 
 """0.07 update - faster shutdown on engine
                  pointer encoding of outgoing names
                  ServiceBrowser now works
                  new unit tests"""
 
 """0.06 update - small improvements with unit tests
                  added defined exception types
                  new style objects
                  fixed hostname/interface problem
                  fixed socket timeout problem
                  fixed addServiceListener() typo bug
                  using select() for socket reads
                  tested on Debian unstable with Python 2.2.2"""
 
 """0.05 update - ensure case insensitivity on domain names
                  support for unicast DNS queries"""
 
 """0.04 update - added some unit tests
                  added __ne__ adjuncts where required
                  ensure names end in '.local.'
                  timeout on receiving socket for clean shutdown"""
 
 __author__ = b"Paul Scott-Murphy"
 __email__ = b"paul at scott dash murphy dot com"
 __version__ = b"0.12"
 
 import errno
 import itertools
 import select
 import socket
 import struct
 import threading
 import time
 import traceback
 
 from mercurial import pycompat
 
-__all__ = [b"Zeroconf", b"ServiceInfo", b"ServiceBrowser"]
+__all__ = ["Zeroconf", "ServiceInfo", "ServiceBrowser"]
 
 # hook for threads
 
 globals()[b'_GLOBAL_DONE'] = 0
 
 # Some timing constants
 
 _UNREGISTER_TIME = 125
 _CHECK_TIME = 175
 _REGISTER_TIME = 225
 _LISTENER_TIME = 200
 _BROWSER_TIME = 500
 
 # Some DNS constants
 
 _MDNS_ADDR = r'224.0.0.251'
 _MDNS_PORT = 5353
 _DNS_PORT = 53
 _DNS_TTL = 60 * 60  # one hour default TTL
 
 _MAX_MSG_TYPICAL = 1460  # unused
 _MAX_MSG_ABSOLUTE = 8972
 
 _FLAGS_QR_MASK = 0x8000  # query response mask
 _FLAGS_QR_QUERY = 0x0000  # query
 _FLAGS_QR_RESPONSE = 0x8000  # response
 
 _FLAGS_AA = 0x0400  # Authoritative answer
 _FLAGS_TC = 0x0200  # Truncated
 _FLAGS_RD = 0x0100  # Recursion desired
 _FLAGS_RA = 0x8000  # Recursion available
 
 _FLAGS_Z = 0x0040  # Zero
 _FLAGS_AD = 0x0020  # Authentic data
 _FLAGS_CD = 0x0010  # Checking disabled
 
 _CLASS_IN = 1
 _CLASS_CS = 2
 _CLASS_CH = 3
 _CLASS_HS = 4
 _CLASS_NONE = 254
 _CLASS_ANY = 255
 _CLASS_MASK = 0x7FFF
 _CLASS_UNIQUE = 0x8000
 
 _TYPE_A = 1
 _TYPE_NS = 2
 _TYPE_MD = 3
 _TYPE_MF = 4
 _TYPE_CNAME = 5
 _TYPE_SOA = 6
 _TYPE_MB = 7
 _TYPE_MG = 8
 _TYPE_MR = 9
 _TYPE_NULL = 10
 _TYPE_WKS = 11
 _TYPE_PTR = 12
 _TYPE_HINFO = 13
 _TYPE_MINFO = 14
 _TYPE_MX = 15
 _TYPE_TXT = 16
 _TYPE_AAAA = 28
 _TYPE_SRV = 33
 _TYPE_ANY = 255
 
 # Mapping constants to names
 
 _CLASSES = {
     _CLASS_IN: b"in",
     _CLASS_CS: b"cs",
     _CLASS_CH: b"ch",
     _CLASS_HS: b"hs",
     _CLASS_NONE: b"none",
     _CLASS_ANY: b"any",
 }
 
 _TYPES = {
     _TYPE_A: b"a",
     _TYPE_NS: b"ns",
     _TYPE_MD: b"md",
     _TYPE_MF: b"mf",
     _TYPE_CNAME: b"cname",
     _TYPE_SOA: b"soa",
     _TYPE_MB: b"mb",
     _TYPE_MG: b"mg",
     _TYPE_MR: b"mr",
     _TYPE_NULL: b"null",
     _TYPE_WKS: b"wks",
     _TYPE_PTR: b"ptr",
     _TYPE_HINFO: b"hinfo",
     _TYPE_MINFO: b"minfo",
     _TYPE_MX: b"mx",
     _TYPE_TXT: b"txt",
     _TYPE_AAAA: b"quada",
     _TYPE_SRV: b"srv",
     _TYPE_ANY: b"any",
 }
 
 # utility functions
 
 
 def currentTimeMillis():
     """Current system time in milliseconds"""
     return time.time() * 1000
 
 
 # Exceptions
 
 
 class NonLocalNameException(Exception):
     pass
 
 
 class NonUniqueNameException(Exception):
     pass
 
 
 class NamePartTooLongException(Exception):
     pass
 
 
 class AbstractMethodException(Exception):
     pass
 
 
 class BadTypeInNameException(Exception):
     pass
 
 
 class BadDomainName(Exception):
     def __init__(self, pos):
         Exception.__init__(self, b"at position %s" % pos)
 
 
 class BadDomainNameCircular(BadDomainName):
     pass
 
 
 # implementation classes
 
 
 class DNSEntry:
     """A DNS entry"""
 
     def __init__(self, name, type, clazz):
         self.key = name.lower()
         self.name = name
         self.type = type
         self.clazz = clazz & _CLASS_MASK
         self.unique = (clazz & _CLASS_UNIQUE) != 0
 
     def __eq__(self, other):
         """Equality test on name, type, and class"""
         if isinstance(other, DNSEntry):
             return (
                 self.name == other.name
                 and self.type == other.type
                 and self.clazz == other.clazz
             )
         return 0
 
     def __ne__(self, other):
         """Non-equality test"""
         return not self.__eq__(other)
 
     def getClazz(self, clazz):
         """Class accessor"""
         try:
             return _CLASSES[clazz]
         except KeyError:
             return b"?(%s)" % clazz
 
     def getType(self, type):
         """Type accessor"""
         try:
             return _TYPES[type]
         except KeyError:
             return b"?(%s)" % type
 
     def toString(self, hdr, other):
         """String representation with additional information"""
         result = b"%s[%s,%s" % (
             hdr,
             self.getType(self.type),
             self.getClazz(self.clazz),
         )
         if self.unique:
             result += b"-unique,"
         else:
             result += b","
         result += self.name
         if other is not None:
             result += b",%s]" % other
         else:
             result += b"]"
         return result
 
 
 class DNSQuestion(DNSEntry):
     """A DNS question entry"""
 
     def __init__(self, name, type, clazz):
         if isinstance(name, str):
             name = name.encode('ascii')
         if not name.endswith(b".local."):
             raise NonLocalNameException(name)
         DNSEntry.__init__(self, name, type, clazz)
 
     def answeredBy(self, rec):
         """Returns true if the question is answered by the record"""
         return (
             self.clazz == rec.clazz
             and (self.type == rec.type or self.type == _TYPE_ANY)
             and self.name == rec.name
         )
 
     def __repr__(self):
         """String representation"""
         return DNSEntry.toString(self, b"question", None)
 
 
 class DNSRecord(DNSEntry):
     """A DNS record - like a DNS entry, but has a TTL"""
 
     def __init__(self, name, type, clazz, ttl):
         DNSEntry.__init__(self, name, type, clazz)
         self.ttl = ttl
         self.created = currentTimeMillis()
 
     def __eq__(self, other):
         """Tests equality as per DNSRecord"""
         if isinstance(other, DNSRecord):
             return DNSEntry.__eq__(self, other)
         return 0
 
     def suppressedBy(self, msg):
         """Returns true if any answer in a message can suffice for the
         information held in this record."""
         for record in msg.answers:
             if self.suppressedByAnswer(record):
                 return 1
         return 0
 
     def suppressedByAnswer(self, other):
         """Returns true if another record has same name, type and class,
         and if its TTL is at least half of this record's."""
         if self == other and other.ttl > (self.ttl / 2):
             return 1
         return 0
 
     def getExpirationTime(self, percent):
         """Returns the time at which this record will have expired
         by a certain percentage."""
         return self.created + (percent * self.ttl * 10)
 
     def getRemainingTTL(self, now):
         """Returns the remaining TTL in seconds."""
         return max(0, (self.getExpirationTime(100) - now) / 1000)
 
     def isExpired(self, now):
         """Returns true if this record has expired."""
         return self.getExpirationTime(100) <= now
 
     def isStale(self, now):
         """Returns true if this record is at least half way expired."""
         return self.getExpirationTime(50) <= now
 
     def resetTTL(self, other):
         """Sets this record's TTL and created time to that of
         another record."""
         self.created = other.created
         self.ttl = other.ttl
 
     def write(self, out):
         """Abstract method"""
         raise AbstractMethodException
 
     def toString(self, other):
         """String representation with additional information"""
         arg = b"%s/%s,%s" % (
             self.ttl,
             self.getRemainingTTL(currentTimeMillis()),
             other,
         )
         return DNSEntry.toString(self, b"record", arg)
 
 
 class DNSAddress(DNSRecord):
     """A DNS address record"""
 
     def __init__(self, name, type, clazz, ttl, address):
         DNSRecord.__init__(self, name, type, clazz, ttl)
         self.address = address
 
     def write(self, out):
         """Used in constructing an outgoing packet"""
         out.writeString(self.address, len(self.address))
 
     def __eq__(self, other):
         """Tests equality on address"""
         if isinstance(other, DNSAddress):
             return self.address == other.address
         return 0
 
     def __repr__(self):
         """String representation"""
         try:
             return socket.inet_ntoa(self.address)
         except Exception:
             return self.address
 
 
 class DNSHinfo(DNSRecord):
     """A DNS host information record"""
 
     def __init__(self, name, type, clazz, ttl, cpu, os):
         DNSRecord.__init__(self, name, type, clazz, ttl)
         self.cpu = cpu
         self.os = os
 
     def write(self, out):
         """Used in constructing an outgoing packet"""
         out.writeString(self.cpu, len(self.cpu))
         out.writeString(self.os, len(self.os))
 
     def __eq__(self, other):
         """Tests equality on cpu and os"""
         if isinstance(other, DNSHinfo):
             return self.cpu == other.cpu and self.os == other.os
         return 0
 
     def __repr__(self):
         """String representation"""
         return self.cpu + b" " + self.os
 
 
 class DNSPointer(DNSRecord):
     """A DNS pointer record"""
 
     def __init__(self, name, type, clazz, ttl, alias):
         DNSRecord.__init__(self, name, type, clazz, ttl)
         self.alias = alias
 
     def write(self, out):
         """Used in constructing an outgoing packet"""
         out.writeName(self.alias)
 
     def __eq__(self, other):
         """Tests equality on alias"""
         if isinstance(other, DNSPointer):
             return self.alias == other.alias
         return 0
 
     def __repr__(self):
         """String representation"""
         return self.toString(self.alias)
 
 
 class DNSText(DNSRecord):
     """A DNS text record"""
 
     def __init__(self, name, type, clazz, ttl, text):
         DNSRecord.__init__(self, name, type, clazz, ttl)
         self.text = text
 
     def write(self, out):
         """Used in constructing an outgoing packet"""
         out.writeString(self.text, len(self.text))
 
     def __eq__(self, other):
         """Tests equality on text"""
         if isinstance(other, DNSText):
             return self.text == other.text
         return 0
 
     def __repr__(self):
         """String representation"""
         if len(self.text) > 10:
             return self.toString(self.text[:7] + b"...")
         else:
             return self.toString(self.text)
 
 
 class DNSService(DNSRecord):
     """A DNS service record"""
 
     def __init__(self, name, type, clazz, ttl, priority, weight, port, server):
         DNSRecord.__init__(self, name, type, clazz, ttl)
         self.priority = priority
         self.weight = weight
         self.port = port
         self.server = server
 
     def write(self, out):
         """Used in constructing an outgoing packet"""
         out.writeShort(self.priority)
         out.writeShort(self.weight)
         out.writeShort(self.port)
         out.writeName(self.server)
 
     def __eq__(self, other):
         """Tests equality on priority, weight, port and server"""
         if isinstance(other, DNSService):
             return (
                 self.priority == other.priority
                 and self.weight == other.weight
                 and self.port == other.port
                 and self.server == other.server
             )
         return 0
 
     def __repr__(self):
         """String representation"""
         return self.toString(b"%s:%s" % (self.server, self.port))
 
 
 class DNSIncoming:
     """Object representation of an incoming DNS packet"""
 
     def __init__(self, data):
         """Constructor from string holding bytes of packet"""
         self.offset = 0
         self.data = data
         self.questions = []
         self.answers = []
         self.numquestions = 0
         self.numanswers = 0
         self.numauthorities = 0
         self.numadditionals = 0
 
         self.readHeader()
         self.readQuestions()
         self.readOthers()
 
     def readHeader(self):
         """Reads header portion of packet"""
         format = b'!HHHHHH'
         length = struct.calcsize(format)
         info = struct.unpack(
             format, self.data[self.offset : self.offset + length]
         )
         self.offset += length
 
         self.id = info[0]
         self.flags = info[1]
         self.numquestions = info[2]
         self.numanswers = info[3]
         self.numauthorities = info[4]
         self.numadditionals = info[5]
 
     def readQuestions(self):
         """Reads questions section of packet"""
         format = b'!HH'
         length = struct.calcsize(format)
         for i in range(0, self.numquestions):
             name = self.readName()
             info = struct.unpack(
                 format, self.data[self.offset : self.offset + length]
             )
             self.offset += length
 
             try:
                 question = DNSQuestion(name, info[0], info[1])
                 self.questions.append(question)
             except NonLocalNameException:
                 pass
 
     def readInt(self):
         """Reads an integer from the packet"""
         format = b'!I'
         length = struct.calcsize(format)
         info = struct.unpack(
             format, self.data[self.offset : self.offset + length]
         )
         self.offset += length
         return info[0]
 
     def readCharacterString(self):
         """Reads a character string from the packet"""
         length = ord(self.data[self.offset])
         self.offset += 1
         return self.readString(length)
 
     def readString(self, len):
         """Reads a string of a given length from the packet"""
         format = b'!%ds' % len
         length = struct.calcsize(format)
         info = struct.unpack(
             format, self.data[self.offset : self.offset + length]
         )
         self.offset += length
         return info[0]
 
     def readUnsignedShort(self):
         """Reads an unsigned short from the packet"""
         format = b'!H'
         length = struct.calcsize(format)
         info = struct.unpack(
             format, self.data[self.offset : self.offset + length]
         )
         self.offset += length
         return info[0]
 
     def readOthers(self):
         """Reads answers, authorities and additionals section of the packet"""
         format = b'!HHiH'
         length = struct.calcsize(format)
         n = self.numanswers + self.numauthorities + self.numadditionals
         for i in range(0, n):
             domain = self.readName()
             info = struct.unpack(
                 format, self.data[self.offset : self.offset + length]
             )
             self.offset += length
 
             rec = None
             if info[0] == _TYPE_A:
                 rec = DNSAddress(
                     domain, info[0], info[1], info[2], self.readString(4)
                 )
             elif info[0] == _TYPE_CNAME or info[0] == _TYPE_PTR:
                 rec = DNSPointer(
                     domain, info[0], info[1], info[2], self.readName()
                 )
             elif info[0] == _TYPE_TXT:
                 rec = DNSText(
                     domain, info[0], info[1], info[2], self.readString(info[3])
                 )
             elif info[0] == _TYPE_SRV:
                 rec = DNSService(
                     domain,
                     info[0],
                     info[1],
                     info[2],
                     self.readUnsignedShort(),
                     self.readUnsignedShort(),
                     self.readUnsignedShort(),
                     self.readName(),
                 )
             elif info[0] == _TYPE_HINFO:
                 rec = DNSHinfo(
                     domain,
                     info[0],
                     info[1],
                     info[2],
                     self.readCharacterString(),
                     self.readCharacterString(),
                 )
             elif info[0] == _TYPE_AAAA:
                 rec = DNSAddress(
                     domain, info[0], info[1], info[2], self.readString(16)
                 )
             else:
                 # Try to ignore types we don't know about
                 # this may mean the rest of the name is
                 # unable to be parsed, and may show errors
                 # so this is left for debugging.  New types
                 # encountered need to be parsed properly.
                 #
                 # print "UNKNOWN TYPE = " + str(info[0])
                 # raise BadTypeInNameException
                 self.offset += info[3]
 
             if rec is not None:
                 self.answers.append(rec)
 
     def isQuery(self):
         """Returns true if this is a query"""
         return (self.flags & _FLAGS_QR_MASK) == _FLAGS_QR_QUERY
 
     def isResponse(self):
         """Returns true if this is a response"""
         return (self.flags & _FLAGS_QR_MASK) == _FLAGS_QR_RESPONSE
 
     def readUTF(self, offset, len):
         """Reads a UTF-8 string of a given length from the packet"""
         return self.data[offset : offset + len].decode('utf-8')
 
     def readName(self):
         """Reads a domain name from the packet"""
         result = r''
         off = self.offset
         next = -1
         first = off
 
         while True:
             len = ord(self.data[off : off + 1])
             off += 1
             if len == 0:
                 break
             t = len & 0xC0
             if t == 0x00:
                 result = ''.join((result, self.readUTF(off, len) + '.'))
                 off += len
             elif t == 0xC0:
                 if next < 0:
                     next = off + 1
                 off = ((len & 0x3F) << 8) | ord(self.data[off : off + 1])
                 if off >= first:
                     raise BadDomainNameCircular(off)
                 first = off
             else:
                 raise BadDomainName(off)
 
         if next >= 0:
             self.offset = next
         else:
             self.offset = off
 
         return result
 
 
 class DNSOutgoing:
     """Object representation of an outgoing packet"""
 
     def __init__(self, flags, multicast=1):
         self.finished = 0
         self.id = 0
         self.multicast = multicast
         self.flags = flags
         self.names = {}
         self.data = []
         self.size = 12
 
         self.questions = []
         self.answers = []
         self.authorities = []
         self.additionals = []
 
     def addQuestion(self, record):
         """Adds a question"""
         self.questions.append(record)
 
     def addAnswer(self, inp, record):
         """Adds an answer"""
         if not record.suppressedBy(inp):
             self.addAnswerAtTime(record, 0)
 
     def addAnswerAtTime(self, record, now):
         """Adds an answer if if does not expire by a certain time"""
         if record is not None:
             if now == 0 or not record.isExpired(now):
                 self.answers.append((record, now))
 
     def addAuthoritativeAnswer(self, record):
         """Adds an authoritative answer"""
         self.authorities.append(record)
 
     def addAdditionalAnswer(self, record):
         """Adds an additional answer"""
         self.additionals.append(record)
 
     def writeByte(self, value):
         """Writes a single byte to the packet"""
         format = b'!c'
         self.data.append(struct.pack(format, chr(value)))
         self.size += 1
 
     def insertShort(self, index, value):
         """Inserts an unsigned short in a certain position in the packet"""
         format = b'!H'
         self.data.insert(index, struct.pack(format, value))
         self.size += 2
 
     def writeShort(self, value):
         """Writes an unsigned short to the packet"""
         format = b'!H'
         self.data.append(struct.pack(format, value))
         self.size += 2
 
     def writeInt(self, value):
         """Writes an unsigned integer to the packet"""
         format = b'!I'
         self.data.append(struct.pack(format, int(value)))
         self.size += 4
 
     def writeString(self, value, length):
         """Writes a string to the packet"""
         format = '!' + str(length) + 's'
         self.data.append(struct.pack(format, value))
         self.size += length
 
     def writeUTF(self, s):
         """Writes a UTF-8 string of a given length to the packet"""
         utfstr = s.encode('utf-8')
         length = len(utfstr)
         if length > 64:
             raise NamePartTooLongException
         self.writeByte(length)
         self.writeString(utfstr, length)
 
     def writeName(self, name):
         """Writes a domain name to the packet"""
 
         try:
             # Find existing instance of this name in packet
             #
             index = self.names[name]
         except KeyError:
             # No record of this name already, so write it
             # out as normal, recording the location of the name
             # for future pointers to it.
             #
             self.names[name] = self.size
             parts = name.split(b'.')
             if parts[-1] == b'':
                 parts = parts[:-1]
             for part in parts:
                 self.writeUTF(part)
             self.writeByte(0)
             return
 
         # An index was found, so write a pointer to it
         #
         self.writeByte((index >> 8) | 0xC0)
         self.writeByte(index)
 
     def writeQuestion(self, question):
         """Writes a question to the packet"""
         self.writeName(question.name)
         self.writeShort(question.type)
         self.writeShort(question.clazz)
 
     def writeRecord(self, record, now):
         """Writes a record (answer, authoritative answer, additional) to
         the packet"""
         self.writeName(record.name)
         self.writeShort(record.type)
         if record.unique and self.multicast:
             self.writeShort(record.clazz | _CLASS_UNIQUE)
         else:
             self.writeShort(record.clazz)
         if now == 0:
             self.writeInt(record.ttl)
         else:
             self.writeInt(record.getRemainingTTL(now))
         index = len(self.data)
         # Adjust size for the short we will write before this record
         #
         self.size += 2
         record.write(self)
         self.size -= 2
 
         length = len(b''.join(self.data[index:]))
         self.insertShort(index, length)  # Here is the short we adjusted for
 
     def packet(self):
         """Returns a string containing the packet's bytes
 
         No further parts should be added to the packet once this
         is done."""
         if not self.finished:
             self.finished = 1
             for question in self.questions:
                 self.writeQuestion(question)
             for answer, time_ in self.answers:
                 self.writeRecord(answer, time_)
             for authority in self.authorities:
                 self.writeRecord(authority, 0)
             for additional in self.additionals:
                 self.writeRecord(additional, 0)
 
             self.insertShort(0, len(self.additionals))
             self.insertShort(0, len(self.authorities))
             self.insertShort(0, len(self.answers))
             self.insertShort(0, len(self.questions))
             self.insertShort(0, self.flags)
             if self.multicast:
                 self.insertShort(0, 0)
             else:
                 self.insertShort(0, self.id)
         return b''.join(self.data)
 
 
 class DNSCache:
     """A cache of DNS entries"""
 
     def __init__(self):
         self.cache = {}
 
     def add(self, entry):
         """Adds an entry"""
         try:
             list = self.cache[entry.key]
         except KeyError:
             list = self.cache[entry.key] = []
         list.append(entry)
 
     def remove(self, entry):
         """Removes an entry"""
         try:
             list = self.cache[entry.key]
             list.remove(entry)
         except KeyError:
             pass
 
     def get(self, entry):
         """Gets an entry by key.  Will return None if there is no
         matching entry."""
         try:
             list = self.cache[entry.key]
             return list[list.index(entry)]
         except (KeyError, ValueError):
             return None
 
     def getByDetails(self, name, type, clazz):
         """Gets an entry by details.  Will return None if there is
         no matching entry."""
         entry = DNSEntry(name, type, clazz)
         return self.get(entry)
 
     def entriesWithName(self, name):
         """Returns a list of entries whose key matches the name."""
         try:
             return self.cache[name]
         except KeyError:
             return []
 
     def entries(self):
         """Returns a list of all entries"""
         try:
             return list(itertools.chain.from_iterable(self.cache.values()))
         except Exception:
             return []
 
 
 class Engine(threading.Thread):
     """An engine wraps read access to sockets, allowing objects that
     need to receive data from sockets to be called back when the
     sockets are ready.
 
     A reader needs a handle_read() method, which is called when the socket
     it is interested in is ready for reading.
 
     Writers are not implemented here, because we only send short
     packets.
     """
 
     def __init__(self, zeroconf):
         threading.Thread.__init__(self)
         self.zeroconf = zeroconf
         self.readers = {}  # maps socket to reader
         self.timeout = 5
         self.condition = threading.Condition()
         self.start()
 
     def run(self):
         while not globals()[b'_GLOBAL_DONE']:
             rs = self.getReaders()
             if len(rs) == 0:
                 # No sockets to manage, but we wait for the timeout
                 # or addition of a socket
                 #
                 self.condition.acquire()
                 self.condition.wait(self.timeout)
                 self.condition.release()
             else:
                 try:
                     rr, wr, er = select.select(rs, [], [], self.timeout)
                     for sock in rr:
                         try:
                             self.readers[sock].handle_read()
                         except Exception:
                             if not globals()[b'_GLOBAL_DONE']:
                                 traceback.print_exc()
                 except Exception:
                     pass
 
     def getReaders(self):
         self.condition.acquire()
         result = self.readers.keys()
         self.condition.release()
         return result
 
     def addReader(self, reader, socket):
         self.condition.acquire()
         self.readers[socket] = reader
         self.condition.notify()
         self.condition.release()
 
     def delReader(self, socket):
         self.condition.acquire()
         del self.readers[socket]
         self.condition.notify()
         self.condition.release()
 
     def notify(self):
         self.condition.acquire()
         self.condition.notify()
         self.condition.release()
 
 
 class Listener:
     """A Listener is used by this module to listen on the multicast
     group to which DNS messages are sent, allowing the implementation
     to cache information as it arrives.
 
     It requires registration with an Engine object in order to have
     the read() method called when a socket is available for reading."""
 
     def __init__(self, zeroconf):
         self.zeroconf = zeroconf
         self.zeroconf.engine.addReader(self, self.zeroconf.socket)
 
     def handle_read(self):
         sock = self.zeroconf.socket
         try:
             data, (addr, port) = sock.recvfrom(_MAX_MSG_ABSOLUTE)
         except socket.error as e:
             if e.errno == errno.EBADF:
                 # some other thread may close the socket
                 return
             else:
                 raise
         self.data = data
         msg = DNSIncoming(data)
         if msg.isQuery():
             # Always multicast responses
             #
             if port == _MDNS_PORT:
                 self.zeroconf.handleQuery(msg, _MDNS_ADDR, _MDNS_PORT)
             # If it's not a multicast query, reply via unicast
             # and multicast
             #
             elif port == _DNS_PORT:
                 self.zeroconf.handleQuery(msg, addr, port)
                 self.zeroconf.handleQuery(msg, _MDNS_ADDR, _MDNS_PORT)
         else:
             self.zeroconf.handleResponse(msg)
 
 
 class Reaper(threading.Thread):
     """A Reaper is used by this module to remove cache entries that
     have expired."""
 
     def __init__(self, zeroconf):
         threading.Thread.__init__(self)
         self.zeroconf = zeroconf
         self.start()
 
     def run(self):
         while True:
             self.zeroconf.wait(10 * 1000)
             if globals()[b'_GLOBAL_DONE']:
                 return
             now = currentTimeMillis()
             for record in self.zeroconf.cache.entries():
                 if record.isExpired(now):
                     self.zeroconf.updateRecord(now, record)
                     self.zeroconf.cache.remove(record)
 
 
 class ServiceBrowser(threading.Thread):
     """Used to browse for a service of a specific type.
 
     The listener object will have its addService() and
     removeService() methods called when this browser
     discovers changes in the services availability."""
 
     def __init__(self, zeroconf, type, listener):
         """Creates a browser for a specific type"""
         threading.Thread.__init__(self)
         self.zeroconf = zeroconf
         self.type = type
         self.listener = listener
         self.services = {}
         self.nexttime = currentTimeMillis()
         self.delay = _BROWSER_TIME
         self.list = []
 
         self.done = 0
 
         self.zeroconf.addListener(
             self, DNSQuestion(self.type, _TYPE_PTR, _CLASS_IN)
         )
         self.start()
 
     def updateRecord(self, zeroconf, now, record):
         """Callback invoked by Zeroconf when new information arrives.
 
         Updates information required by browser in the Zeroconf cache."""
         if record.type == _TYPE_PTR and record.name == self.type:
             expired = record.isExpired(now)
             try:
                 oldrecord = self.services[record.alias.lower()]
                 if not expired:
                     oldrecord.resetTTL(record)
                 else:
                     del self.services[record.alias.lower()]
                     callback = lambda x: self.listener.removeService(
                         x, self.type, record.alias
                     )
                     self.list.append(callback)
                     return
             except Exception:
                 if not expired:
                     self.services[record.alias.lower()] = record
                     callback = lambda x: self.listener.addService(
                         x, self.type, record.alias
                     )
                     self.list.append(callback)
 
             expires = record.getExpirationTime(75)
             if expires < self.nexttime:
                 self.nexttime = expires
 
     def cancel(self):
         self.done = 1
         self.zeroconf.notifyAll()
 
     def run(self):
         while True:
             event = None
             now = currentTimeMillis()
             if len(self.list) == 0 and self.nexttime > now:
                 self.zeroconf.wait(self.nexttime - now)
             if globals()[b'_GLOBAL_DONE'] or self.done:
                 return
             now = currentTimeMillis()
 
             if self.nexttime <= now:
                 out = DNSOutgoing(_FLAGS_QR_QUERY)
                 out.addQuestion(DNSQuestion(self.type, _TYPE_PTR, _CLASS_IN))
                 for record in self.services.values():
                     if not record.isExpired(now):
                         out.addAnswerAtTime(record, now)
                 self.zeroconf.send(out)
                 self.nexttime = now + self.delay
                 self.delay = min(20 * 1000, self.delay * 2)
 
             if len(self.list) > 0:
                 event = self.list.pop(0)
 
             if event is not None:
                 event(self.zeroconf)
 
 
 class ServiceInfo:
     """Service information"""
 
     def __init__(
         self,
         type,
         name,
         address=None,
         port=None,
         weight=0,
         priority=0,
         properties=None,
         server=None,
     ):
         """Create a service description.
 
         type: fully qualified service type name
         name: fully qualified service name
         address: IP address as unsigned short, network byte order
         port: port that the service runs on
         weight: weight of the service
         priority: priority of the service
         properties: dictionary of properties (or a string holding the bytes for
                     the text field)
         server: fully qualified name for service host (defaults to name)"""
 
         if not name.endswith(type):
             raise BadTypeInNameException
         self.type = type
         self.name = name
         self.address = address
         self.port = port
         self.weight = weight
         self.priority = priority
         if server:
             self.server = server
         else:
             self.server = name
         self.setProperties(properties)
 
     def setProperties(self, properties):
         """Sets properties and text of this info from a dictionary"""
         if isinstance(properties, dict):
             self.properties = properties
             list = []
             result = b''
             for key in properties:
                 value = properties[key]
                 if value is None:
                     suffix = b''
                 elif isinstance(value, str):
                     suffix = value
                 elif isinstance(value, int):
                     if value:
                         suffix = b'true'
                     else:
                         suffix = b'false'
                 else:
                     suffix = b''
                 list.append(b'='.join((key, suffix)))
             for item in list:
                 result = b''.join(
                     (
                         result,
                         struct.pack(b'!c', pycompat.bytechr(len(item))),
                         item,
                     )
                 )
             self.text = result
         else:
             self.text = properties
 
     def setText(self, text):
         """Sets properties and text given a text field"""
         self.text = text
         try:
             result = {}
             end = len(text)
             index = 0
             strs = []
             while index < end:
                 length = ord(text[index])
                 index += 1
                 strs.append(text[index : index + length])
                 index += length
 
             for s in strs:
                 eindex = s.find(b'=')
                 if eindex == -1:
                     # No equals sign at all
                     key = s
                     value = 0
                 else:
                     key = s[:eindex]
                     value = s[eindex + 1 :]
                     if value == b'true':
                         value = 1
                     elif value == b'false' or not value:
                         value = 0
 
                 # Only update non-existent properties
                 if key and result.get(key) is None:
                     result[key] = value
 
             self.properties = result
         except Exception:
             traceback.print_exc()
             self.properties = None
 
     def getType(self):
         """Type accessor"""
         return self.type
 
     def getName(self):
         """Name accessor"""
         if self.type is not None and self.name.endswith(b"." + self.type):
             return self.name[: len(self.name) - len(self.type) - 1]
         return self.name
 
     def getAddress(self):
         """Address accessor"""
         return self.address
 
     def getPort(self):
         """Port accessor"""
         return self.port
 
     def getPriority(self):
         """Priority accessor"""
         return self.priority
 
     def getWeight(self):
         """Weight accessor"""
         return self.weight
 
     def getProperties(self):
         """Properties accessor"""
         return self.properties
 
     def getText(self):
         """Text accessor"""
         return self.text
 
     def getServer(self):
         """Server accessor"""
         return self.server
 
     def updateRecord(self, zeroconf, now, record):
         """Updates service information from a DNS record"""
         if record is not None and not record.isExpired(now):
             if record.type == _TYPE_A:
                 # if record.name == self.name:
                 if record.name == self.server:
                     self.address = record.address
             elif record.type == _TYPE_SRV:
                 if record.name == self.name:
                     self.server = record.server
                     self.port = record.port
                     self.weight = record.weight
                     self.priority = record.priority
                     # self.address = None
                     self.updateRecord(
                         zeroconf,
                         now,
                         zeroconf.cache.getByDetails(
                             self.server, _TYPE_A, _CLASS_IN
                         ),
                     )
             elif record.type == _TYPE_TXT:
                 if record.name == self.name:
                     self.setText(record.text)
 
     def request(self, zeroconf, timeout):
         """Returns true if the service could be discovered on the
         network, and updates this object with details discovered.
         """
         now = currentTimeMillis()
         delay = _LISTENER_TIME
         next = now + delay
         last = now + timeout
         try:
             zeroconf.addListener(
                 self, DNSQuestion(self.name, _TYPE_ANY, _CLASS_IN)
             )
             while (
                 self.server is None or self.address is None or self.text is None
             ):
                 if last <= now:
                     return 0
                 if next <= now:
                     out = DNSOutgoing(_FLAGS_QR_QUERY)
                     out.addQuestion(
                         DNSQuestion(self.name, _TYPE_SRV, _CLASS_IN)
                     )
                     out.addAnswerAtTime(
                         zeroconf.cache.getByDetails(
                             self.name, _TYPE_SRV, _CLASS_IN
                         ),
                         now,
                     )
                     out.addQuestion(
                         DNSQuestion(self.name, _TYPE_TXT, _CLASS_IN)
                     )
                     out.addAnswerAtTime(
                         zeroconf.cache.getByDetails(
                             self.name, _TYPE_TXT, _CLASS_IN
                         ),
                         now,
                     )
                     if self.server is not None:
                         out.addQuestion(
                             DNSQuestion(self.server, _TYPE_A, _CLASS_IN)
                         )
                         out.addAnswerAtTime(
                             zeroconf.cache.getByDetails(
                                 self.server, _TYPE_A, _CLASS_IN
                             ),
                             now,
                         )
                     zeroconf.send(out)
                     next = now + delay
                     delay = delay * 2
 
                 zeroconf.wait(min(next, last) - now)
                 now = currentTimeMillis()
             result = 1
         finally:
             zeroconf.removeListener(self)
 
         return result
 
     def __eq__(self, other):
         """Tests equality of service name"""
         if isinstance(other, ServiceInfo):
             return other.name == self.name
         return 0
 
     def __ne__(self, other):
         """Non-equality test"""
         return not self.__eq__(other)
 
     def __repr__(self):
         """String representation"""
         result = b"service[%s,%s:%s," % (
             self.name,
             socket.inet_ntoa(self.getAddress()),
             self.port,
         )
         if self.text is None:
             result += b"None"
         else:
             if len(self.text) < 20:
                 result += self.text
             else:
                 result += self.text[:17] + b"..."
         result += b"]"
         return result
 
 
 class Zeroconf:
     """Implementation of Zeroconf Multicast DNS Service Discovery
 
     Supports registration, unregistration, queries and browsing.
     """
 
     def __init__(self, bindaddress=None):
         """Creates an instance of the Zeroconf class, establishing
         multicast communications, listening and reaping threads."""
         globals()[b'_GLOBAL_DONE'] = 0
         if bindaddress is None:
             self.intf = socket.gethostbyname(socket.gethostname())
         else:
             self.intf = bindaddress
         self.group = (b'', _MDNS_PORT)
         self.socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
         try:
             self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
             self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
         except Exception:
             # SO_REUSEADDR should be equivalent to SO_REUSEPORT for
             # multicast UDP sockets (p 731, "TCP/IP Illustrated,
             # Volume 2"), but some BSD-derived systems require
             # SO_REUSEPORT to be specified explicitly.  Also, not all
             # versions of Python have SO_REUSEPORT available.  So
             # if you're on a BSD-based system, and haven't upgraded
             # to Python 2.3 yet, you may find this library doesn't
             # work as expected.
             #
             pass
         self.socket.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_TTL, b"\xff")
         self.socket.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_LOOP, b"\x01")
         try:
             self.socket.bind(self.group)
         except Exception:
             # Some versions of linux raise an exception even though
             # SO_REUSEADDR and SO_REUSEPORT have been set, so ignore it
             pass
         self.socket.setsockopt(
             socket.SOL_IP,
             socket.IP_ADD_MEMBERSHIP,
             socket.inet_aton(_MDNS_ADDR) + socket.inet_aton('0.0.0.0'),
         )
 
         self.listeners = []
         self.browsers = []
         self.services = {}
         self.servicetypes = {}
 
         self.cache = DNSCache()
 
         self.condition = threading.Condition()
 
         self.engine = Engine(self)
         self.listener = Listener(self)
         self.reaper = Reaper(self)
 
     def isLoopback(self):
         return self.intf.startswith(b"127.0.0.1")
 
     def isLinklocal(self):
         return self.intf.startswith(b"169.254.")
 
     def wait(self, timeout):
         """Calling thread waits for a given number of milliseconds or
         until notified."""
         self.condition.acquire()
         self.condition.wait(timeout / 1000)
         self.condition.release()
 
     def notifyAll(self):
         """Notifies all waiting threads"""
         self.condition.acquire()
         self.condition.notify_all()
         self.condition.release()
 
     def getServiceInfo(self, type, name, timeout=3000):
         """Returns network's service information for a particular
         name and type, or None if no service matches by the timeout,
         which defaults to 3 seconds."""
         info = ServiceInfo(type, name)
         if info.request(self, timeout):
             return info
         return None
 
     def addServiceListener(self, type, listener):
         """Adds a listener for a particular service type.  This object
         will then have its updateRecord method called when information
         arrives for that type."""
         self.removeServiceListener(listener)
         self.browsers.append(ServiceBrowser(self, type, listener))
 
     def removeServiceListener(self, listener):
         """Removes a listener from the set that is currently listening."""
         for browser in self.browsers:
             if browser.listener == listener:
                 browser.cancel()
                 del browser
 
     def registerService(self, info, ttl=_DNS_TTL):
         """Registers service information to the network with a default TTL
         of 60 seconds.  Zeroconf will then respond to requests for
         information for that service.  The name of the service may be
         changed if needed to make it unique on the network."""
         self.checkService(info)
         self.services[info.name.lower()] = info
         if info.type in self.servicetypes:
             self.servicetypes[info.type] += 1
         else:
             self.servicetypes[info.type] = 1
         now = currentTimeMillis()
         nexttime = now
         i = 0
         while i < 3:
             if now < nexttime:
                 self.wait(nexttime - now)
                 now = currentTimeMillis()
                 continue
             out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
             out.addAnswerAtTime(
                 DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, ttl, info.name), 0
             )
             out.addAnswerAtTime(
                 DNSService(
                     info.name,
                     _TYPE_SRV,
                     _CLASS_IN,
                     ttl,
                     info.priority,
                     info.weight,
                     info.port,
                     info.server,
                 ),
                 0,
             )
             out.addAnswerAtTime(
                 DNSText(info.name, _TYPE_TXT, _CLASS_IN, ttl, info.text), 0
             )
             if info.address:
                 out.addAnswerAtTime(
                     DNSAddress(
                         info.server, _TYPE_A, _CLASS_IN, ttl, info.address
                     ),
                     0,
                 )
             self.send(out)
             i += 1
             nexttime += _REGISTER_TIME
 
     def unregisterService(self, info):
         """Unregister a service."""
         try:
             del self.services[info.name.lower()]
             if self.servicetypes[info.type] > 1:
                 self.servicetypes[info.type] -= 1
             else:
                 del self.servicetypes[info.type]
         except KeyError:
             pass
         now = currentTimeMillis()
         nexttime = now
         i = 0
         while i < 3:
             if now < nexttime:
                 self.wait(nexttime - now)
                 now = currentTimeMillis()
                 continue
             out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
             out.addAnswerAtTime(
                 DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, 0, info.name), 0
             )
             out.addAnswerAtTime(
                 DNSService(
                     info.name,
                     _TYPE_SRV,
                     _CLASS_IN,
                     0,
                     info.priority,
                     info.weight,
                     info.port,
                     info.name,
                 ),
                 0,
             )
             out.addAnswerAtTime(
                 DNSText(info.name, _TYPE_TXT, _CLASS_IN, 0, info.text), 0
             )
             if info.address:
                 out.addAnswerAtTime(
                     DNSAddress(
                         info.server, _TYPE_A, _CLASS_IN, 0, info.address
                     ),
                     0,
                 )
             self.send(out)
             i += 1
             nexttime += _UNREGISTER_TIME
 
     def unregisterAllServices(self):
         """Unregister all registered services."""
         if len(self.services) > 0:
             now = currentTimeMillis()
             nexttime = now
             i = 0
             while i < 3:
                 if now < nexttime:
                     self.wait(nexttime - now)
                     now = currentTimeMillis()
                     continue
                 out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
                 for info in self.services.values():
                     out.addAnswerAtTime(
                         DNSPointer(
                             info.type, _TYPE_PTR, _CLASS_IN, 0, info.name
                         ),
                         0,
                     )
                     out.addAnswerAtTime(
                         DNSService(
                             info.name,
                             _TYPE_SRV,
                             _CLASS_IN,
                             0,
                             info.priority,
                             info.weight,
                             info.port,
                             info.server,
                         ),
                         0,
                     )
                     out.addAnswerAtTime(
                         DNSText(info.name, _TYPE_TXT, _CLASS_IN, 0, info.text),
                         0,
                     )
                     if info.address:
                         out.addAnswerAtTime(
                             DNSAddress(
                                 info.server, _TYPE_A, _CLASS_IN, 0, info.address
                             ),
                             0,
                         )
                 self.send(out)
                 i += 1
                 nexttime += _UNREGISTER_TIME
 
     def checkService(self, info):
         """Checks the network for a unique service name, modifying the
         ServiceInfo passed in if it is not unique."""
         now = currentTimeMillis()
         nexttime = now
         i = 0
         while i < 3:
             for record in self.cache.entriesWithName(info.type):
                 if (
                     record.type == _TYPE_PTR
                     and not record.isExpired(now)
                     and record.alias == info.name
                 ):
                     if info.name.find(b'.') < 0:
                         info.name = b"%s.[%s:%d].%s" % (
                             info.name,
                             info.address,
                             info.port,
                             info.type,
                         )
                         self.checkService(info)
                         return
                     raise NonUniqueNameException
             if now < nexttime:
                 self.wait(nexttime - now)
                 now = currentTimeMillis()
                 continue
             out = DNSOutgoing(_FLAGS_QR_QUERY | _FLAGS_AA)
             self.debug = out
             out.addQuestion(DNSQuestion(info.type, _TYPE_PTR, _CLASS_IN))
             out.addAuthoritativeAnswer(
                 DNSPointer(info.type, _TYPE_PTR, _CLASS_IN, _DNS_TTL, info.name)
             )
             self.send(out)
             i += 1
             nexttime += _CHECK_TIME
 
     def addListener(self, listener, question):
         """Adds a listener for a given question.  The listener will have
         its updateRecord method called when information is available to
         answer the question."""
         now = currentTimeMillis()
         self.listeners.append(listener)
         if question is not None:
             for record in self.cache.entriesWithName(question.name):
                 if question.answeredBy(record) and not record.isExpired(now):
                     listener.updateRecord(self, now, record)
         self.notifyAll()
 
     def removeListener(self, listener):
         """Removes a listener."""
         try:
             self.listeners.remove(listener)
             self.notifyAll()
         except Exception:
             pass
 
     def updateRecord(self, now, rec):
         """Used to notify listeners of new information that has updated
         a record."""
         for listener in self.listeners:
             listener.updateRecord(self, now, rec)
         self.notifyAll()
 
     def handleResponse(self, msg):
         """Deal with incoming response packets.  All answers
         are held in the cache, and listeners are notified."""
         now = currentTimeMillis()
         for record in msg.answers:
             expired = record.isExpired(now)
             if record in self.cache.entries():
                 if expired:
                     self.cache.remove(record)
                 else:
                     entry = self.cache.get(record)
                     if entry is not None:
                         entry.resetTTL(record)
                         record = entry
             else:
                 self.cache.add(record)
 
             self.updateRecord(now, record)
 
     def handleQuery(self, msg, addr, port):
         """Deal with incoming query packets.  Provides a response if
         possible."""
         out = None
 
         # Support unicast client responses
         #
         if port != _MDNS_PORT:
             out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA, 0)
             for question in msg.questions:
                 out.addQuestion(question)
 
         for question in msg.questions:
             if question.type == _TYPE_PTR:
                 if question.name == b"_services._dns-sd._udp.local.":
                     for stype in self.servicetypes.keys():
                         if out is None:
                             out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
                         out.addAnswer(
                             msg,
                             DNSPointer(
                                 b"_services._dns-sd._udp.local.",
                                 _TYPE_PTR,
                                 _CLASS_IN,
                                 _DNS_TTL,
                                 stype,
                             ),
                         )
                 for service in self.services.values():
                     if question.name == service.type:
                         if out is None:
                             out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
                         out.addAnswer(
                             msg,
                             DNSPointer(
                                 service.type,
                                 _TYPE_PTR,
                                 _CLASS_IN,
                                 _DNS_TTL,
                                 service.name,
                             ),
                         )
             else:
                 try:
                     if out is None:
                         out = DNSOutgoing(_FLAGS_QR_RESPONSE | _FLAGS_AA)
 
                     # Answer A record queries for any service addresses we know
                     if question.type == _TYPE_A or question.type == _TYPE_ANY:
                         for service in self.services.values():
                             if service.server == question.name.lower():
                                 out.addAnswer(
                                     msg,
                                     DNSAddress(
                                         question.name,
                                         _TYPE_A,
                                         _CLASS_IN | _CLASS_UNIQUE,
                                         _DNS_TTL,
                                         service.address,
                                     ),
                                 )
 
                     service = self.services.get(question.name.lower(), None)
                     if not service:
                         continue
 
                     if question.type == _TYPE_SRV or question.type == _TYPE_ANY:
                         out.addAnswer(
                             msg,
                             DNSService(
                                 question.name,
                                 _TYPE_SRV,
                                 _CLASS_IN | _CLASS_UNIQUE,
                                 _DNS_TTL,
                                 service.priority,
                                 service.weight,
                                 service.port,
                                 service.server,
                             ),
                         )
                     if question.type == _TYPE_TXT or question.type == _TYPE_ANY:
                         out.addAnswer(
                             msg,
                             DNSText(
                                 question.name,
                                 _TYPE_TXT,
                                 _CLASS_IN | _CLASS_UNIQUE,
                                 _DNS_TTL,
                                 service.text,
                             ),
                         )
                     if question.type == _TYPE_SRV:
                         out.addAdditionalAnswer(
                             DNSAddress(
                                 service.server,
                                 _TYPE_A,
                                 _CLASS_IN | _CLASS_UNIQUE,
                                 _DNS_TTL,
                                 service.address,
                             )
                         )
                 except Exception:
                     traceback.print_exc()
 
         if out is not None and out.answers:
             out.id = msg.id
             self.send(out, addr, port)
 
     def send(self, out, addr=_MDNS_ADDR, port=_MDNS_PORT):
         """Sends an outgoing packet."""
         # This is a quick test to see if we can parse the packets we generate
         # temp = DNSIncoming(out.packet())
         try:
             self.socket.sendto(out.packet(), 0, (addr, port))
         except Exception:
             # Ignore this, it may be a temporary loss of network connection
             pass
 
     def close(self):
         """Ends the background threads, and prevent this instance from
         servicing further queries."""
         if globals()[b'_GLOBAL_DONE'] == 0:
             globals()[b'_GLOBAL_DONE'] = 1
             self.notifyAll()
             self.engine.notify()
             self.unregisterAllServices()
             self.socket.setsockopt(
                 socket.SOL_IP,
                 socket.IP_DROP_MEMBERSHIP,
                 socket.inet_aton(_MDNS_ADDR) + socket.inet_aton('0.0.0.0'),
             )
             self.socket.close()
 
 
 # Test a few module features, including service registration, service
 # query (for Zoe), and service unregistration.
 
 if __name__ == '__main__':
     print(b"Multicast DNS Service Discovery for Python, version", __version__)
     r = Zeroconf()
     print(b"1. Testing registration of a service...")
     desc = {b'version': b'0.10', b'a': b'test value', b'b': b'another value'}
     info = ServiceInfo(
         b"_http._tcp.local.",
         b"My Service Name._http._tcp.local.",
         socket.inet_aton("127.0.0.1"),
         1234,
         0,
         0,
         desc,
     )
     print(b"   Registering service...")
     r.registerService(info)
     print(b"   Registration done.")
     print(b"2. Testing query of service information...")
     print(
         b"   Getting ZOE service:",
         str(r.getServiceInfo(b"_http._tcp.local.", b"ZOE._http._tcp.local.")),
     )
     print(b"   Query done.")
     print(b"3. Testing query of own service...")
     print(
         b"   Getting self:",
         str(
             r.getServiceInfo(
                 b"_http._tcp.local.", b"My Service Name._http._tcp.local."
             )
         ),
     )
     print(b"   Query done.")
     print(b"4. Testing unregister of service information...")
     r.unregisterService(info)
     print(b"   Unregister done.")
     r.close()

mercurial/hgweb/hgweb_mod.py

@@ -1,525 +1,525 b''
 # hgweb/hgweb_mod.py - Web interface for a repository.
 #
 # Copyright 21 May 2005 - (c) 2005 Jake Edge <[e-mail]>
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import contextlib
 import os
 
 from .common import (
     ErrorResponse,
     HTTP_BAD_REQUEST,
     cspvalues,
     permhooks,
     statusmessage,
 )
 
 from .. import (
     encoding,
     error,
     extensions,
     formatter,
     hg,
     hook,
     profiling,
     pycompat,
     registrar,
     repoview,
     templatefilters,
     templater,
     templateutil,
     ui as uimod,
     wireprotoserver,
 )
 
 from . import (
     common,
     request as requestmod,
     webcommands,
     webutil,
     wsgicgi,
 )
 
 
 def getstyle(req, configfn, templatepath):
     styles = (
         req.qsparams.get(b'style', None),
         configfn(b'web', b'style'),
         b'paper',
     )
     return styles, _stylemap(styles, templatepath)
 
 
 def _stylemap(styles, path=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
     """
 
     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, b'map')
 
         for location in locations:
             mapfile, fp = templater.try_open_template(location, path)
             if mapfile:
                 return style, mapfile, fp
 
     raise RuntimeError(b"No hgweb templates found in %r" % path)
 
 
 def makebreadcrumb(url, prefix=b''):
     """Return a 'URL breadcrumb' list
 
     A 'URL breadcrumb' is a list of URL-name pairs,
     corresponding to each of the path items on a URL.
     This can be used to create path navigation entries.
     """
     if url.endswith(b'/'):
         url = url[:-1]
     if prefix:
         url = b'/' + prefix + url
     relpath = url
     if relpath.startswith(b'/'):
         relpath = relpath[1:]
 
     breadcrumb = []
     urlel = url
     pathitems = [b''] + relpath.split(b'/')
     for pathel in reversed(pathitems):
         if not pathel or not urlel:
             break
         breadcrumb.append({b'url': urlel, b'name': pathel})
         urlel = os.path.dirname(urlel)
     return templateutil.mappinglist(reversed(breadcrumb))
 
 
 class requestcontext:
     """Holds state/context for an individual request.
 
     Servers can be multi-threaded. Holding state on the WSGI application
     is prone to race conditions. Instances of this class exist to hold
     mutable and race-free state for requests.
     """
 
     def __init__(self, app, repo, req, res):
         self.repo = repo
         self.reponame = app.reponame
         self.req = req
         self.res = res
 
         # Only works if the filter actually support being upgraded to show
         # visible changesets
         current_filter = repo.filtername
         if (
             common.hashiddenaccess(repo, req)
             and current_filter is not None
             and current_filter + b'.hidden' in repoview.filtertable
         ):
             self.repo = self.repo.filtered(repo.filtername + b'.hidden')
 
         self.maxchanges = self.configint(b'web', b'maxchanges')
         self.stripecount = self.configint(b'web', b'stripes')
         self.maxshortchanges = self.configint(b'web', b'maxshortchanges')
         self.maxfiles = self.configint(b'web', b'maxfiles')
         self.allowpull = self.configbool(b'web', b'allow-pull')
 
         # we use untrusted=False to prevent a repo owner from using
         # web.templates in .hg/hgrc to get access to any file readable
         # by the user running the CGI script
         self.templatepath = self.config(b'web', b'templates', untrusted=False)
 
         # This object is more expensive to build than simple config values.
         # It is shared across requests. The app will replace the object
         # if it is updated. Since this is a reference and nothing should
         # modify the underlying object, it should be constant for the lifetime
         # of the request.
         self.websubtable = app.websubtable
 
         self.csp, self.nonce = cspvalues(self.repo.ui)
 
     # Trust the settings from the .hg/hgrc files by default.
     def config(self, *args, **kwargs):
         kwargs.setdefault('untrusted', True)
         return self.repo.ui.config(*args, **kwargs)
 
     def configbool(self, *args, **kwargs):
         kwargs.setdefault('untrusted', True)
         return self.repo.ui.configbool(*args, **kwargs)
 
     def configint(self, *args, **kwargs):
         kwargs.setdefault('untrusted', True)
         return self.repo.ui.configint(*args, **kwargs)
 
     def configlist(self, *args, **kwargs):
         kwargs.setdefault('untrusted', True)
         return self.repo.ui.configlist(*args, **kwargs)
 
     def archivelist(self, nodeid):
         return webutil.archivelist(self.repo.ui, nodeid)
 
     def templater(self, req):
         # determine scheme, port and server name
         # this is needed to create absolute urls
         logourl = self.config(b'web', b'logourl')
         logoimg = self.config(b'web', b'logoimg')
         staticurl = (
             self.config(b'web', b'staticurl')
             or req.apppath.rstrip(b'/') + b'/static/'
         )
         if not staticurl.endswith(b'/'):
             staticurl += b'/'
 
         # figure out which style to use
 
         vars = {}
         styles, (style, mapfile, fp) = getstyle(
             req, self.config, self.templatepath
         )
         if style == styles[0]:
             vars[b'style'] = style
 
         sessionvars = webutil.sessionvars(vars, b'?')
 
         if not self.reponame:
             self.reponame = (
                 self.config(b'web', b'name', b'')
                 or req.reponame
                 or req.apppath
                 or self.repo.root
             )
 
         filters = {}
         templatefilter = registrar.templatefilter(filters)
 
         @templatefilter(b'websub', intype=bytes)
         def websubfilter(text):
             return templatefilters.websub(text, self.websubtable)
 
         # create the templater
         # TODO: export all keywords: defaults = templatekw.keywords.copy()
         defaults = {
             b'url': req.apppath + b'/',
             b'logourl': logourl,
             b'logoimg': logoimg,
             b'staticurl': staticurl,
             b'urlbase': req.advertisedbaseurl,
             b'repo': self.reponame,
             b'encoding': encoding.encoding,
             b'sessionvars': sessionvars,
             b'pathdef': makebreadcrumb(req.apppath),
             b'style': style,
             b'nonce': self.nonce,
         }
         templatekeyword = registrar.templatekeyword(defaults)
 
         @templatekeyword(b'motd', requires=())
         def motd(context, mapping):
             yield self.config(b'web', b'motd')
 
         tres = formatter.templateresources(self.repo.ui, self.repo)
         return templater.templater.frommapfile(
             mapfile, fp=fp, filters=filters, defaults=defaults, resources=tres
         )
 
     def sendtemplate(self, name, **kwargs):
         """Helper function to send a response generated from a template."""
         if self.req.method != b'HEAD':
             kwargs = pycompat.byteskwargs(kwargs)
             self.res.setbodygen(self.tmpl.generate(name, kwargs))
         return self.res.sendresponse()
 
 
 class hgweb:
     """HTTP server for individual repositories.
 
     Instances of this class serve HTTP responses for a particular
     repository.
 
     Instances are typically used as WSGI applications.
 
     Some servers are multi-threaded. On these servers, there may
     be multiple active threads inside __call__.
     """
 
     def __init__(self, repo, name=None, baseui=None):
         if isinstance(repo, bytes):
             if baseui:
                 u = baseui.copy()
             else:
                 u = uimod.ui.load()
                 extensions.loadall(u)
                 extensions.populateui(u)
             r = hg.repository(u, repo)
         else:
             # we trust caller to give us a private copy
             r = repo
 
         r.ui.setconfig(b'ui', b'report_untrusted', b'off', b'hgweb')
         r.baseui.setconfig(b'ui', b'report_untrusted', b'off', b'hgweb')
         r.ui.setconfig(b'ui', b'nontty', b'true', b'hgweb')
         r.baseui.setconfig(b'ui', b'nontty', b'true', b'hgweb')
         # resolve file patterns relative to repo root
         r.ui.setconfig(b'ui', b'forcecwd', r.root, b'hgweb')
         r.baseui.setconfig(b'ui', b'forcecwd', r.root, b'hgweb')
         # it's unlikely that we can replace signal handlers in WSGI server,
         # and mod_wsgi issues a big warning. a plain hgweb process (with no
         # threading) could replace signal handlers, but we don't bother
         # conditionally enabling it.
         r.ui.setconfig(b'ui', b'signal-safe-lock', b'false', b'hgweb')
         r.baseui.setconfig(b'ui', b'signal-safe-lock', b'false', b'hgweb')
         # displaying bundling progress bar while serving feel wrong and may
         # break some wsgi implementation.
         r.ui.setconfig(b'progress', b'disable', b'true', b'hgweb')
         r.baseui.setconfig(b'progress', b'disable', b'true', b'hgweb')
         self._repos = [hg.cachedlocalrepo(self._webifyrepo(r))]
         self._lastrepo = self._repos[0]
         hook.redirect(True)
         self.reponame = name
 
     def _webifyrepo(self, repo):
         repo = getwebview(repo)
         self.websubtable = webutil.getwebsubs(repo)
         return repo
 
     @contextlib.contextmanager
     def _obtainrepo(self):
         """Obtain a repo unique to the caller.
 
         Internally we maintain a stack of cachedlocalrepo instances
         to be handed out. If one is available, we pop it and return it,
         ensuring it is up to date in the process. If one is not available,
         we clone the most recently used repo instance and return it.
 
         It is currently possible for the stack to grow without bounds
         if the server allows infinite threads. However, servers should
         have a thread limit, thus establishing our limit.
         """
         if self._repos:
             cached = self._repos.pop()
             r, created = cached.fetch()
         else:
             cached = self._lastrepo.copy()
             r, created = cached.fetch()
         if created:
             r = self._webifyrepo(r)
 
         self._lastrepo = cached
         self.mtime = cached.mtime
         try:
             yield r
         finally:
             self._repos.append(cached)
 
     def run(self):
         """Start a server from CGI environment.
 
         Modern servers should be using WSGI and should avoid this
         method, if possible.
         """
         if not encoding.environ.get(b'GATEWAY_INTERFACE', b'').startswith(
             b"CGI/1."
         ):
             raise RuntimeError(
                 b"This function is only intended to be "
                 b"called while running as a CGI script."
             )
         wsgicgi.launch(self)
 
     def __call__(self, env, respond):
         """Run the WSGI application.
 
         This may be called by multiple threads.
         """
         req = requestmod.parserequestfromenv(env)
         res = requestmod.wsgiresponse(req, respond)
 
         return self.run_wsgi(req, res)
 
     def run_wsgi(self, req, res):
         """Internal method to run the WSGI application.
 
         This is typically only called by Mercurial. External consumers
         should be using instances of this class as the WSGI application.
         """
         with self._obtainrepo() as repo:
             profile = repo.ui.configbool(b'profiling', b'enabled')
             with profiling.profile(repo.ui, enabled=profile):
                 for r in self._runwsgi(req, res, repo):
                     yield r
 
     def _runwsgi(self, req, res, repo):
         rctx = requestcontext(self, repo, req, res)
 
         # This state is global across all threads.
         encoding.encoding = rctx.config(b'web', b'encoding')
         rctx.repo.ui.environ = req.rawenv
 
         if rctx.csp:
             # hgwebdir may have added CSP header. Since we generate our own,
             # replace it.
             res.headers[b'Content-Security-Policy'] = rctx.csp
 
         handled = wireprotoserver.handlewsgirequest(
             rctx, req, res, self.check_perm
         )
         if handled:
             return res.sendresponse()
 
         # Old implementations of hgweb supported dispatching the request via
         # the initial query string parameter instead of using PATH_INFO.
         # If PATH_INFO is present (signaled by ``req.dispatchpath`` having
         # a value), we use it. Otherwise fall back to the query string.
         if req.dispatchpath is not None:
             query = req.dispatchpath
         else:
             query = req.querystring.partition(b'&')[0].partition(b';')[0]
 
         # translate user-visible url structure to internal structure
 
         args = query.split(b'/', 2)
         if b'cmd' not in req.qsparams and args and args[0]:
             cmd = args.pop(0)
             style = cmd.rfind(b'-')
             if style != -1:
                 req.qsparams[b'style'] = cmd[:style]
                 cmd = cmd[style + 1 :]
 
             # avoid accepting e.g. style parameter as command
             if hasattr(webcommands, pycompat.sysstr(cmd)):
                 req.qsparams[b'cmd'] = cmd
 
             if cmd == b'static':
                 req.qsparams[b'file'] = b'/'.join(args)
             else:
                 if args and args[0]:
                     node = args.pop(0).replace(b'%2F', b'/')
                     req.qsparams[b'node'] = node
                 if args:
                     if b'file' in req.qsparams:
                         del req.qsparams[b'file']
                     for a in args:
                         req.qsparams.add(b'file', a)
 
             ua = req.headers.get(b'User-Agent', b'')
             if cmd == b'rev' and b'mercurial' in ua:
                 req.qsparams[b'style'] = b'raw'
 
             if cmd == b'archive':
                 fn = req.qsparams[b'node']
                 for type_, spec in webutil.archivespecs.items():
                     ext = spec[2]
                     if fn.endswith(ext):
                         req.qsparams[b'node'] = fn[: -len(ext)]
                         req.qsparams[b'type'] = type_
         else:
             cmd = req.qsparams.get(b'cmd', b'')
 
         # process the web interface request
 
         try:
             rctx.tmpl = rctx.templater(req)
             ctype = rctx.tmpl.render(
                 b'mimetype', {b'encoding': encoding.encoding}
             )
 
             # check read permissions non-static content
             if cmd != b'static':
                 self.check_perm(rctx, req, None)
 
             if cmd == b'':
                 req.qsparams[b'cmd'] = rctx.tmpl.render(b'default', {})
                 cmd = req.qsparams[b'cmd']
 
             # Don't enable caching if using a CSP nonce because then it wouldn't
             # be a nonce.
             if rctx.configbool(b'web', b'cache') and not rctx.nonce:
                 tag = b'W/"%d"' % self.mtime
                 if req.headers.get(b'If-None-Match') == tag:
                     res.status = b'304 Not Modified'
                     # Content-Type may be defined globally. It isn't valid on a
                     # 304, so discard it.
                     try:
                         del res.headers[b'Content-Type']
                     except KeyError:
                         pass
                     # Response body not allowed on 304.
                     res.setbodybytes(b'')
                     return res.sendresponse()
 
                 res.headers[b'ETag'] = tag
 
-            if cmd not in webcommands.__all__:
+            if pycompat.sysstr(cmd) not in webcommands.__all__:
                 msg = b'no such method: %s' % cmd
                 raise ErrorResponse(HTTP_BAD_REQUEST, msg)
             else:
                 # Set some globals appropriate for web handlers. Commands can
                 # override easily enough.
                 res.status = b'200 Script output follows'
                 res.headers[b'Content-Type'] = ctype
                 return getattr(webcommands, pycompat.sysstr(cmd))(rctx)
 
         except (error.LookupError, error.RepoLookupError) as err:
             msg = pycompat.bytestr(err)
             if hasattr(err, 'name') and not isinstance(
                 err, error.ManifestLookupError
             ):
                 msg = b'revision not found: %s' % err.name
 
             res.status = b'404 Not Found'
             res.headers[b'Content-Type'] = ctype
             return rctx.sendtemplate(b'error', error=msg)
         except (error.RepoError, error.StorageError) as e:
             res.status = b'500 Internal Server Error'
             res.headers[b'Content-Type'] = ctype
             return rctx.sendtemplate(b'error', error=pycompat.bytestr(e))
         except error.Abort as e:
             res.status = b'403 Forbidden'
             res.headers[b'Content-Type'] = ctype
             return rctx.sendtemplate(b'error', error=e.message)
         except ErrorResponse as e:
             for k, v in e.headers:
                 res.headers[k] = v
             res.status = statusmessage(e.code, pycompat.bytestr(e))
             res.headers[b'Content-Type'] = ctype
             return rctx.sendtemplate(b'error', error=pycompat.bytestr(e))
 
     def check_perm(self, rctx, req, op):
         for permhook in permhooks:
             permhook(rctx, req, op)
 
 
 def getwebview(repo):
     """The 'web.view' config controls changeset filter to hgweb. Possible
     values are ``served``, ``visible`` and ``all``. Default is ``served``.
     The ``served`` filter only shows changesets that can be pulled from the
     hgweb instance.  The``visible`` filter includes secret changesets but
     still excludes "hidden" one.
 
     See the repoview module for details.
 
     The option has been around undocumented since Mercurial 2.5, but no
     user ever asked about it. So we better keep it undocumented for now."""
     # experimental config: web.view
     viewconfig = repo.ui.config(b'web', b'view', untrusted=True)
     if viewconfig == b'all':
         return repo.unfiltered()
     elif viewconfig in repoview.filtertable:
         return repo.filtered(viewconfig)
     else:
         return repo.filtered(b'served')

mercurial/hgweb/webcommands.py

@@ -1,1597 +1,1597 b''
 #
 # Copyright 21 May 2005 - (c) 2005 Jake Edge <[e-mail]>
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import copy
 import mimetypes
 import os
 import re
 
 from ..i18n import _
 from ..node import hex, short
 
 from .common import (
     ErrorResponse,
     HTTP_FORBIDDEN,
     HTTP_NOT_FOUND,
     get_contact,
     paritygen,
     staticfile,
 )
 
 from .. import (
     archival,
     dagop,
     encoding,
     error,
     graphmod,
     pycompat,
     revset,
     revsetlang,
     scmutil,
     smartset,
     templateutil,
 )
 
 from ..utils import stringutil
 
 from . import webutil
 
 __all__ = []
 commands = {}
 
 
 class webcommand:
     """Decorator used to register a web command handler.
 
     The decorator takes as its positional arguments the name/path the
     command should be accessible under.
 
     When called, functions receive as arguments a ``requestcontext``,
     ``wsgirequest``, and a templater instance for generatoring output.
     The functions should populate the ``rctx.res`` object with details
     about the HTTP response.
 
     The function returns a generator to be consumed by the WSGI application.
     For most commands, this should be the result from
     ``web.res.sendresponse()``. Many commands will call ``web.sendtemplate()``
     to render a template.
 
     Usage:
 
     @webcommand('mycommand')
     def mycommand(web):
         pass
     """
 
     def __init__(self, name):
         self.name = name
 
     def __call__(self, func):
-        __all__.append(self.name)
+        __all__.append(pycompat.sysstr(self.name))
         commands[self.name] = func
         return func
 
 
 @webcommand(b'log')
 def log(web):
     """
     /log[/{revision}[/{path}]]
     --------------------------
 
     Show repository or file history.
 
     For URLs of the form ``/log/{revision}``, a list of changesets starting at
     the specified changeset identifier is shown. If ``{revision}`` is not
     defined, the default is ``tip``. This form is equivalent to the
     ``changelog`` handler.
 
     For URLs of the form ``/log/{revision}/{file}``, the history for a specific
     file will be shown. This form is equivalent to the ``filelog`` handler.
     """
 
     if web.req.qsparams.get(b'file'):
         return filelog(web)
     else:
         return changelog(web)
 
 
 @webcommand(b'rawfile')
 def rawfile(web):
     guessmime = web.configbool(b'web', b'guessmime')
 
     path = webutil.cleanpath(web.repo, web.req.qsparams.get(b'file', b''))
     if not path:
         return manifest(web)
 
     try:
         fctx = webutil.filectx(web.repo, web.req)
     except error.LookupError as inst:
         try:
             return manifest(web)
         except ErrorResponse:
             raise inst
 
     path = fctx.path()
     text = fctx.data()
     mt = b'application/binary'
     if guessmime:
         mt = mimetypes.guess_type(pycompat.fsdecode(path))[0]
         if mt is None:
             if stringutil.binary(text):
                 mt = b'application/binary'
             else:
                 mt = b'text/plain'
         else:
             mt = pycompat.sysbytes(mt)
 
     if mt.startswith(b'text/'):
         mt += b'; charset="%s"' % encoding.encoding
 
     web.res.headers[b'Content-Type'] = mt
     filename = (
         path.rpartition(b'/')[-1].replace(b'\\', b'\\\\').replace(b'"', b'\\"')
     )
     web.res.headers[b'Content-Disposition'] = (
         b'inline; filename="%s"' % filename
     )
     web.res.setbodybytes(text)
     return web.res.sendresponse()
 
 
 def _filerevision(web, fctx):
     f = fctx.path()
     text = fctx.data()
     parity = paritygen(web.stripecount)
     ishead = fctx.filenode() in fctx.filelog().heads()
 
     if stringutil.binary(text):
         mt = pycompat.sysbytes(
             mimetypes.guess_type(pycompat.fsdecode(f))[0]
             or r'application/octet-stream'
         )
         text = b'(binary:%s)' % mt
 
     def lines(context):
         for lineno, t in enumerate(text.splitlines(True)):
             yield {
                 b"line": t,
                 b"lineid": b"l%d" % (lineno + 1),
                 b"linenumber": b"% 6d" % (lineno + 1),
                 b"parity": next(parity),
             }
 
     return web.sendtemplate(
         b'filerevision',
         file=f,
         path=webutil.up(f),
         text=templateutil.mappinggenerator(lines),
         symrev=webutil.symrevorshortnode(web.req, fctx),
         rename=webutil.renamelink(fctx),
         permissions=fctx.manifest().flags(f),
         ishead=int(ishead),
         **pycompat.strkwargs(webutil.commonentry(web.repo, fctx))
     )
 
 
 @webcommand(b'file')
 def file(web):
     """
     /file/{revision}[/{path}]
     -------------------------
 
     Show information about a directory or file in the repository.
 
     Info about the ``path`` given as a URL parameter will be rendered.
 
     If ``path`` is a directory, information about the entries in that
     directory will be rendered. This form is equivalent to the ``manifest``
     handler.
 
     If ``path`` is a file, information about that file will be shown via
     the ``filerevision`` template.
 
     If ``path`` is not defined, information about the root directory will
     be rendered.
     """
     if web.req.qsparams.get(b'style') == b'raw':
         return rawfile(web)
 
     path = webutil.cleanpath(web.repo, web.req.qsparams.get(b'file', b''))
     if not path:
         return manifest(web)
     try:
         return _filerevision(web, webutil.filectx(web.repo, web.req))
     except error.LookupError as inst:
         try:
             return manifest(web)
         except ErrorResponse:
             raise inst
 
 
 def _search(web):
     MODE_REVISION = b'rev'
     MODE_KEYWORD = b'keyword'
     MODE_REVSET = b'revset'
 
     def revsearch(ctx):
         yield ctx
 
     def keywordsearch(query):
         lower = encoding.lower
         qw = lower(query).split()
 
         def revgen():
             cl = web.repo.changelog
             for i in range(len(web.repo) - 1, 0, -100):
                 l = []
                 for j in cl.revs(max(0, i - 99), i):
                     ctx = web.repo[j]
                     l.append(ctx)
                 l.reverse()
                 for e in l:
                     yield e
 
         for ctx in revgen():
             miss = 0
             for q in qw:
                 if not (
                     q in lower(ctx.user())
                     or q in lower(ctx.description())
                     or q in lower(b" ".join(ctx.files()))
                 ):
                     miss = 1
                     break
             if miss:
                 continue
 
             yield ctx
 
     def revsetsearch(revs):
         for r in revs:
             yield web.repo[r]
 
     searchfuncs = {
         MODE_REVISION: (revsearch, b'exact revision search'),
         MODE_KEYWORD: (keywordsearch, b'literal keyword search'),
         MODE_REVSET: (revsetsearch, b'revset expression search'),
     }
 
     def getsearchmode(query):
         try:
             ctx = scmutil.revsymbol(web.repo, query)
         except (error.RepoError, error.LookupError):
             # query is not an exact revision pointer, need to
             # decide if it's a revset expression or keywords
             pass
         else:
             return MODE_REVISION, ctx
 
         revdef = b'reverse(%s)' % query
         try:
             tree = revsetlang.parse(revdef)
         except error.ParseError:
             # can't parse to a revset tree
             return MODE_KEYWORD, query
 
         if revsetlang.depth(tree) <= 2:
             # no revset syntax used
             return MODE_KEYWORD, query
 
         if any(
             (token, (value or b'')[:3]) == (b'string', b're:')
             for token, value, pos in revsetlang.tokenize(revdef)
         ):
             return MODE_KEYWORD, query
 
         funcsused = revsetlang.funcsused(tree)
         if not funcsused.issubset(revset.safesymbols):
             return MODE_KEYWORD, query
 
         try:
             mfunc = revset.match(
                 web.repo.ui, revdef, lookup=revset.lookupfn(web.repo)
             )
             revs = mfunc(web.repo)
             return MODE_REVSET, revs
             # ParseError: wrongly placed tokens, wrongs arguments, etc
             # RepoLookupError: no such revision, e.g. in 'revision:'
             # Abort: bookmark/tag not exists
             # LookupError: ambiguous identifier, e.g. in '(bc)' on a large repo
         except (
             error.ParseError,
             error.RepoLookupError,
             error.Abort,
             LookupError,
         ):
             return MODE_KEYWORD, query
 
     def changelist(context):
         count = 0
 
         for ctx in searchfunc[0](funcarg):
             count += 1
             n = scmutil.binnode(ctx)
             showtags = webutil.showtag(web.repo, b'changelogtag', n)
             files = webutil.listfilediffs(ctx.files(), n, web.maxfiles)
 
             lm = webutil.commonentry(web.repo, ctx)
             lm.update(
                 {
                     b'parity': next(parity),
                     b'changelogtag': showtags,
                     b'files': files,
                 }
             )
             yield lm
 
             if count >= revcount:
                 break
 
     query = web.req.qsparams[b'rev']
     revcount = web.maxchanges
     if b'revcount' in web.req.qsparams:
         try:
             revcount = int(web.req.qsparams.get(b'revcount', revcount))
             revcount = max(revcount, 1)
             web.tmpl.defaults[b'sessionvars'][b'revcount'] = revcount
         except ValueError:
             pass
 
     lessvars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     lessvars[b'revcount'] = max(revcount // 2, 1)
     lessvars[b'rev'] = query
     morevars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     morevars[b'revcount'] = revcount * 2
     morevars[b'rev'] = query
 
     mode, funcarg = getsearchmode(query)
 
     if b'forcekw' in web.req.qsparams:
         showforcekw = b''
         showunforcekw = searchfuncs[mode][1]
         mode = MODE_KEYWORD
         funcarg = query
     else:
         if mode != MODE_KEYWORD:
             showforcekw = searchfuncs[MODE_KEYWORD][1]
         else:
             showforcekw = b''
         showunforcekw = b''
 
     searchfunc = searchfuncs[mode]
 
     tip = web.repo[b'tip']
     parity = paritygen(web.stripecount)
 
     return web.sendtemplate(
         b'search',
         query=query,
         node=tip.hex(),
         symrev=b'tip',
         entries=templateutil.mappinggenerator(changelist, name=b'searchentry'),
         archives=web.archivelist(b'tip'),
         morevars=morevars,
         lessvars=lessvars,
         modedesc=searchfunc[1],
         showforcekw=showforcekw,
         showunforcekw=showunforcekw,
     )
 
 
 @webcommand(b'changelog')
 def changelog(web, shortlog=False):
     """
     /changelog[/{revision}]
     -----------------------
 
     Show information about multiple changesets.
 
     If the optional ``revision`` URL argument is absent, information about
     all changesets starting at ``tip`` will be rendered. If the ``revision``
     argument is present, changesets will be shown starting from the specified
     revision.
 
     If ``revision`` is absent, the ``rev`` query string argument may be
     defined. This will perform a search for changesets.
 
     The argument for ``rev`` can be a single revision, a revision set,
     or a literal keyword to search for in changeset data (equivalent to
     :hg:`log -k`).
 
     The ``revcount`` query string argument defines the maximum numbers of
     changesets to render.
 
     For non-searches, the ``changelog`` template will be rendered.
     """
 
     query = b''
     if b'node' in web.req.qsparams:
         ctx = webutil.changectx(web.repo, web.req)
         symrev = webutil.symrevorshortnode(web.req, ctx)
     elif b'rev' in web.req.qsparams:
         return _search(web)
     else:
         ctx = web.repo[b'tip']
         symrev = b'tip'
 
     def changelist(maxcount):
         revs = []
         if pos != -1:
             revs = web.repo.changelog.revs(pos, 0)
 
         for entry in webutil.changelistentries(web, revs, maxcount, parity):
             yield entry
 
     if shortlog:
         revcount = web.maxshortchanges
     else:
         revcount = web.maxchanges
 
     if b'revcount' in web.req.qsparams:
         try:
             revcount = int(web.req.qsparams.get(b'revcount', revcount))
             revcount = max(revcount, 1)
             web.tmpl.defaults[b'sessionvars'][b'revcount'] = revcount
         except ValueError:
             pass
 
     lessvars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     lessvars[b'revcount'] = max(revcount // 2, 1)
     morevars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     morevars[b'revcount'] = revcount * 2
 
     count = len(web.repo)
     pos = ctx.rev()
     parity = paritygen(web.stripecount)
 
     changenav = webutil.revnav(web.repo).gen(pos, revcount, count)
 
     entries = list(changelist(revcount + 1))
     latestentry = entries[:1]
     if len(entries) > revcount:
         nextentry = entries[-1:]
         entries = entries[:-1]
     else:
         nextentry = []
 
     return web.sendtemplate(
         b'shortlog' if shortlog else b'changelog',
         changenav=changenav,
         node=ctx.hex(),
         rev=pos,
         symrev=symrev,
         changesets=count,
         entries=templateutil.mappinglist(entries),
         latestentry=templateutil.mappinglist(latestentry),
         nextentry=templateutil.mappinglist(nextentry),
         archives=web.archivelist(b'tip'),
         revcount=revcount,
         morevars=morevars,
         lessvars=lessvars,
         query=query,
     )
 
 
 @webcommand(b'shortlog')
 def shortlog(web):
     """
     /shortlog
     ---------
 
     Show basic information about a set of changesets.
 
     This accepts the same parameters as the ``changelog`` handler. The only
     difference is the ``shortlog`` template will be rendered instead of the
     ``changelog`` template.
     """
     return changelog(web, shortlog=True)
 
 
 @webcommand(b'changeset')
 def changeset(web):
     """
     /changeset[/{revision}]
     -----------------------
 
     Show information about a single changeset.
 
     A URL path argument is the changeset identifier to show. See ``hg help
     revisions`` for possible values. If not defined, the ``tip`` changeset
     will be shown.
 
     The ``changeset`` template is rendered. Contents of the ``changesettag``,
     ``changesetbookmark``, ``filenodelink``, ``filenolink``, and the many
     templates related to diffs may all be used to produce the output.
     """
     ctx = webutil.changectx(web.repo, web.req)
 
     return web.sendtemplate(b'changeset', **webutil.changesetentry(web, ctx))
 
 
 rev = webcommand(b'rev')(changeset)
 
 
 def decodepath(path: bytes) -> bytes:
     """Hook for mapping a path in the repository to a path in the
     working copy.
 
     Extensions (e.g., largefiles) can override this to remap files in
     the virtual file system presented by the manifest command below."""
     return path
 
 
 @webcommand(b'manifest')
 def manifest(web):
     """
     /manifest[/{revision}[/{path}]]
     -------------------------------
 
     Show information about a directory.
 
     If the URL path arguments are omitted, information about the root
     directory for the ``tip`` changeset will be shown.
 
     Because this handler can only show information for directories, it
     is recommended to use the ``file`` handler instead, as it can handle both
     directories and files.
 
     The ``manifest`` template will be rendered for this handler.
     """
     if b'node' in web.req.qsparams:
         ctx = webutil.changectx(web.repo, web.req)
         symrev = webutil.symrevorshortnode(web.req, ctx)
     else:
         ctx = web.repo[b'tip']
         symrev = b'tip'
     path = webutil.cleanpath(web.repo, web.req.qsparams.get(b'file', b''))
     mf = ctx.manifest()
     node = scmutil.binnode(ctx)
 
     files = {}
     dirs = {}
     parity = paritygen(web.stripecount)
 
     if path and path[-1:] != b"/":
         path += b"/"
     l = len(path)
     abspath = b"/" + path
 
     for full, n in mf.items():
         # the virtual path (working copy path) used for the full
         # (repository) path
         f = decodepath(full)
 
         if f[:l] != path:
             continue
         remain = f[l:]
         elements = remain.split(b'/')
         if len(elements) == 1:
             files[remain] = full
         else:
             h = dirs  # need to retain ref to dirs (root)
             for elem in elements[0:-1]:
                 if elem not in h:
                     h[elem] = {}
                 h = h[elem]
                 if len(h) > 1:
                     break
             h[None] = None  # denotes files present
 
     if mf and not files and not dirs:
         raise ErrorResponse(HTTP_NOT_FOUND, b'path not found: ' + path)
 
     def filelist(context):
         for f in sorted(files):
             full = files[f]
 
             fctx = ctx.filectx(full)
             yield {
                 b"file": full,
                 b"parity": next(parity),
                 b"basename": f,
                 b"date": fctx.date(),
                 b"size": fctx.size(),
                 b"permissions": mf.flags(full),
             }
 
     def dirlist(context):
         for d in sorted(dirs):
 
             emptydirs = []
             h = dirs[d]
             while isinstance(h, dict) and len(h) == 1:
                 k, v = next(iter(h.items()))
                 if v:
                     emptydirs.append(k)
                 h = v
 
             path = b"%s%s" % (abspath, d)
             yield {
                 b"parity": next(parity),
                 b"path": path,
                 # pytype: disable=wrong-arg-types
                 b"emptydirs": b"/".join(emptydirs),
                 # pytype: enable=wrong-arg-types
                 b"basename": d,
             }
 
     return web.sendtemplate(
         b'manifest',
         symrev=symrev,
         path=abspath,
         up=webutil.up(abspath),
         upparity=next(parity),
         fentries=templateutil.mappinggenerator(filelist),
         dentries=templateutil.mappinggenerator(dirlist),
         archives=web.archivelist(hex(node)),
         **pycompat.strkwargs(webutil.commonentry(web.repo, ctx))
     )
 
 
 @webcommand(b'tags')
 def tags(web):
     """
     /tags
     -----
 
     Show information about tags.
 
     No arguments are accepted.
 
     The ``tags`` template is rendered.
     """
     i = list(reversed(web.repo.tagslist()))
     parity = paritygen(web.stripecount)
 
     def entries(context, notip, latestonly):
         t = i
         if notip:
             t = [(k, n) for k, n in i if k != b"tip"]
         if latestonly:
             t = t[:1]
         for k, n in t:
             yield {
                 b"parity": next(parity),
                 b"tag": k,
                 b"date": web.repo[n].date(),
                 b"node": hex(n),
             }
 
     return web.sendtemplate(
         b'tags',
         node=hex(web.repo.changelog.tip()),
         entries=templateutil.mappinggenerator(entries, args=(False, False)),
         entriesnotip=templateutil.mappinggenerator(entries, args=(True, False)),
         latestentry=templateutil.mappinggenerator(entries, args=(True, True)),
     )
 
 
 @webcommand(b'bookmarks')
 def bookmarks(web):
     """
     /bookmarks
     ----------
 
     Show information about bookmarks.
 
     No arguments are accepted.
 
     The ``bookmarks`` template is rendered.
     """
     i = [b for b in web.repo._bookmarks.items() if b[1] in web.repo]
     sortkey = lambda b: (web.repo[b[1]].rev(), b[0])
     i = sorted(i, key=sortkey, reverse=True)
     parity = paritygen(web.stripecount)
 
     def entries(context, latestonly):
         t = i
         if latestonly:
             t = i[:1]
         for k, n in t:
             yield {
                 b"parity": next(parity),
                 b"bookmark": k,
                 b"date": web.repo[n].date(),
                 b"node": hex(n),
             }
 
     if i:
         latestrev = i[0][1]
     else:
         latestrev = -1
     lastdate = web.repo[latestrev].date()
 
     return web.sendtemplate(
         b'bookmarks',
         node=hex(web.repo.changelog.tip()),
         lastchange=templateutil.mappinglist([{b'date': lastdate}]),
         entries=templateutil.mappinggenerator(entries, args=(False,)),
         latestentry=templateutil.mappinggenerator(entries, args=(True,)),
     )
 
 
 @webcommand(b'branches')
 def branches(web):
     """
     /branches
     ---------
 
     Show information about branches.
 
     All known branches are contained in the output, even closed branches.
 
     No arguments are accepted.
 
     The ``branches`` template is rendered.
     """
     entries = webutil.branchentries(web.repo, web.stripecount)
     latestentry = webutil.branchentries(web.repo, web.stripecount, 1)
 
     return web.sendtemplate(
         b'branches',
         node=hex(web.repo.changelog.tip()),
         entries=entries,
         latestentry=latestentry,
     )
 
 
 @webcommand(b'summary')
 def summary(web):
     """
     /summary
     --------
 
     Show a summary of repository state.
 
     Information about the latest changesets, bookmarks, tags, and branches
     is captured by this handler.
 
     The ``summary`` template is rendered.
     """
     i = reversed(web.repo.tagslist())
 
     def tagentries(context):
         parity = paritygen(web.stripecount)
         count = 0
         for k, n in i:
             if k == b"tip":  # skip tip
                 continue
 
             count += 1
             if count > 10:  # limit to 10 tags
                 break
 
             yield {
                 b'parity': next(parity),
                 b'tag': k,
                 b'node': hex(n),
                 b'date': web.repo[n].date(),
             }
 
     def bookmarks(context):
         parity = paritygen(web.stripecount)
         marks = [b for b in web.repo._bookmarks.items() if b[1] in web.repo]
         sortkey = lambda b: (web.repo[b[1]].rev(), b[0])
         marks = sorted(marks, key=sortkey, reverse=True)
         for k, n in marks[:10]:  # limit to 10 bookmarks
             yield {
                 b'parity': next(parity),
                 b'bookmark': k,
                 b'date': web.repo[n].date(),
                 b'node': hex(n),
             }
 
     def changelist(context):
         parity = paritygen(web.stripecount, offset=start - end)
         l = []  # build a list in forward order for efficiency
         revs = []
         if start < end:
             revs = web.repo.changelog.revs(start, end - 1)
         for i in revs:
             ctx = web.repo[i]
             lm = webutil.commonentry(web.repo, ctx)
             lm[b'parity'] = next(parity)
             l.append(lm)
 
         for entry in reversed(l):
             yield entry
 
     tip = web.repo[b'tip']
     count = len(web.repo)
     start = max(0, count - web.maxchanges)
     end = min(count, start + web.maxchanges)
 
     desc = web.config(b"web", b"description")
     if not desc:
         desc = b'unknown'
     labels = web.configlist(b'web', b'labels')
 
     return web.sendtemplate(
         b'summary',
         desc=desc,
         owner=get_contact(web.config) or b'unknown',
         lastchange=tip.date(),
         tags=templateutil.mappinggenerator(tagentries, name=b'tagentry'),
         bookmarks=templateutil.mappinggenerator(bookmarks),
         branches=webutil.branchentries(web.repo, web.stripecount, 10),
         shortlog=templateutil.mappinggenerator(
             changelist, name=b'shortlogentry'
         ),
         node=tip.hex(),
         symrev=b'tip',
         archives=web.archivelist(b'tip'),
         labels=templateutil.hybridlist(labels, name=b'label'),
     )
 
 
 @webcommand(b'filediff')
 def filediff(web):
     """
     /diff/{revision}/{path}
     -----------------------
 
     Show how a file changed in a particular commit.
 
     The ``filediff`` template is rendered.
 
     This handler is registered under both the ``/diff`` and ``/filediff``
     paths. ``/diff`` is used in modern code.
     """
     fctx, ctx = None, None
     try:
         fctx = webutil.filectx(web.repo, web.req)
     except LookupError:
         ctx = webutil.changectx(web.repo, web.req)
         path = webutil.cleanpath(web.repo, web.req.qsparams[b'file'])
         if path not in ctx.files():
             raise
 
     if fctx is not None:
         path = fctx.path()
         ctx = fctx.changectx()
     basectx = ctx.p1()
 
     style = web.config(b'web', b'style')
     if b'style' in web.req.qsparams:
         style = web.req.qsparams[b'style']
 
     diffs = webutil.diffs(web, ctx, basectx, [path], style)
     if fctx is not None:
         rename = webutil.renamelink(fctx)
         ctx = fctx
     else:
         rename = templateutil.mappinglist([])
         ctx = ctx
 
     return web.sendtemplate(
         b'filediff',
         file=path,
         symrev=webutil.symrevorshortnode(web.req, ctx),
         rename=rename,
         diff=diffs,
         **pycompat.strkwargs(webutil.commonentry(web.repo, ctx))
     )
 
 
 diff = webcommand(b'diff')(filediff)
 
 
 @webcommand(b'comparison')
 def comparison(web):
     """
     /comparison/{revision}/{path}
     -----------------------------
 
     Show a comparison between the old and new versions of a file from changes
     made on a particular revision.
 
     This is similar to the ``diff`` handler. However, this form features
     a split or side-by-side diff rather than a unified diff.
 
     The ``context`` query string argument can be used to control the lines of
     context in the diff.
 
     The ``filecomparison`` template is rendered.
     """
     ctx = webutil.changectx(web.repo, web.req)
     if b'file' not in web.req.qsparams:
         raise ErrorResponse(HTTP_NOT_FOUND, b'file not given')
     path = webutil.cleanpath(web.repo, web.req.qsparams[b'file'])
 
     parsecontext = lambda v: v == b'full' and -1 or int(v)
     if b'context' in web.req.qsparams:
         context = parsecontext(web.req.qsparams[b'context'])
     else:
         context = parsecontext(web.config(b'web', b'comparisoncontext'))
 
     def filelines(f):
         if f.isbinary():
             mt = pycompat.sysbytes(
                 mimetypes.guess_type(pycompat.fsdecode(f.path()))[0]
                 or r'application/octet-stream'
             )
             return [_(b'(binary file %s, hash: %s)') % (mt, hex(f.filenode()))]
         return f.data().splitlines()
 
     fctx = None
     parent = ctx.p1()
     leftrev = parent.rev()
     leftnode = parent.node()
     rightrev = ctx.rev()
     rightnode = scmutil.binnode(ctx)
     if path in ctx:
         fctx = ctx[path]
         rightlines = filelines(fctx)
         if path not in parent:
             leftlines = ()
         else:
             pfctx = parent[path]
             leftlines = filelines(pfctx)
     else:
         rightlines = ()
         pfctx = ctx.p1()[path]
         leftlines = filelines(pfctx)
 
     comparison = webutil.compare(context, leftlines, rightlines)
     if fctx is not None:
         rename = webutil.renamelink(fctx)
         ctx = fctx
     else:
         rename = templateutil.mappinglist([])
         ctx = ctx
 
     return web.sendtemplate(
         b'filecomparison',
         file=path,
         symrev=webutil.symrevorshortnode(web.req, ctx),
         rename=rename,
         leftrev=leftrev,
         leftnode=hex(leftnode),
         rightrev=rightrev,
         rightnode=hex(rightnode),
         comparison=comparison,
         **pycompat.strkwargs(webutil.commonentry(web.repo, ctx))
     )
 
 
 @webcommand(b'annotate')
 def annotate(web):
     """
     /annotate/{revision}/{path}
     ---------------------------
 
     Show changeset information for each line in a file.
 
     The ``ignorews``, ``ignorewsamount``, ``ignorewseol``, and
     ``ignoreblanklines`` query string arguments have the same meaning as
     their ``[annotate]`` config equivalents. It uses the hgrc boolean
     parsing logic to interpret the value. e.g. ``0`` and ``false`` are
     false and ``1`` and ``true`` are true. If not defined, the server
     default settings are used.
 
     The ``fileannotate`` template is rendered.
     """
     fctx = webutil.filectx(web.repo, web.req)
     f = fctx.path()
     parity = paritygen(web.stripecount)
     ishead = fctx.filenode() in fctx.filelog().heads()
 
     # parents() is called once per line and several lines likely belong to
     # same revision. So it is worth caching.
     # TODO there are still redundant operations within basefilectx.parents()
     # and from the fctx.annotate() call itself that could be cached.
     parentscache = {}
 
     def parents(context, f):
         rev = f.rev()
         if rev not in parentscache:
             parentscache[rev] = []
             for p in f.parents():
                 entry = {
                     b'node': p.hex(),
                     b'rev': p.rev(),
                 }
                 parentscache[rev].append(entry)
 
         for p in parentscache[rev]:
             yield p
 
     def annotate(context):
         if fctx.isbinary():
             mt = pycompat.sysbytes(
                 mimetypes.guess_type(pycompat.fsdecode(fctx.path()))[0]
                 or r'application/octet-stream'
             )
             lines = [
                 dagop.annotateline(
                     fctx=fctx.filectx(fctx.filerev()),
                     lineno=1,
                     text=b'(binary:%s)' % mt,
                 )
             ]
         else:
             lines = webutil.annotate(web.req, fctx, web.repo.ui)
 
         previousrev = None
         blockparitygen = paritygen(1)
         for lineno, aline in enumerate(lines):
             f = aline.fctx
             rev = f.rev()
             if rev != previousrev:
                 blockhead = True
                 blockparity = next(blockparitygen)
             else:
                 blockhead = None
             previousrev = rev
             yield {
                 b"parity": next(parity),
                 b"node": f.hex(),
                 b"rev": rev,
                 b"author": f.user(),
                 b"parents": templateutil.mappinggenerator(parents, args=(f,)),
                 b"desc": f.description(),
                 b"extra": f.extra(),
                 b"file": f.path(),
                 b"blockhead": blockhead,
                 b"blockparity": blockparity,
                 b"targetline": aline.lineno,
                 b"line": aline.text,
                 b"lineno": lineno + 1,
                 b"lineid": b"l%d" % (lineno + 1),
                 b"linenumber": b"% 6d" % (lineno + 1),
                 b"revdate": f.date(),
             }
 
     diffopts = webutil.difffeatureopts(web.req, web.repo.ui, b'annotate')
     diffopts = {
         k: getattr(diffopts, pycompat.sysstr(k)) for k in diffopts.defaults
     }
 
     return web.sendtemplate(
         b'fileannotate',
         file=f,
         annotate=templateutil.mappinggenerator(annotate),
         path=webutil.up(f),
         symrev=webutil.symrevorshortnode(web.req, fctx),
         rename=webutil.renamelink(fctx),
         permissions=fctx.manifest().flags(f),
         ishead=int(ishead),
         diffopts=templateutil.hybriddict(diffopts),
         **pycompat.strkwargs(webutil.commonentry(web.repo, fctx))
     )
 
 
 @webcommand(b'filelog')
 def filelog(web):
     """
     /filelog/{revision}/{path}
     --------------------------
 
     Show information about the history of a file in the repository.
 
     The ``revcount`` query string argument can be defined to control the
     maximum number of entries to show.
 
     The ``filelog`` template will be rendered.
     """
 
     try:
         fctx = webutil.filectx(web.repo, web.req)
         f = fctx.path()
         fl = fctx.filelog()
     except error.LookupError:
         f = webutil.cleanpath(web.repo, web.req.qsparams[b'file'])
         fl = web.repo.file(f)
         numrevs = len(fl)
         if not numrevs:  # file doesn't exist at all
             raise
         rev = webutil.changectx(web.repo, web.req).rev()
         first = fl.linkrev(0)
         if rev < first:  # current rev is from before file existed
             raise
         frev = numrevs - 1
         while fl.linkrev(frev) > rev:
             frev -= 1
         fctx = web.repo.filectx(f, fl.linkrev(frev))
 
     revcount = web.maxshortchanges
     if b'revcount' in web.req.qsparams:
         try:
             revcount = int(web.req.qsparams.get(b'revcount', revcount))
             revcount = max(revcount, 1)
             web.tmpl.defaults[b'sessionvars'][b'revcount'] = revcount
         except ValueError:
             pass
 
     lrange = webutil.linerange(web.req)
 
     lessvars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     lessvars[b'revcount'] = max(revcount // 2, 1)
     morevars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     morevars[b'revcount'] = revcount * 2
 
     patch = b'patch' in web.req.qsparams
     if patch:
         lessvars[b'patch'] = morevars[b'patch'] = web.req.qsparams[b'patch']
     descend = b'descend' in web.req.qsparams
     if descend:
         lessvars[b'descend'] = morevars[b'descend'] = web.req.qsparams[
             b'descend'
         ]
 
     count = fctx.filerev() + 1
     start = max(0, count - revcount)  # first rev on this page
     end = min(count, start + revcount)  # last rev on this page
     parity = paritygen(web.stripecount, offset=start - end)
 
     repo = web.repo
     filelog = fctx.filelog()
     revs = [
         filerev
         for filerev in filelog.revs(start, end - 1)
         if filelog.linkrev(filerev) in repo
     ]
     entries = []
 
     diffstyle = web.config(b'web', b'style')
     if b'style' in web.req.qsparams:
         diffstyle = web.req.qsparams[b'style']
 
     def diff(fctx, linerange=None):
         ctx = fctx.changectx()
         basectx = ctx.p1()
         path = fctx.path()
         return webutil.diffs(
             web,
             ctx,
             basectx,
             [path],
             diffstyle,
             linerange=linerange,
             lineidprefix=b'%s-' % ctx.hex()[:12],
         )
 
     linerange = None
     if lrange is not None:
         assert lrange is not None  # help pytype (!?)
         linerange = webutil.formatlinerange(*lrange)
         # deactivate numeric nav links when linerange is specified as this
         # would required a dedicated "revnav" class
         nav = templateutil.mappinglist([])
         if descend:
             it = dagop.blockdescendants(fctx, *lrange)
         else:
             it = dagop.blockancestors(fctx, *lrange)
         for i, (c, lr) in enumerate(it, 1):
             diffs = None
             if patch:
                 diffs = diff(c, linerange=lr)
             # follow renames accross filtered (not in range) revisions
             path = c.path()
             lm = webutil.commonentry(repo, c)
             lm.update(
                 {
                     b'parity': next(parity),
                     b'filerev': c.rev(),
                     b'file': path,
                     b'diff': diffs,
                     b'linerange': webutil.formatlinerange(*lr),
                     b'rename': templateutil.mappinglist([]),
                 }
             )
             entries.append(lm)
             if i == revcount:
                 break
         lessvars[b'linerange'] = webutil.formatlinerange(*lrange)
         morevars[b'linerange'] = lessvars[b'linerange']
     else:
         for i in revs:
             iterfctx = fctx.filectx(i)
             diffs = None
             if patch:
                 diffs = diff(iterfctx)
             lm = webutil.commonentry(repo, iterfctx)
             lm.update(
                 {
                     b'parity': next(parity),
                     b'filerev': i,
                     b'file': f,
                     b'diff': diffs,
                     b'rename': webutil.renamelink(iterfctx),
                 }
             )
             entries.append(lm)
         entries.reverse()
         revnav = webutil.filerevnav(web.repo, fctx.path())
         nav = revnav.gen(end - 1, revcount, count)
 
     latestentry = entries[:1]
 
     return web.sendtemplate(
         b'filelog',
         file=f,
         nav=nav,
         symrev=webutil.symrevorshortnode(web.req, fctx),
         entries=templateutil.mappinglist(entries),
         descend=descend,
         patch=patch,
         latestentry=templateutil.mappinglist(latestentry),
         linerange=linerange,
         revcount=revcount,
         morevars=morevars,
         lessvars=lessvars,
         **pycompat.strkwargs(webutil.commonentry(web.repo, fctx))
     )
 
 
 @webcommand(b'archive')
 def archive(web):
     """
     /archive/{revision}.{format}[/{path}]
     -------------------------------------
 
     Obtain an archive of repository content.
 
     The content and type of the archive is defined by a URL path parameter.
     ``format`` is the file extension of the archive type to be generated. e.g.
     ``zip`` or ``tar.bz2``. Not all archive types may be allowed by your
     server configuration.
 
     The optional ``path`` URL parameter controls content to include in the
     archive. If omitted, every file in the specified revision is present in the
     archive. If included, only the specified file or contents of the specified
     directory will be included in the archive.
 
     No template is used for this handler. Raw, binary content is generated.
     """
 
     type_ = web.req.qsparams.get(b'type')
     allowed = web.configlist(b"web", b"allow-archive")
     key = web.req.qsparams[b'node']
 
     if type_ not in webutil.archivespecs:
         msg = b'Unsupported archive type: %s' % stringutil.pprint(type_)
         raise ErrorResponse(HTTP_NOT_FOUND, msg)
 
     if not ((type_ in allowed or web.configbool(b"web", b"allow" + type_))):
         msg = b'Archive type not allowed: %s' % type_
         raise ErrorResponse(HTTP_FORBIDDEN, msg)
 
     reponame = re.sub(br"\W+", b"-", os.path.basename(web.reponame))
     cnode = web.repo.lookup(key)
     arch_version = key
     if cnode == key or key == b'tip':
         arch_version = short(cnode)
     name = b"%s-%s" % (reponame, arch_version)
 
     ctx = webutil.changectx(web.repo, web.req)
     match = scmutil.match(ctx, [])
     file = web.req.qsparams.get(b'file')
     if file:
         pats = [b'path:' + file]
         match = scmutil.match(ctx, pats, default=b'path')
         if pats:
             files = [f for f in ctx.manifest().keys() if match(f)]
             if not files:
                 raise ErrorResponse(
                     HTTP_NOT_FOUND, b'file(s) not found: %s' % file
                 )
 
     mimetype, artype, extension, encoding = webutil.archivespecs[type_]
 
     web.res.headers[b'Content-Type'] = mimetype
     web.res.headers[b'Content-Disposition'] = b'attachment; filename=%s%s' % (
         name,
         extension,
     )
 
     if encoding:
         web.res.headers[b'Content-Encoding'] = encoding
 
     web.res.setbodywillwrite()
     if list(web.res.sendresponse()):
         raise error.ProgrammingError(
             b'sendresponse() should not emit data if writing later'
         )
 
     if web.req.method == b'HEAD':
         return []
 
     bodyfh = web.res.getbodyfile()
 
     archival.archive(
         web.repo,
         bodyfh,
         cnode,
         artype,
         prefix=name,
         match=match,
         subrepos=web.configbool(b"web", b"archivesubrepos"),
     )
 
     return []
 
 
 @webcommand(b'static')
 def static(web):
     fname = web.req.qsparams[b'file']
     # a repo owner may set web.static in .hg/hgrc to get any file
     # readable by the user running the CGI script
     static = web.config(b"web", b"static", untrusted=False)
     staticfile(web.templatepath, static, fname, web.res)
     return web.res.sendresponse()
 
 
 @webcommand(b'graph')
 def graph(web):
     """
     /graph[/{revision}]
     -------------------
 
     Show information about the graphical topology of the repository.
 
     Information rendered by this handler can be used to create visual
     representations of repository topology.
 
     The ``revision`` URL parameter controls the starting changeset. If it's
     absent, the default is ``tip``.
 
     The ``revcount`` query string argument can define the number of changesets
     to show information for.
 
     The ``graphtop`` query string argument can specify the starting changeset
     for producing ``jsdata`` variable that is used for rendering graph in
     JavaScript. By default it has the same value as ``revision``.
 
     This handler will render the ``graph`` template.
     """
 
     if b'node' in web.req.qsparams:
         ctx = webutil.changectx(web.repo, web.req)
         symrev = webutil.symrevorshortnode(web.req, ctx)
     else:
         ctx = web.repo[b'tip']
         symrev = b'tip'
     rev = ctx.rev()
 
     bg_height = 39
     revcount = web.maxshortchanges
     if b'revcount' in web.req.qsparams:
         try:
             revcount = int(web.req.qsparams.get(b'revcount', revcount))
             revcount = max(revcount, 1)
             web.tmpl.defaults[b'sessionvars'][b'revcount'] = revcount
         except ValueError:
             pass
 
     lessvars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     lessvars[b'revcount'] = max(revcount // 2, 1)
     morevars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     morevars[b'revcount'] = revcount * 2
 
     graphtop = web.req.qsparams.get(b'graphtop', ctx.hex())
     graphvars = copy.copy(web.tmpl.defaults[b'sessionvars'])
     graphvars[b'graphtop'] = graphtop
 
     count = len(web.repo)
     pos = rev
 
     uprev = min(max(0, count - 1), rev + revcount)
     downrev = max(0, rev - revcount)
     changenav = webutil.revnav(web.repo).gen(pos, revcount, count)
 
     tree = []
     nextentry = []
     lastrev = 0
     if pos != -1:
         allrevs = web.repo.changelog.revs(pos, 0)
         revs = []
         for i in allrevs:
             revs.append(i)
             if len(revs) >= revcount + 1:
                 break
 
         if len(revs) > revcount:
             nextentry = [webutil.commonentry(web.repo, web.repo[revs[-1]])]
             revs = revs[:-1]
 
         lastrev = revs[-1]
 
         # We have to feed a baseset to dagwalker as it is expecting smartset
         # object. This does not have a big impact on hgweb performance itself
         # since hgweb graphing code is not itself lazy yet.
         dag = graphmod.dagwalker(web.repo, smartset.baseset(revs))
         # As we said one line above... not lazy.
         tree = list(
             item
             for item in graphmod.colored(dag, web.repo)
             if item[1] == graphmod.CHANGESET
         )
 
     def fulltree():
         pos = web.repo[graphtop].rev()
         tree = []
         if pos != -1:
             revs = web.repo.changelog.revs(pos, lastrev)
             dag = graphmod.dagwalker(web.repo, smartset.baseset(revs))
             tree = list(
                 item
                 for item in graphmod.colored(dag, web.repo)
                 if item[1] == graphmod.CHANGESET
             )
         return tree
 
     def jsdata(context):
         for (id, type, ctx, vtx, edges) in fulltree():
             yield {
                 b'node': pycompat.bytestr(ctx),
                 b'graphnode': webutil.getgraphnode(web.repo, ctx),
                 b'vertex': vtx,
                 b'edges': edges,
             }
 
     def nodes(context):
         parity = paritygen(web.stripecount)
         for row, (id, type, ctx, vtx, edges) in enumerate(tree):
             entry = webutil.commonentry(web.repo, ctx)
             edgedata = [
                 {
                     b'col': edge[0],
                     b'nextcol': edge[1],
                     b'color': (edge[2] - 1) % 6 + 1,
                     b'width': edge[3],
                     b'bcolor': edge[4],
                 }
                 for edge in edges
             ]
 
             entry.update(
                 {
                     b'col': vtx[0],
                     b'color': (vtx[1] - 1) % 6 + 1,
                     b'parity': next(parity),
                     b'edges': templateutil.mappinglist(edgedata),
                     b'row': row,
                     b'nextrow': row + 1,
                 }
             )
 
             yield entry
 
     rows = len(tree)
 
     return web.sendtemplate(
         b'graph',
         rev=rev,
         symrev=symrev,
         revcount=revcount,
         uprev=uprev,
         lessvars=lessvars,
         morevars=morevars,
         downrev=downrev,
         graphvars=graphvars,
         rows=rows,
         bg_height=bg_height,
         changesets=count,
         nextentry=templateutil.mappinglist(nextentry),
         jsdata=templateutil.mappinggenerator(jsdata),
         nodes=templateutil.mappinggenerator(nodes),
         node=ctx.hex(),
         archives=web.archivelist(b'tip'),
         changenav=changenav,
     )
 
 
 def _getdoc(e):
     doc = e[0].__doc__
     if doc:
         doc = _(doc).partition(b'\n')[0]
     else:
         doc = _(b'(no help text available)')
     return doc
 
 
 @webcommand(b'help')
 def help(web):
     """
     /help[/{topic}]
     ---------------
 
     Render help documentation.
 
     This web command is roughly equivalent to :hg:`help`. If a ``topic``
     is defined, that help topic will be rendered. If not, an index of
     available help topics will be rendered.
 
     The ``help`` template will be rendered when requesting help for a topic.
     ``helptopics`` will be rendered for the index of help topics.
     """
     from .. import commands, help as helpmod  # avoid cycle
 
     topicname = web.req.qsparams.get(b'node')
     if not topicname:
 
         def topics(context):
             for h in helpmod.helptable:
                 entries, summary, _doc = h[0:3]
                 yield {b'topic': entries[0], b'summary': summary}
 
         early, other = [], []
         primary = lambda s: s.partition(b'|')[0]
         for c, e in commands.table.items():
             doc = _getdoc(e)
             if b'DEPRECATED' in doc or c.startswith(b'debug'):
                 continue
             cmd = primary(c)
             if getattr(e[0], 'helpbasic', False):
                 early.append((cmd, doc))
             else:
                 other.append((cmd, doc))
 
         early.sort()
         other.sort()
 
         def earlycommands(context):
             for c, doc in early:
                 yield {b'topic': c, b'summary': doc}
 
         def othercommands(context):
             for c, doc in other:
                 yield {b'topic': c, b'summary': doc}
 
         return web.sendtemplate(
             b'helptopics',
             topics=templateutil.mappinggenerator(topics),
             earlycommands=templateutil.mappinggenerator(earlycommands),
             othercommands=templateutil.mappinggenerator(othercommands),
             title=b'Index',
         )
 
     # Render an index of sub-topics.
     if topicname in helpmod.subtopics:
         topics = []
         for entries, summary, _doc in helpmod.subtopics[topicname]:
             topics.append(
                 {
                     b'topic': b'%s.%s' % (topicname, entries[0]),
                     b'basename': entries[0],
                     b'summary': summary,
                 }
             )
 
         return web.sendtemplate(
             b'helptopics',
             topics=templateutil.mappinglist(topics),
             title=topicname,
             subindex=True,
         )
 
     u = webutil.wsgiui.load()
     u.verbose = True
 
     # Render a page from a sub-topic.
     if b'.' in topicname:
         # TODO implement support for rendering sections, like
         # `hg help` works.
         topic, subtopic = topicname.split(b'.', 1)
         if topic not in helpmod.subtopics:
             raise ErrorResponse(HTTP_NOT_FOUND)
     else:
         topic = topicname
         subtopic = None
 
     try:
         doc = helpmod.help_(u, commands, topic, subtopic=subtopic)
     except error.Abort:
         raise ErrorResponse(HTTP_NOT_FOUND)
 
     return web.sendtemplate(b'help', topic=topicname, doc=doc)
 
 
 # tell hggettext to extract docstrings from these functions:
 i18nfunctions = commands.values()

mercurial/lsprof.py

@@ -1,135 +1,135 b''
 import _lsprof
 import sys
 
 Profiler = _lsprof.Profiler
 
 # PyPy doesn't expose profiler_entry from the module.
 profiler_entry = getattr(_lsprof, 'profiler_entry', None)
 
-__all__ = [b'profile', b'Stats']
+__all__ = ['profile', 'Stats']
 
 
 def profile(f, *args, **kwds):
     """XXX docstring"""
     p = Profiler()
     p.enable(subcalls=True, builtins=True)
     try:
         f(*args, **kwds)
     finally:
         p.disable()
     return Stats(p.getstats())
 
 
 class Stats:
     """XXX docstring"""
 
     def __init__(self, data):
         self.data = data
 
     def sort(self, crit="inlinetime"):
         """XXX docstring"""
         # profiler_entries isn't defined when running under PyPy.
         if profiler_entry:
             if crit not in profiler_entry.__dict__:
                 raise ValueError(b"Can't sort by %s" % crit)
         elif self.data and not getattr(self.data[0], crit, None):
             raise ValueError(b"Can't sort by %s" % crit)
 
         self.data.sort(key=lambda x: getattr(x, crit), reverse=True)
         for e in self.data:
             if e.calls:
                 e.calls.sort(key=lambda x: getattr(x, crit), reverse=True)
 
     def pprint(self, top=None, file=None, limit=None, climit=None):
         """XXX docstring"""
         if file is None:
             file = sys.stdout
         d = self.data
         if top is not None:
             d = d[:top]
         cols = b"% 12d %12d %11.4f %11.4f   %s\n"
         hcols = b"% 12s %12s %12s %12s %s\n"
         file.write(
             hcols
             % (
                 b"CallCount",
                 b"Recursive",
                 b"Total(s)",
                 b"Inline(s)",
                 b"module:lineno(function)",
             )
         )
         count = 0
         for e in d:
             file.write(
                 cols
                 % (
                     e.callcount,
                     e.reccallcount,
                     e.totaltime,
                     e.inlinetime,
                     label(e.code),
                 )
             )
             count += 1
             if limit is not None and count == limit:
                 return
             ccount = 0
             if climit and e.calls:
                 for se in e.calls:
                     file.write(
                         cols
                         % (
                             se.callcount,
                             se.reccallcount,
                             se.totaltime,
                             se.inlinetime,
                             b"    %s" % label(se.code),
                         )
                     )
                     count += 1
                     ccount += 1
                     if limit is not None and count == limit:
                         return
                     if climit is not None and ccount == climit:
                         break
 
     def freeze(self):
         """Replace all references to code objects with string
         descriptions; this makes it possible to pickle the instance."""
 
         # this code is probably rather ickier than it needs to be!
         for i in range(len(self.data)):
             e = self.data[i]
             if not isinstance(e.code, str):
                 self.data[i] = type(e)((label(e.code),) + e[1:])
             if e.calls:
                 for j in range(len(e.calls)):
                     se = e.calls[j]
                     if not isinstance(se.code, str):
                         e.calls[j] = type(se)((label(se.code),) + se[1:])
 
 
 _fn2mod = {}
 
 
 def label(code):
     if isinstance(code, str):
         return code.encode('latin-1')
     try:
         mname = _fn2mod[code.co_filename]
     except KeyError:
         for k, v in list(sys.modules.items()):
             if v is None:
                 continue
             if not isinstance(getattr(v, '__file__', None), str):
                 continue
             if v.__file__.startswith(code.co_filename):
                 mname = _fn2mod[code.co_filename] = k
                 break
         else:
             mname = _fn2mod[code.co_filename] = '<%s>' % code.co_filename
 
     res = '%s:%d(%s)' % (mname, code.co_firstlineno, code.co_name)
 
     return res.encode('latin-1')

mercurial/statprof.py

@@ -1,1097 +1,1097 b''
 ## statprof.py
 ## Copyright (C) 2012 Bryan O'Sullivan <[e-mail]>
 ## Copyright (C) 2011 Alex Fraser <alex at phatcore dot com>
 ## Copyright (C) 2004,2005 Andy Wingo <wingo at pobox dot com>
 ## Copyright (C) 2001 Rob Browning <rlb at defaultvalue dot org>
 
 ## This library is free software; you can redistribute it and/or
 ## modify it under the terms of the GNU Lesser General Public
 ## License as published by the Free Software Foundation; either
 ## version 2.1 of the License, or (at your option) any later version.
 ##
 ## This library is distributed in the hope that it will be useful,
 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 ## Lesser General Public License for more details.
 ##
 ## You should have received a copy of the GNU Lesser General Public
 ## License along with this program; if not, contact:
 ##
 ## Free Software Foundation           Voice:  [phone]
 ## 59 Temple Place - Suite 330        Fax:    [phone]
 ## Boston, MA  02111-1307,  USA       [e-mail]
 
 """
 statprof is intended to be a fairly simple statistical profiler for
 python. It was ported directly from a statistical profiler for guile,
 also named statprof, available from guile-lib [0].
 
 [0] http://wingolog.org/software/guile-lib/statprof/
 
 To start profiling, call statprof.start():
 >>> start()
 
 Then run whatever it is that you want to profile, for example:
 >>> import test.pystone; test.pystone.pystones()
 
 Then stop the profiling and print out the results:
 >>> stop()
 >>> display()
   %   cumulative      self
  time    seconds   seconds  name
  26.72      1.40      0.37  pystone.py:79:Proc0
  13.79      0.56      0.19  pystone.py:133:Proc1
  13.79      0.19      0.19  pystone.py:208:Proc8
  10.34      0.16      0.14  pystone.py:229:Func2
   6.90      0.10      0.10  pystone.py:45:__init__
   4.31      0.16      0.06  pystone.py:53:copy
     ...
 
 All of the numerical data is statistically approximate. In the
 following column descriptions, and in all of statprof, "time" refers
 to execution time (both user and system), not wall clock time.
 
 % time
     The percent of the time spent inside the procedure itself (not
     counting children).
 
 cumulative seconds
     The total number of seconds spent in the procedure, including
     children.
 
 self seconds
     The total number of seconds spent in the procedure itself (not
     counting children).
 
 name
     The name of the procedure.
 
 By default statprof keeps the data collected from previous runs. If you
 want to clear the collected data, call reset():
 >>> reset()
 
 reset() can also be used to change the sampling frequency from the
 default of 1000 Hz. For example, to tell statprof to sample 50 times a
 second:
 >>> reset(50)
 
 This means that statprof will sample the call stack after every 1/50 of
 a second of user + system time spent running on behalf of the python
 process. When your process is idle (for example, blocking in a read(),
 as is the case at the listener), the clock does not advance. For this
 reason statprof is not currently not suitable for profiling io-bound
 operations.
 
 The profiler uses the hash of the code object itself to identify the
 procedures, so it won't confuse different procedures with the same name.
 They will show up as two different rows in the output.
 
 Right now the profiler is quite simplistic.  I cannot provide
 call-graphs or other higher level information.  What you see in the
 table is pretty much all there is. Patches are welcome :-)
 
 
 Threading
 ---------
 
 Because signals only get delivered to the main thread in Python,
 statprof only profiles the main thread. However because the time
 reporting function uses per-process timers, the results can be
 significantly off if other threads' work patterns are not similar to the
 main thread's work patterns.
 """
 # no-check-code
 
 import collections
 import contextlib
 import getopt
 import inspect
 import json
 import os
 import signal
 import sys
 import threading
 import time
 
 from .pycompat import open
 from . import (
     encoding,
     pycompat,
 )
 
 defaultdict = collections.defaultdict
 contextmanager = contextlib.contextmanager
 
-__all__ = [b'start', b'stop', b'reset', b'display', b'profile']
+__all__ = ['start', 'stop', 'reset', 'display', 'profile']
 
 skips = {
     "util.py:check",
     "extensions.py:closure",
     "color.py:colorcmd",
     "dispatch.py:checkargs",
     "dispatch.py:<lambda>",
     "dispatch.py:_runcatch",
     "dispatch.py:_dispatch",
     "dispatch.py:_runcommand",
     "pager.py:pagecmd",
     "dispatch.py:run",
     "dispatch.py:dispatch",
     "dispatch.py:runcommand",
     "hg.py:<module>",
     "evolve.py:warnobserrors",
 }
 
 ###########################################################################
 ## Utils
 
 
 def clock():
     times = os.times()
     return (times[0] + times[1], times[4])
 
 
 ###########################################################################
 ## Collection data structures
 
 
 class ProfileState:
     def __init__(self, frequency=None):
         self.reset(frequency)
         self.track = b'cpu'
 
     def reset(self, frequency=None):
         # total so far
         self.accumulated_time = (0.0, 0.0)
         # start_time when timer is active
         self.last_start_time = None
         # a float
         if frequency:
             self.sample_interval = 1.0 / frequency
         elif not hasattr(self, 'sample_interval'):
             # default to 1000 Hz
             self.sample_interval = 1.0 / 1000.0
         else:
             # leave the frequency as it was
             pass
         self.remaining_prof_time = None
         # for user start/stop nesting
         self.profile_level = 0
 
         self.samples = []
 
     def accumulate_time(self, stop_time):
         increment = (
             stop_time[0] - self.last_start_time[0],
             stop_time[1] - self.last_start_time[1],
         )
         self.accumulated_time = (
             self.accumulated_time[0] + increment[0],
             self.accumulated_time[1] + increment[1],
         )
 
     def seconds_per_sample(self):
         return self.accumulated_time[self.timeidx] / len(self.samples)
 
     @property
     def timeidx(self):
         if self.track == b'real':
             return 1
         return 0
 
 
 state = ProfileState()
 
 
 class CodeSite:
     cache = {}
 
     __slots__ = ('path', 'lineno', 'function', 'source')
 
     def __init__(self, path, lineno, function):
         assert isinstance(path, bytes)
         self.path = path
         self.lineno = lineno
         assert isinstance(function, bytes)
         self.function = function
         self.source = None
 
     def __eq__(self, other):
         try:
             return self.lineno == other.lineno and self.path == other.path
         except:
             return False
 
     def __hash__(self):
         return hash((self.lineno, self.path))
 
     @classmethod
     def get(cls, path, lineno, function):
         k = (path, lineno)
         try:
             return cls.cache[k]
         except KeyError:
             v = cls(path, lineno, function)
             cls.cache[k] = v
             return v
 
     def getsource(self, length):
         if self.source is None:
             try:
                 lineno = self.lineno - 1  # lineno can be None
                 with open(self.path, b'rb') as fp:
                     for i, line in enumerate(fp):
                         if i == lineno:
                             self.source = line.strip()
                             break
             except:
                 pass
             if self.source is None:
                 self.source = b''
 
         source = self.source
         if len(source) > length:
             source = source[: (length - 3)] + b"..."
         return source
 
     def filename(self):
         return os.path.basename(self.path)
 
     def skipname(self):
         return '%s:%s' % (self.filename(), self.function)
 
 
 class Sample:
     __slots__ = ('stack', 'time')
 
     def __init__(self, stack, time):
         self.stack = stack
         self.time = time
 
     @classmethod
     def from_frame(cls, frame, time):
         stack = []
 
         while frame:
             stack.append(
                 CodeSite.get(
                     pycompat.sysbytes(frame.f_code.co_filename),
                     frame.f_lineno,
                     pycompat.sysbytes(frame.f_code.co_name),
                 )
             )
             frame = frame.f_back
 
         return Sample(stack, time)
 
 
 ###########################################################################
 ## SIGPROF handler
 
 
 def profile_signal_handler(signum, frame):
     if state.profile_level > 0:
         now = clock()
         state.accumulate_time(now)
 
         timestamp = state.accumulated_time[state.timeidx]
         state.samples.append(Sample.from_frame(frame, timestamp))
 
         signal.setitimer(signal.ITIMER_PROF, state.sample_interval, 0.0)
         state.last_start_time = now
 
 
 stopthread = threading.Event()
 
 
 def samplerthread(tid):
     while not stopthread.is_set():
         now = clock()
         state.accumulate_time(now)
 
         frame = sys._current_frames()[tid]
 
         timestamp = state.accumulated_time[state.timeidx]
         state.samples.append(Sample.from_frame(frame, timestamp))
 
         state.last_start_time = now
         time.sleep(state.sample_interval)
 
     stopthread.clear()
 
 
 ###########################################################################
 ## Profiling API
 
 
 def is_active():
     return state.profile_level > 0
 
 
 lastmechanism = None
 
 
 def start(mechanism=b'thread', track=b'cpu'):
     '''Install the profiling signal handler, and start profiling.'''
     state.track = track  # note: nesting different mode won't work
     state.profile_level += 1
     if state.profile_level == 1:
         state.last_start_time = clock()
         rpt = state.remaining_prof_time
         state.remaining_prof_time = None
 
         global lastmechanism
         lastmechanism = mechanism
 
         if mechanism == b'signal':
             signal.signal(signal.SIGPROF, profile_signal_handler)
             signal.setitimer(
                 signal.ITIMER_PROF, rpt or state.sample_interval, 0.0
             )
         elif mechanism == b'thread':
             frame = inspect.currentframe()
             tid = [k for k, f in sys._current_frames().items() if f == frame][0]
             state.thread = threading.Thread(
                 target=samplerthread, args=(tid,), name="samplerthread"
             )
             state.thread.start()
 
 
 def stop():
     '''Stop profiling, and uninstall the profiling signal handler.'''
     state.profile_level -= 1
     if state.profile_level == 0:
         if lastmechanism == b'signal':
             rpt = signal.setitimer(signal.ITIMER_PROF, 0.0, 0.0)
             signal.signal(signal.SIGPROF, signal.SIG_IGN)
             state.remaining_prof_time = rpt[0]
         elif lastmechanism == b'thread':
             stopthread.set()
             state.thread.join()
 
         state.accumulate_time(clock())
         state.last_start_time = None
         statprofpath = encoding.environ.get(b'STATPROF_DEST')
         if statprofpath:
             save_data(statprofpath)
 
     return state
 
 
 def save_data(path):
     with open(path, b'w+') as file:
         file.write(b"%f %f\n" % state.accumulated_time)
         for sample in state.samples:
             time = sample.time
             stack = sample.stack
             sites = [
                 b'\1'.join([s.path, b'%d' % s.lineno or -1, s.function])
                 for s in stack
             ]
             file.write(b"%d\0%s\n" % (time, b'\0'.join(sites)))
 
 
 def load_data(path):
     lines = open(path, b'rb').read().splitlines()
 
     state.accumulated_time = [float(value) for value in lines[0].split()]
     state.samples = []
     for line in lines[1:]:
         parts = line.split(b'\0')
         time = float(parts[0])
         rawsites = parts[1:]
         sites = []
         for rawsite in rawsites:
             siteparts = rawsite.split(b'\1')
             sites.append(
                 CodeSite.get(siteparts[0], int(siteparts[1]), siteparts[2])
             )
 
         state.samples.append(Sample(sites, time))
 
 
 def reset(frequency=None):
     """Clear out the state of the profiler.  Do not call while the
     profiler is running.
 
     The optional frequency argument specifies the number of samples to
     collect per second."""
     assert state.profile_level == 0, b"Can't reset() while statprof is running"
     CodeSite.cache.clear()
     state.reset(frequency)
 
 
 @contextmanager
 def profile():
     start()
     try:
         yield
     finally:
         stop()
         display()
 
 
 ###########################################################################
 ## Reporting API
 
 
 class SiteStats:
     def __init__(self, site):
         self.site = site
         self.selfcount = 0
         self.totalcount = 0
 
     def addself(self):
         self.selfcount += 1
 
     def addtotal(self):
         self.totalcount += 1
 
     def selfpercent(self):
         return self.selfcount / len(state.samples) * 100
 
     def totalpercent(self):
         return self.totalcount / len(state.samples) * 100
 
     def selfseconds(self):
         return self.selfcount * state.seconds_per_sample()
 
     def totalseconds(self):
         return self.totalcount * state.seconds_per_sample()
 
     @classmethod
     def buildstats(cls, samples):
         stats = {}
 
         for sample in samples:
             for i, site in enumerate(sample.stack):
                 sitestat = stats.get(site)
                 if not sitestat:
                     sitestat = SiteStats(site)
                     stats[site] = sitestat
 
                 sitestat.addtotal()
 
                 if i == 0:
                     sitestat.addself()
 
         return [s for s in stats.values()]
 
 
 class DisplayFormats:
     ByLine = 0
     ByMethod = 1
     AboutMethod = 2
     Hotpath = 3
     FlameGraph = 4
     Json = 5
     Chrome = 6
 
 
 def display(fp=None, format=3, data=None, **kwargs):
     '''Print statistics, either to stdout or the given file object.'''
     if data is None:
         data = state
 
     if fp is None:
         from .utils import procutil
 
         fp = procutil.stdout
     if len(data.samples) == 0:
         fp.write(b'No samples recorded.\n')
         return
 
     if format == DisplayFormats.ByLine:
         display_by_line(data, fp)
     elif format == DisplayFormats.ByMethod:
         display_by_method(data, fp)
     elif format == DisplayFormats.AboutMethod:
         display_about_method(data, fp, **kwargs)
     elif format == DisplayFormats.Hotpath:
         display_hotpath(data, fp, **kwargs)
     elif format == DisplayFormats.FlameGraph:
         write_to_flame(data, fp, **kwargs)
     elif format == DisplayFormats.Json:
         write_to_json(data, fp)
     elif format == DisplayFormats.Chrome:
         write_to_chrome(data, fp, **kwargs)
     else:
         raise Exception("Invalid display format")
 
     if format not in (DisplayFormats.Json, DisplayFormats.Chrome):
         fp.write(b'---\n')
         fp.write(b'Sample count: %d\n' % len(data.samples))
         fp.write(b'Total time: %f seconds (%f wall)\n' % data.accumulated_time)
 
 
 def display_by_line(data, fp):
     """Print the profiler data with each sample line represented
     as one row in a table.  Sorted by self-time per line."""
     stats = SiteStats.buildstats(data.samples)
     stats.sort(reverse=True, key=lambda x: x.selfseconds())
 
     fp.write(
         b'%5.5s %10.10s   %7.7s  %-8.8s\n'
         % (b'%  ', b'cumulative', b'self', b'')
     )
     fp.write(
         b'%5.5s  %9.9s  %8.8s  %-8.8s\n'
         % (b"time", b"seconds", b"seconds", b"name")
     )
 
     for stat in stats:
         site = stat.site
         sitelabel = b'%s:%d:%s' % (
             site.filename(),
             site.lineno or -1,
             site.function,
         )
         fp.write(
             b'%6.2f %9.2f %9.2f  %s\n'
             % (
                 stat.selfpercent(),
                 stat.totalseconds(),
                 stat.selfseconds(),
                 sitelabel,
             )
         )
 
 
 def display_by_method(data, fp):
     """Print the profiler data with each sample function represented
     as one row in a table.  Important lines within that function are
     output as nested rows.  Sorted by self-time per line."""
     fp.write(
         b'%5.5s %10.10s   %7.7s  %-8.8s\n'
         % (b'%  ', b'cumulative', b'self', b'')
     )
     fp.write(
         b'%5.5s  %9.9s  %8.8s  %-8.8s\n'
         % (b"time", b"seconds", b"seconds", b"name")
     )
 
     stats = SiteStats.buildstats(data.samples)
 
     grouped = defaultdict(list)
     for stat in stats:
         grouped[stat.site.filename() + b":" + stat.site.function].append(stat)
 
     # compute sums for each function
     functiondata = []
     for fname, sitestats in grouped.items():
         total_cum_sec = 0
         total_self_sec = 0
         total_percent = 0
         for stat in sitestats:
             total_cum_sec += stat.totalseconds()
             total_self_sec += stat.selfseconds()
             total_percent += stat.selfpercent()
 
         functiondata.append(
             (fname, total_cum_sec, total_self_sec, total_percent, sitestats)
         )
 
     # sort by total self sec
     functiondata.sort(reverse=True, key=lambda x: x[2])
 
     for function in functiondata:
         if function[3] < 0.05:
             continue
         fp.write(
             b'%6.2f %9.2f %9.2f  %s\n'
             % (
                 function[3],  # total percent
                 function[1],  # total cum sec
                 function[2],  # total self sec
                 function[0],
             )
         )  # file:function
 
         function[4].sort(reverse=True, key=lambda i: i.selfseconds())
         for stat in function[4]:
             # only show line numbers for significant locations (>1% time spent)
             if stat.selfpercent() > 1:
                 source = stat.site.getsource(25)
                 if not isinstance(source, bytes):
                     source = pycompat.bytestr(source)
 
                 stattuple = (
                     stat.selfpercent(),
                     stat.selfseconds(),
                     stat.site.lineno or -1,
                     source,
                 )
 
                 fp.write(b'%33.0f%% %6.2f   line %d: %s\n' % stattuple)
 
 
 def display_about_method(data, fp, function=None, **kwargs):
     if function is None:
         raise Exception("Invalid function")
 
     filename = None
     if b':' in function:
         filename, function = function.split(b':')
 
     relevant_samples = 0
     parents = {}
     children = {}
 
     for sample in data.samples:
         for i, site in enumerate(sample.stack):
             if site.function == function and (
                 not filename or site.filename() == filename
             ):
                 relevant_samples += 1
                 if i != len(sample.stack) - 1:
                     parent = sample.stack[i + 1]
                     if parent in parents:
                         parents[parent] = parents[parent] + 1
                     else:
                         parents[parent] = 1
 
                 if site in children:
                     children[site] = children[site] + 1
                 else:
                     children[site] = 1
 
     parents = [(parent, count) for parent, count in parents.items()]
     parents.sort(reverse=True, key=lambda x: x[1])
     for parent, count in parents:
         fp.write(
             b'%6.2f%%   %s:%s   line %s: %s\n'
             % (
                 count / relevant_samples * 100,
                 pycompat.fsencode(parent.filename()),
                 pycompat.sysbytes(parent.function),
                 parent.lineno or -1,
                 pycompat.sysbytes(parent.getsource(50)),
             )
         )
 
     stats = SiteStats.buildstats(data.samples)
     stats = [
         s
         for s in stats
         if s.site.function == function
         and (not filename or s.site.filename() == filename)
     ]
 
     total_cum_sec = 0
     total_self_sec = 0
     total_self_percent = 0
     total_cum_percent = 0
     for stat in stats:
         total_cum_sec += stat.totalseconds()
         total_self_sec += stat.selfseconds()
         total_self_percent += stat.selfpercent()
         total_cum_percent += stat.totalpercent()
 
     fp.write(
         b'\n    %s:%s    Total: %0.2fs (%0.2f%%)    Self: %0.2fs (%0.2f%%)\n\n'
         % (
             pycompat.sysbytes(filename or b'___'),
             pycompat.sysbytes(function),
             total_cum_sec,
             total_cum_percent,
             total_self_sec,
             total_self_percent,
         )
     )
 
     children = [(child, count) for child, count in children.items()]
     children.sort(reverse=True, key=lambda x: x[1])
     for child, count in children:
         fp.write(
             b'        %6.2f%%   line %s: %s\n'
             % (
                 count / relevant_samples * 100,
                 child.lineno or -1,
                 pycompat.sysbytes(child.getsource(50)),
             )
         )
 
 
 def display_hotpath(data, fp, limit=0.05, **kwargs):
     class HotNode:
         def __init__(self, site):
             self.site = site
             self.count = 0
             self.children = {}
 
         def add(self, stack, time):
             self.count += time
             site = stack[0]
             child = self.children.get(site)
             if not child:
                 child = HotNode(site)
                 self.children[site] = child
 
             if len(stack) > 1:
                 i = 1
                 # Skip boiler plate parts of the stack
                 while i < len(stack) and stack[i].skipname() in skips:
                     i += 1
                 if i < len(stack):
                     child.add(stack[i:], time)
             else:
                 # Normally this is done by the .add() calls
                 child.count += time
 
     root = HotNode(None)
     lasttime = data.samples[0].time
     for sample in data.samples:
         root.add(sample.stack[::-1], sample.time - lasttime)
         lasttime = sample.time
     showtime = kwargs.get('showtime', True)
 
     def _write(node, depth, multiple_siblings):
         site = node.site
         visiblechildren = [
             c for c in node.children.values() if c.count >= (limit * root.count)
         ]
         if site:
             indent = depth * 2 - 1
             filename = (site.filename() + b':').ljust(15)
             function = site.function
 
             # lots of string formatting
             listpattern = (
                 b''.ljust(indent)
                 + (b'\\' if multiple_siblings else b'|')
                 + b' %4.1f%%'
                 + (b' %5.2fs' % node.count if showtime else b'')
                 + b'  %s %s'
             )
             liststring = listpattern % (
                 node.count / root.count * 100,
                 filename,
                 function,
             )
             # 4 to account for the word 'line'
             spacing_len = max(4, 55 - len(liststring))
             prefix = b''
             if spacing_len == 4:
                 prefix = b', '
 
             codepattern = b'%s%s %d: %s%s'
             codestring = codepattern % (
                 prefix,
                 b'line'.rjust(spacing_len),
                 site.lineno if site.lineno is not None else -1,
                 b''.ljust(max(0, 4 - len(str(site.lineno)))),
                 site.getsource(30),
             )
 
             finalstring = liststring + codestring
             childrensamples = sum([c.count for c in node.children.values()])
             # Make frames that performed more than 10% of the operation red
             if node.count - childrensamples > (0.1 * root.count):
                 finalstring = b'\033[91m' + finalstring + b'\033[0m'
             # Make frames that didn't actually perform work dark grey
             elif node.count - childrensamples == 0:
                 finalstring = b'\033[90m' + finalstring + b'\033[0m'
             fp.write(finalstring + b'\n')
 
         newdepth = depth
         if len(visiblechildren) > 1 or multiple_siblings:
             newdepth += 1
 
         visiblechildren.sort(reverse=True, key=lambda x: x.count)
         for child in visiblechildren:
             _write(child, newdepth, len(visiblechildren) > 1)
 
     if root.count > 0:
         _write(root, 0, False)
 
 
 def write_to_flame(data, fp, scriptpath=None, outputfile=None, **kwargs):
     if scriptpath is None:
         scriptpath = encoding.environ[b'HOME'] + b'/flamegraph.pl'
     if not os.path.exists(scriptpath):
         fp.write(b'error: missing %s\n' % scriptpath)
         fp.write(b'get it here: https://github.com/brendangregg/FlameGraph\n')
         return
 
     lines = {}
     for sample in data.samples:
         sites = [s.function for s in sample.stack]
         sites.reverse()
         line = b';'.join(sites)
         if line in lines:
             lines[line] = lines[line] + 1
         else:
             lines[line] = 1
 
     fd, path = pycompat.mkstemp()
 
     with open(path, b"w+") as file:
         for line, count in lines.items():
             file.write(b"%s %d\n" % (line, count))
 
     if outputfile is None:
         outputfile = b'~/flamegraph.svg'
 
     os.system(b"perl ~/flamegraph.pl %s > %s" % (path, outputfile))
     fp.write(b'Written to %s\n' % outputfile)
 
 
 _pathcache = {}
 
 
 def simplifypath(path):
     """Attempt to make the path to a Python module easier to read by
     removing whatever part of the Python search path it was found
     on."""
 
     if path in _pathcache:
         return _pathcache[path]
     hgpath = encoding.__file__.rsplit(os.sep, 2)[0]
     for p in [hgpath] + sys.path:
         prefix = p + os.sep
         if path.startswith(prefix):
             path = path[len(prefix) :]
             break
     _pathcache[path] = path
     return path
 
 
 def write_to_json(data, fp):
     samples = []
 
     for sample in data.samples:
         stack = []
 
         for frame in sample.stack:
             stack.append(
                 (
                     pycompat.sysstr(frame.path),
                     frame.lineno or -1,
                     pycompat.sysstr(frame.function),
                 )
             )
 
         samples.append((sample.time, stack))
 
     data = json.dumps(samples)
     if not isinstance(data, bytes):
         data = data.encode('utf-8')
 
     fp.write(data)
 
 
 def write_to_chrome(data, fp, minthreshold=0.005, maxthreshold=0.999):
     samples = []
     laststack = collections.deque()
     lastseen = collections.deque()
 
     # The Chrome tracing format allows us to use a compact stack
     # representation to save space. It's fiddly but worth it.
     # We maintain a bijection between stack and ID.
     stack2id = {}
     id2stack = []  # will eventually be rendered
 
     def stackid(stack):
         if not stack:
             return
         if stack in stack2id:
             return stack2id[stack]
         parent = stackid(stack[1:])
         myid = len(stack2id)
         stack2id[stack] = myid
         id2stack.append(dict(category=stack[0][0], name='%s %s' % stack[0]))
         if parent is not None:
             id2stack[-1].update(parent=parent)
         return myid
 
     # The sampling profiler can sample multiple times without
     # advancing the clock, potentially causing the Chrome trace viewer
     # to render single-pixel columns that we cannot zoom in on.  We
     # work around this by pretending that zero-duration samples are a
     # millisecond in length.
 
     clamp = 0.001
 
     # We provide knobs that by default attempt to filter out stack
     # frames that are too noisy:
     #
     # * A few take almost all execution time. These are usually boring
     #   setup functions, giving a stack that is deep but uninformative.
     #
     # * Numerous samples take almost no time, but introduce lots of
     #   noisy, oft-deep "spines" into a rendered profile.
 
     blacklist = set()
     totaltime = data.samples[-1].time - data.samples[0].time
     minthreshold = totaltime * minthreshold
     maxthreshold = max(totaltime * maxthreshold, clamp)
 
     def poplast():
         oldsid = stackid(tuple(laststack))
         oldcat, oldfunc = laststack.popleft()
         oldtime, oldidx = lastseen.popleft()
         duration = sample.time - oldtime
         if minthreshold <= duration <= maxthreshold:
             # ensure no zero-duration events
             sampletime = max(oldtime + clamp, sample.time)
             samples.append(
                 dict(
                     ph='E',
                     name=oldfunc,
                     cat=oldcat,
                     sf=oldsid,
                     ts=sampletime * 1e6,
                     pid=0,
                 )
             )
         else:
             blacklist.add(oldidx)
 
     # Much fiddling to synthesize correctly(ish) nested begin/end
     # events given only stack snapshots.
 
     for sample in data.samples:
         stack = tuple(
             (
                 (
                     '%s:%d'
                     % (
                         simplifypath(pycompat.sysstr(frame.path)),
                         frame.lineno or -1,
                     ),
                     pycompat.sysstr(frame.function),
                 )
                 for frame in sample.stack
             )
         )
         qstack = collections.deque(stack)
         if laststack == qstack:
             continue
         while laststack and qstack and laststack[-1] == qstack[-1]:
             laststack.pop()
             qstack.pop()
         while laststack:
             poplast()
         for f in reversed(qstack):
             lastseen.appendleft((sample.time, len(samples)))
             laststack.appendleft(f)
             path, name = f
             sid = stackid(tuple(laststack))
             samples.append(
                 dict(
                     ph='B',
                     name=name,
                     cat=path,
                     ts=sample.time * 1e6,
                     sf=sid,
                     pid=0,
                 )
             )
         laststack = collections.deque(stack)
     while laststack:
         poplast()
     events = [
         sample for idx, sample in enumerate(samples) if idx not in blacklist
     ]
     frames = collections.OrderedDict(
         (str(k), v) for (k, v) in enumerate(id2stack)
     )
     data = json.dumps(dict(traceEvents=events, stackFrames=frames), indent=1)
     if not isinstance(data, bytes):
         data = data.encode('utf-8')
     fp.write(data)
     fp.write(b'\n')
 
 
 def printusage():
     print(
         r"""
 The statprof command line allows you to inspect the last profile's results in
 the following forms:
 
 usage:
     hotpath [-l --limit percent]
         Shows a graph of calls with the percent of time each takes.
         Red calls take over 10%% of the total time themselves.
     lines
         Shows the actual sampled lines.
     functions
         Shows the samples grouped by function.
     function [filename:]functionname
         Shows the callers and callees of a particular function.
     flame [-s --script-path] [-o --output-file path]
         Writes out a flamegraph to output-file (defaults to ~/flamegraph.svg)
         Requires that ~/flamegraph.pl exist.
         (Specify alternate script path with --script-path.)"""
     )
 
 
 def main(argv=None):
     if argv is None:
         argv = sys.argv
 
     if len(argv) == 1:
         printusage()
         return 0
 
     displayargs = {}
 
     optstart = 2
     displayargs[b'function'] = None
     if argv[1] == 'hotpath':
         displayargs[b'format'] = DisplayFormats.Hotpath
     elif argv[1] == 'lines':
         displayargs[b'format'] = DisplayFormats.ByLine
     elif argv[1] == 'functions':
         displayargs[b'format'] = DisplayFormats.ByMethod
     elif argv[1] == 'function':
         displayargs[b'format'] = DisplayFormats.AboutMethod
         displayargs[b'function'] = argv[2]
         optstart = 3
     elif argv[1] == 'flame':
         displayargs[b'format'] = DisplayFormats.FlameGraph
     else:
         printusage()
         return 0
 
     # process options
     try:
         opts, args = pycompat.getoptb(
             pycompat.sysargv[optstart:],
             b"hl:f:o:p:",
             [b"help", b"limit=", b"file=", b"output-file=", b"script-path="],
         )
     except getopt.error as msg:
         print(msg)
         printusage()
         return 2
 
     displayargs[b'limit'] = 0.05
     path = None
     for o, value in opts:
         if o in ("-l", "--limit"):
             displayargs[b'limit'] = float(value)
         elif o in ("-f", "--file"):
             path = value
         elif o in ("-o", "--output-file"):
             displayargs[b'outputfile'] = value
         elif o in ("-p", "--script-path"):
             displayargs[b'scriptpath'] = value
         elif o in ("-h", "help"):
             printusage()
             return 0
         else:
             assert False, "unhandled option %s" % o
 
     if not path:
         print('must specify --file to load')
         return 1
 
     load_data(path=path)
 
     display(**pycompat.strkwargs(displayargs))
 
     return 0
 
 
 if __name__ == "__main__":
     sys.exit(main())

tests/hgweberror.py

@@ -1,23 +1,23 b''
 # A dummy extension that installs an hgweb command that throws an Exception.
 
 
 from mercurial.hgweb import webcommands
 
 
 def raiseerror(web):
     '''Dummy web command that raises an uncaught Exception.'''
 
     # Simulate an error after partial response.
     if b'partialresponse' in web.req.qsparams:
         web.res.status = b'200 Script output follows'
         web.res.headers[b'Content-Type'] = b'text/plain'
         web.res.setbodywillwrite()
         list(web.res.sendresponse())
         web.res.getbodyfile().write(b'partial content\n')
 
     raise AttributeError('I am an uncaught error!')
 
 
 def extsetup(ui):
     setattr(webcommands, 'raiseerror', raiseerror)
-    webcommands.__all__.append(b'raiseerror')
+    webcommands.__all__.append('raiseerror')