Mercurial: comparison mercurial/mail.py

equal deleted inserted replaced

-:849a3f81f46c
+:8d9e2c2b6058
 )
 from .utils import (
 procutil,
 stringutil,
 )
+if not globals():  # hide this from non-pytype users
+from typing import Any, List, Tuple, Union
+# keep pyflakes happy
+assert all((Any, List, Tuple, Union))
 class STARTTLS(smtplib.SMTP):
 '''Derived class to verify the peer certificate for STARTTLS.
 self.file = new_socket.makefile('rb')
 return new_socket
 def _pyhastls():
+# type: () -> bool
 """Returns true iff Python has TLS support, false otherwise."""
 try:
 import ssl
 getattr(ssl, 'HAS_TLS', False)
 _(b'%r specified as email transport, but not in PATH') % method
 )
 def codec2iana(cs):
+# type: (bytes) -> bytes
 ''''''
-cs = pycompat.sysbytes(email.charset.Charset(cs).input_charset.lower())
+cs = pycompat.sysbytes(
+email.charset.Charset(
+cs  # pytype: disable=wrong-arg-types
+).input_charset.lower()
+)
 # "latin1" normalizes to "iso8859-1", standard calls for "iso-8859-1"
 if cs.startswith(b"iso") and not cs.startswith(b"iso-"):
 return b"iso-" + cs[3:]
 return cs
 def mimetextpatch(s, subtype=b'plain', display=False):
+# type: (bytes, bytes, bool) -> email.message.Message
 '''Return MIME message suitable for a patch.
 Charset will be detected by first trying to decode as us-ascii, then utf-8,
 and finally the global encodings. If all those fail, fall back to
 ISO-8859-1, an encoding with that allows all byte sequences.
 Transfer encodings will be used if necessary.'''
 return mimetextqp(s, subtype, b"iso-8859-1")
 def mimetextqp(body, subtype, charset):
+# type: (bytes, bytes, bytes) -> email.message.Message
 '''Return MIME message.
 Quoted-printable transfer encoding will be used if necessary.
 '''
 # Experimentally charset is okay as a bytes even if the type
 # stubs disagree.
 return msg
 def _charsets(ui):
+# type: (Any) -> List[bytes]
 '''Obtains charsets to send mail parts not containing patches.'''
-charsets = [cs.lower() for cs in ui.configlist(b'email', b'charsets')]
+charsets = [
+cs.lower() for cs in ui.configlist(b'email', b'charsets')
+]  # type: List[bytes]
 fallbacks = [
 encoding.fallbackencoding.lower(),
 encoding.encoding.lower(),
 b'utf-8',
-]
+]  # type: List[bytes]
 for cs in fallbacks:  # find unique charsets while keeping order
 if cs not in charsets:
 charsets.append(cs)
 return [cs for cs in charsets if not cs.endswith(b'ascii')]
 def _encode(ui, s, charsets):
+# type: (Any, bytes, List[bytes]) -> Tuple[bytes, bytes]
 '''Returns (converted) string, charset tuple.
 Finds out best charset by cycling through sendcharsets in descending
 order. Tries both encoding and fallbackencoding for input. Only as
 last resort send as is in fake ascii.
 Caveat: Do not use for mail parts containing patches!'''
 # if ascii, or all conversion attempts fail, send (broken) ascii
 return s, b'us-ascii'
 def headencode(ui, s, charsets=None, display=False):
+# type: (Any, Union[bytes, str], List[bytes], bool) -> str
 '''Returns RFC-2047 compliant header from given string.'''
 if not display:
 # split into words?
 s, cs = _encode(ui, s, charsets)
-return email.header.Header(s, cs).encode()
+return email.header.Header(
+s, cs  # pytype: disable=wrong-arg-types
+).encode()
 return encoding.strfromlocal(s)
 def _addressencode(ui, name, addr, charsets=None):
+# type: (Any, str, bytes, List[bytes]) -> str
 assert isinstance(addr, bytes)
 name = headencode(ui, name, charsets)
 try:
 acc, dom = addr.split(b'@')
 acc.decode('ascii')
 raise error.Abort(_(b'invalid local address: %s') % addr)
 return email.utils.formataddr((name, encoding.strfromlocal(addr)))
 def addressencode(ui, address, charsets=None, display=False):
+# type: (Any, bytes, List[bytes], bool) -> str
 '''Turns address into RFC-2047 compliant header.'''
 if display or not address:
 return encoding.strfromlocal(address or b'')
 name, addr = email.utils.parseaddr(encoding.strfromlocal(address))
 return _addressencode(ui, name, encoding.strtolocal(addr), charsets)
 def addrlistencode(ui, addrs, charsets=None, display=False):
+# type: (Any, List[bytes], List[bytes], bool) -> List[str]
 '''Turns a list of addresses into a list of RFC-2047 compliant headers.
 A single element of input list may contain multiple addresses, but output
 always has one address per item'''
 straddrs = []
 for a in addrs:
 result.append(r)
 return result
 def mimeencode(ui, s, charsets=None, display=False):
+# type: (Any, bytes, List[bytes], bool) -> email.message.Message
 '''creates mime text object, encodes it if needed, and sets
 charset and transfer-encoding accordingly.'''
 cs = b'us-ascii'
 if not display:
 s, cs = _encode(ui, s, charsets)
 if pycompat.ispy3:
 Generator = email.generator.BytesGenerator
 def parse(fp):
+# type: (Any) -> email.message.Message
 ep = email.parser.Parser()
 # disable the "universal newlines" mode, which isn't binary safe.
 # I have no idea if ascii/surrogateescape is correct, but that's
 # what the standard Python email parser does.
 fp = io.TextIOWrapper(
 return ep.parse(fp)
 finally:
 fp.detach()
 def parsebytes(data):
+# type: (bytes) -> email.message.Message
 ep = email.parser.BytesParser()
 return ep.parsebytes(data)
 else:
 Generator = email.generator.Generator
 def parse(fp):
+# type: (Any) -> email.message.Message
 ep = email.parser.Parser()
 return ep.parse(fp)
 def parsebytes(data):
+# type: (str) -> email.message.Message
 ep = email.parser.Parser()
 return ep.parsestr(data)
 def headdecode(s):
+# type: (Union[email.header.Header, bytes]) -> bytes
 '''Decodes RFC-2047 header'''
 uparts = []
 for part, charset in email.header.decode_header(s):
 if charset is not None:
 try:

changeset 43625	8d9e2c2b6058
parent 43624	849a3f81f46c
child 43626	bdb0ddab7bb3