mercurial-scm/hg-stable: mercurial/utils/stringutil.py annotate

annotate mercurial/utils/stringutil.py @ 37248:0e7550b0964c

stringutil: improve check for failed mailmap line parsing The existing check for a bad mailmap file entry fails with inputs like b'>@<'. This commit adds a function to check if a sufficient amount of information has been parsed from a mailmap file entry. At minimum, one email must be found (assumed to be the commit email). If email is not empty and no names are found, then there must be two emails. If there are at least one email and name, the mapping is valid. Differential Revision: https://phab.mercurial-scm.org/D3003

author	Connor Sheehan <sheehan@mozilla.com>
date	Sat, 31 Mar 2018 11:36:55 -0400
parents	54b896f195d1
children	2ed180117f76

rev	line source
37086 f99d64e8a4e4 stringutil: move generic string helpers to new module Yuya Nishihara <yuya@tcha.org> parents: 37085 diff changeset	1 # stringutil.py - utility for generic string formatting, parsing, etc.
8226 8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	2 #
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	3 # Copyright 2005 K. Thananchayan <thananck@yahoo.com>
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	4 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	5 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	6 #
8b2cd04a6e97 put license and copyright info into comment blocks Martin Geisler <mg@lazybytes.net> parents: 8225 diff changeset	7 # This software may be used and distributed according to the terms of the
10263 25e572394f5c Update license to GPLv2+ Matt Mackall <mpm@selenic.com> parents: 9996 diff changeset	8 # GNU General Public License version 2 or any later version.
1082 ce96e316278a Update util.py docstrings, fix walk test mpm@selenic.com parents: 1081 diff changeset	9
37086 f99d64e8a4e4 stringutil: move generic string helpers to new module Yuya Nishihara <yuya@tcha.org> parents: 37085 diff changeset	10 from __future__ import absolute_import
1082 ce96e316278a Update util.py docstrings, fix walk test mpm@selenic.com parents: 1081 diff changeset	11
31462 3b7a6941a6ef py3: call codecs.escape_encode() directly Yuya Nishihara <yuya@tcha.org> parents: 31460 diff changeset	12 import codecs
21907 7e5dfa00e3c2 util: rename 're' to 'remod' Siddharth Agarwal <sid0@fb.com> parents: 21857 diff changeset	13 import re as remod
27358 ac839ee45b6a util: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27357 diff changeset	14 import textwrap
3769 96095d9ff1f8 Add encoding detection Matt Mackall <mpm@selenic.com> parents: 3767 diff changeset	15
37086 f99d64e8a4e4 stringutil: move generic string helpers to new module Yuya Nishihara <yuya@tcha.org> parents: 37085 diff changeset	16 from ..i18n import _
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	17 from ..thirdparty import attr
37086 f99d64e8a4e4 stringutil: move generic string helpers to new module Yuya Nishihara <yuya@tcha.org> parents: 37085 diff changeset	18
f99d64e8a4e4 stringutil: move generic string helpers to new module Yuya Nishihara <yuya@tcha.org> parents: 37085 diff changeset	19 from .. import (
27358 ac839ee45b6a util: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27357 diff changeset	20 encoding,
ac839ee45b6a util: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27357 diff changeset	21 error,
28818 6041fb8f2da8 pycompat: add empty and queue to handle py3 divergence timeless <timeless@mozdev.org> parents: 28497 diff changeset	22 pycompat,
27358 ac839ee45b6a util: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27357 diff changeset	23 )
37013 8453699a1f21 util: observable proxy objects for sockets Gregory Szorc <gregory.szorc@gmail.com> parents: 36994 diff changeset	24
37084 191cba70fe27 util: mark internal constants of escapedata() as private Yuya Nishihara <yuya@tcha.org> parents: 37083 diff changeset	25 _DATA_ESCAPE_MAP = {pycompat.bytechr(i): br'\x%02x' % i for i in range(256)}
191cba70fe27 util: mark internal constants of escapedata() as private Yuya Nishihara <yuya@tcha.org> parents: 37083 diff changeset	26 _DATA_ESCAPE_MAP.update({
36553 bfe38f787d5b util: add a file object proxy that can notify observers Gregory Szorc <gregory.szorc@gmail.com> parents: 36462 diff changeset	27 b'\\': b'\\\\',
bfe38f787d5b util: add a file object proxy that can notify observers Gregory Szorc <gregory.szorc@gmail.com> parents: 36462 diff changeset	28 b'\r': br'\r',
bfe38f787d5b util: add a file object proxy that can notify observers Gregory Szorc <gregory.szorc@gmail.com> parents: 36462 diff changeset	29 b'\n': br'\n',
bfe38f787d5b util: add a file object proxy that can notify observers Gregory Szorc <gregory.szorc@gmail.com> parents: 36462 diff changeset	30 })
37084 191cba70fe27 util: mark internal constants of escapedata() as private Yuya Nishihara <yuya@tcha.org> parents: 37083 diff changeset	31 _DATA_ESCAPE_RE = remod.compile(br'[\x00-\x08\x0a-\x1f\\\x7f-\xff]')
36553 bfe38f787d5b util: add a file object proxy that can notify observers Gregory Szorc <gregory.szorc@gmail.com> parents: 36462 diff changeset	32
bfe38f787d5b util: add a file object proxy that can notify observers Gregory Szorc <gregory.szorc@gmail.com> parents: 36462 diff changeset	33 def escapedata(s):
36658 c98d1c6763a6 util: teach escapedata() about bytearray Gregory Szorc <gregory.szorc@gmail.com> parents: 36636 diff changeset	34 if isinstance(s, bytearray):
c98d1c6763a6 util: teach escapedata() about bytearray Gregory Szorc <gregory.szorc@gmail.com> parents: 36636 diff changeset	35 s = bytes(s)
c98d1c6763a6 util: teach escapedata() about bytearray Gregory Szorc <gregory.szorc@gmail.com> parents: 36636 diff changeset	36
37084 191cba70fe27 util: mark internal constants of escapedata() as private Yuya Nishihara <yuya@tcha.org> parents: 37083 diff changeset	37 return _DATA_ESCAPE_RE.sub(lambda m: _DATA_ESCAPE_MAP[m.group(0)], s)
36553 bfe38f787d5b util: add a file object proxy that can notify observers Gregory Szorc <gregory.szorc@gmail.com> parents: 36462 diff changeset	38
1015 22571b8d35d3 Add automatic binary file detection to diff and export mpm@selenic.com parents: 917 diff changeset	39 def binary(s):
6507 9699864de219 Let util.binary check entire data for \0 (issue1066, issue1079) Christian Ebert <blacktrash@gmx.net> parents: 6501 diff changeset	40 """return true if a string is binary data"""
8118 35f7fda52c92 util: return boolean result directly in util.binary Martin Geisler <mg@lazybytes.net> parents: 8011 diff changeset	41 return bool(s and '\0' in s)
6762 f67d1468ac50 util: add sort helper Matt Mackall <mpm@selenic.com> parents: 6746 diff changeset	42
30773 c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	43 def stringmatcher(pattern, casesensitive=True):
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	44 """
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	45 accepts a string, possibly starting with 're:' or 'literal:' prefix.
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	46 returns the matcher name, pattern, and matcher function.
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	47 missing or unknown prefixes are treated as literal matches.
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	48
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	49 helper for tests:
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	50 >>> def test(pattern, *tests):
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	51 ... kind, pattern, matcher = stringmatcher(pattern)
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	52 ... return (kind, pattern, [bool(matcher(t)) for t in tests])
30773 c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	53 >>> def itest(pattern, *tests):
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	54 ... kind, pattern, matcher = stringmatcher(pattern, casesensitive=False)
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	55 ... return (kind, pattern, [bool(matcher(t)) for t in tests])
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	56
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	57 exact matching (no prefix):
34146 0fa781320203 doctest: bulk-replace string literals with b'' for Python 3 Yuya Nishihara <yuya@tcha.org> parents: 34101 diff changeset	58 >>> test(b'abcdefg', b'abc', b'def', b'abcdefg')
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	59 ('literal', 'abcdefg', [False, False, True])
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	60
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	61 regex matching ('re:' prefix)
34146 0fa781320203 doctest: bulk-replace string literals with b'' for Python 3 Yuya Nishihara <yuya@tcha.org> parents: 34101 diff changeset	62 >>> test(b're:a.+b', b'nomatch', b'fooadef', b'fooadefbar')
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	63 ('re', 'a.+b', [False, False, True])
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	64
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	65 force exact matches ('literal:' prefix)
34146 0fa781320203 doctest: bulk-replace string literals with b'' for Python 3 Yuya Nishihara <yuya@tcha.org> parents: 34101 diff changeset	66 >>> test(b'literal:re:foobar', b'foobar', b're:foobar')
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	67 ('literal', 're:foobar', [False, True])
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	68
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	69 unknown prefixes are ignored and treated as literals
34146 0fa781320203 doctest: bulk-replace string literals with b'' for Python 3 Yuya Nishihara <yuya@tcha.org> parents: 34101 diff changeset	70 >>> test(b'foo:bar', b'foo', b'bar', b'foo:bar')
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	71 ('literal', 'foo:bar', [False, False, True])
30773 c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	72
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	73 case insensitive regex matches
34146 0fa781320203 doctest: bulk-replace string literals with b'' for Python 3 Yuya Nishihara <yuya@tcha.org> parents: 34101 diff changeset	74 >>> itest(b're:A.+b', b'nomatch', b'fooadef', b'fooadefBar')
30773 c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	75 ('re', 'A.+b', [False, False, True])
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	76
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	77 case insensitive literal matches
34146 0fa781320203 doctest: bulk-replace string literals with b'' for Python 3 Yuya Nishihara <yuya@tcha.org> parents: 34101 diff changeset	78 >>> itest(b'ABCDEFG', b'abc', b'def', b'abcdefg')
30773 c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	79 ('literal', 'ABCDEFG', [False, False, True])
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	80 """
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	81 if pattern.startswith('re:'):
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	82 pattern = pattern[3:]
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	83 try:
30773 c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	84 flags = 0
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	85 if not casesensitive:
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	86 flags = remod.I
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	87 regex = remod.compile(pattern, flags)
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	88 except remod.error as e:
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	89 raise error.ParseError(_('invalid regular expression: %s')
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	90 % e)
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	91 return 're', pattern, regex.search
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	92 elif pattern.startswith('literal:'):
7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	93 pattern = pattern[8:]
30773 c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	94
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	95 match = pattern.__eq__
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	96
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	97 if not casesensitive:
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	98 ipat = encoding.lower(pattern)
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	99 match = lambda s: ipat == encoding.lower(s)
c390b40fe1d7 util: teach stringmatcher to handle forced case insensitive matches Matt Harbison <matt_harbison@yahoo.com> parents: 30761 diff changeset	100 return 'literal', pattern, match
26481 7d132557e44a util: extract stringmatcher() from revset Matt Harbison <matt_harbison@yahoo.com> parents: 26480 diff changeset	101
1903 e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	102 def shortuser(user):
e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	103 """Return a short representation of a user name or email address."""
e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	104 f = user.find('@')
e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	105 if f >= 0:
e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	106 user = user[:f]
e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	107 f = user.find('<')
e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	108 if f >= 0:
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10264 diff changeset	109 user = user[f + 1:]
3176 7492b33bdd9f shortuser should stop before the first space character. Thomas Arendsen Hein <thomas@intevation.de> parents: 3147 diff changeset	110 f = user.find(' ')
7492b33bdd9f shortuser should stop before the first space character. Thomas Arendsen Hein <thomas@intevation.de> parents: 3147 diff changeset	111 if f >= 0:
7492b33bdd9f shortuser should stop before the first space character. Thomas Arendsen Hein <thomas@intevation.de> parents: 3147 diff changeset	112 user = user[:f]
3533 bb44489b901f shortname: truncate at '.' too Matt Mackall <mpm@selenic.com> parents: 3466 diff changeset	113 f = user.find('.')
bb44489b901f shortname: truncate at '.' too Matt Mackall <mpm@selenic.com> parents: 3466 diff changeset	114 if f >= 0:
bb44489b901f shortname: truncate at '.' too Matt Mackall <mpm@selenic.com> parents: 3466 diff changeset	115 user = user[:f]
1903 e4abeafd6eb1 move shortuser into util module. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1635 diff changeset	116 return user
1920 b7cc0f323a4c merge with crew. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1903 1882 diff changeset	117
16360 e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	118 def emailuser(user):
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	119 """Return the user portion of an email address."""
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	120 f = user.find('@')
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	121 if f >= 0:
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	122 user = user[:f]
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	123 f = user.find('<')
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	124 if f >= 0:
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	125 user = user[f + 1:]
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	126 return user
e5788269741a templates/filters: extracting the user portion of an email address Matteo Capobianco <m.capobianco@gmail.com> parents: 15720 diff changeset	127
5975 75d9fe70c654 templater: move email function to util Matt Mackall <mpm@selenic.com> parents: 5949 diff changeset	128 def email(author):
75d9fe70c654 templater: move email function to util Matt Mackall <mpm@selenic.com> parents: 5949 diff changeset	129 '''get email of author.'''
75d9fe70c654 templater: move email function to util Matt Mackall <mpm@selenic.com> parents: 5949 diff changeset	130 r = author.find('>')
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10264 diff changeset	131 if r == -1:
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10264 diff changeset	132 r = None
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10264 diff changeset	133 return author[author.find('<') + 1:r]
5975 75d9fe70c654 templater: move email function to util Matt Mackall <mpm@selenic.com> parents: 5949 diff changeset	134
37158 fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	135 def person(author):
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	136 """Returns the name before an email address,
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	137 interpreting it as per RFC 5322
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	138
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	139 >>> person(b'foo@bar')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	140 'foo'
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	141 >>> person(b'Foo Bar <foo@bar>')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	142 'Foo Bar'
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	143 >>> person(b'"Foo Bar" <foo@bar>')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	144 'Foo Bar'
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	145 >>> person(b'"Foo \"buz\" Bar" <foo@bar>')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	146 'Foo "buz" Bar'
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	147 >>> # The following are invalid, but do exist in real-life
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	148 ...
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	149 >>> person(b'Foo "buz" Bar <foo@bar>')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	150 'Foo "buz" Bar'
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	151 >>> person(b'"Foo Bar <foo@bar>')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	152 'Foo Bar'
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	153 """
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	154 if '@' not in author:
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	155 return author
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	156 f = author.find('<')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	157 if f != -1:
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	158 return author[:f].strip(' "').replace('\\"', '"')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	159 f = author.find('@')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	160 return author[:f].replace('.', ' ')
fb7140f1d09d stringutil: move person function from templatefilters Connor Sheehan <sheehan@mozilla.com> parents: 37157 diff changeset	161
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	162 @attr.s(hash=True)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	163 class mailmapping(object):
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	164 '''Represents a username/email key or value in
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	165 a mailmap file'''
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	166 email = attr.ib()
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	167 name = attr.ib(default=None)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	168
37248 0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	169 def _ismailmaplineinvalid(names, emails):
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	170 '''Returns True if the parsed names and emails
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	171 in a mailmap entry are invalid.
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	172
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	173 >>> # No names or emails fails
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	174 >>> names, emails = [], []
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	175 >>> _ismailmaplineinvalid(names, emails)
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	176 True
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	177 >>> # Only one email fails
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	178 >>> emails = [b'email@email.com']
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	179 >>> _ismailmaplineinvalid(names, emails)
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	180 True
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	181 >>> # One email and one name passes
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	182 >>> names = [b'Test Name']
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	183 >>> _ismailmaplineinvalid(names, emails)
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	184 False
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	185 >>> # No names but two emails passes
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	186 >>> names = []
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	187 >>> emails = [b'proper@email.com', b'commit@email.com']
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	188 >>> _ismailmaplineinvalid(names, emails)
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	189 False
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	190 '''
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	191 return not emails or not names and len(emails) < 2
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	192
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	193 def parsemailmap(mailmapcontent):
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	194 """Parses data in the .mailmap format
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	195
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	196 >>> mmdata = b"\\n".join([
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	197 ... b'# Comment',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	198 ... b'Name <commit1@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	199 ... b'<name@email.xx> <commit2@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	200 ... b'Name <proper@email.xx> <commit3@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	201 ... b'Name <proper@email.xx> Commit <commit4@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	202 ... ])
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	203 >>> mm = parsemailmap(mmdata)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	204 >>> for key in sorted(mm.keys()):
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	205 ... print(key)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	206 mailmapping(email='commit1@email.xx', name=None)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	207 mailmapping(email='commit2@email.xx', name=None)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	208 mailmapping(email='commit3@email.xx', name=None)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	209 mailmapping(email='commit4@email.xx', name='Commit')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	210 >>> for val in sorted(mm.values()):
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	211 ... print(val)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	212 mailmapping(email='commit1@email.xx', name='Name')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	213 mailmapping(email='name@email.xx', name=None)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	214 mailmapping(email='proper@email.xx', name='Name')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	215 mailmapping(email='proper@email.xx', name='Name')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	216 """
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	217 mailmap = {}
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	218
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	219 if mailmapcontent is None:
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	220 return mailmap
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	221
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	222 for line in mailmapcontent.splitlines():
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	223
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	224 # Don't bother checking the line if it is a comment or
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	225 # is an improperly formed author field
37248 0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	226 if line.lstrip().startswith('#'):
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	227 continue
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	228
37247 54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	229 # names, emails hold the parsed emails and names for each line
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	230 # name_builder holds the words in a persons name
37247 54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	231 names, emails = [], []
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	232 namebuilder = []
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	233
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	234 for element in line.split():
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	235 if element.startswith('#'):
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	236 # If we reach a comment in the mailmap file, move on
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	237 break
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	238
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	239 elif element.startswith('<') and element.endswith('>'):
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	240 # We have found an email.
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	241 # Parse it, and finalize any names from earlier
37247 54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	242 emails.append(element[1:-1]) # Slice off the "<>"
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	243
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	244 if namebuilder:
37247 54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	245 names.append(' '.join(namebuilder))
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	246 namebuilder = []
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	247
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	248 # Break if we have found a second email, any other
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	249 # data does not fit the spec for .mailmap
37247 54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	250 if len(emails) > 1:
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	251 break
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	252
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	253 else:
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	254 # We have found another word in the committers name
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	255 namebuilder.append(element)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	256
37248 0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	257 # Check to see if we have parsed the line into a valid form
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	258 # We require at least one email, and either at least one
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	259 # name or a second email
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	260 if _ismailmaplineinvalid(names, emails):
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	261 continue
0e7550b0964c stringutil: improve check for failed mailmap line parsing Connor Sheehan <sheehan@mozilla.com> parents: 37247 diff changeset	262
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	263 mailmapkey = mailmapping(
37247 54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	264 email=emails[-1],
54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	265 name=names[-1] if len(names) == 2 else None,
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	266 )
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	267
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	268 mailmap[mailmapkey] = mailmapping(
37247 54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	269 email=emails[0],
54b896f195d1 stringutil: rename local email/names variables to their plural forms Connor Sheehan <sheehan@mozilla.com> parents: 37212 diff changeset	270 name=names[0] if names else None,
37212 2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	271 )
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	272
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	273 return mailmap
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	274
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	275 def mapname(mailmap, author):
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	276 """Returns the author field according to the mailmap cache, or
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	277 the original author field.
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	278
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	279 >>> mmdata = b"\\n".join([
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	280 ... b'# Comment',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	281 ... b'Name <commit1@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	282 ... b'<name@email.xx> <commit2@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	283 ... b'Name <proper@email.xx> <commit3@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	284 ... b'Name <proper@email.xx> Commit <commit4@email.xx>',
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	285 ... ])
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	286 >>> m = parsemailmap(mmdata)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	287 >>> mapname(m, b'Commit <commit1@email.xx>')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	288 'Name <commit1@email.xx>'
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	289 >>> mapname(m, b'Name <commit2@email.xx>')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	290 'Name <name@email.xx>'
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	291 >>> mapname(m, b'Commit <commit3@email.xx>')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	292 'Name <proper@email.xx>'
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	293 >>> mapname(m, b'Commit <commit4@email.xx>')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	294 'Name <proper@email.xx>'
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	295 >>> mapname(m, b'Unknown Name <unknown@email.com>')
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	296 'Unknown Name <unknown@email.com>'
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	297 """
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	298 # If the author field coming in isn't in the correct format,
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	299 # or the mailmap is empty just return the original author field
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	300 if not isauthorwellformed(author) or not mailmap:
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	301 return author
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	302
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	303 # Turn the user name into a mailmaptup
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	304 commit = mailmapping(name=person(author), email=email(author))
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	305
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	306 try:
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	307 # Try and use both the commit email and name as the key
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	308 proper = mailmap[commit]
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	309
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	310 except KeyError:
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	311 # If the lookup fails, use just the email as the key instead
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	312 # We call this commit2 as not to erase original commit fields
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	313 commit2 = mailmapping(email=commit.email)
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	314 proper = mailmap.get(commit2, mailmapping(None, None))
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	315
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	316 # Return the author field with proper values filled in
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	317 return '%s <%s>' % (
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	318 proper.name if proper.name else commit.name,
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	319 proper.email if proper.email else commit.email,
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	320 )
2a2ce93e12f4 templatefuncs: add mailmap template function Connor Sheehan <sheehan@mozilla.com> parents: 37158 diff changeset	321
37157 f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	322 _correctauthorformat = remod.compile(br'^[^<]+\s\<[^<>]+@[^<>]+\>$')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	323
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	324 def isauthorwellformed(author):
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	325 '''Return True if the author field is well formed
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	326 (ie "Contributor Name <contrib@email.dom>")
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	327
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	328 >>> isauthorwellformed(b'Good Author <good@author.com>')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	329 True
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	330 >>> isauthorwellformed(b'Author <good@author.com>')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	331 True
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	332 >>> isauthorwellformed(b'Bad Author')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	333 False
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	334 >>> isauthorwellformed(b'Bad Author <author@author.com')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	335 False
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	336 >>> isauthorwellformed(b'Bad Author author@author.com')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	337 False
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	338 >>> isauthorwellformed(b'<author@author.com>')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	339 False
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	340 >>> isauthorwellformed(b'Bad Author <author>')
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	341 False
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	342 '''
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	343 return _correctauthorformat.match(author) is not None
f8e1f48de118 stringutil: add isauthorwellformed function Connor Sheehan <sheehan@mozilla.com> parents: 37086 diff changeset	344
3767 1861fa38a6a7 Move ellipsis code to util.ellipsis() and improve maxlength handling. Thomas Arendsen Hein <thomas@intevation.de> parents: 3721 diff changeset	345 def ellipsis(text, maxlength=400):
21857 86c2d792a4b7 util: replace 'ellipsis' implementation by 'encoding.trim' FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 21813 diff changeset	346 """Trim string to at most maxlength (default: 400) columns in display."""
86c2d792a4b7 util: replace 'ellipsis' implementation by 'encoding.trim' FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 21813 diff changeset	347 return encoding.trim(text, maxlength, ellipsis='...')
3767 1861fa38a6a7 Move ellipsis code to util.ellipsis() and improve maxlength handling. Thomas Arendsen Hein <thomas@intevation.de> parents: 3721 diff changeset	348
31460 53865692a354 util: wrap s.encode('string_escape') call for future py3 compatibility Yuya Nishihara <yuya@tcha.org> parents: 31458 diff changeset	349 def escapestr(s):
31462 3b7a6941a6ef py3: call codecs.escape_encode() directly Yuya Nishihara <yuya@tcha.org> parents: 31460 diff changeset	350 # call underlying function of s.encode('string_escape') directly for
3b7a6941a6ef py3: call codecs.escape_encode() directly Yuya Nishihara <yuya@tcha.org> parents: 31460 diff changeset	351 # Python 3 compatibility
3b7a6941a6ef py3: call codecs.escape_encode() directly Yuya Nishihara <yuya@tcha.org> parents: 31460 diff changeset	352 return codecs.escape_encode(s)[0]
31460 53865692a354 util: wrap s.encode('string_escape') call for future py3 compatibility Yuya Nishihara <yuya@tcha.org> parents: 31458 diff changeset	353
31491 afb335353d28 util: wrap s.decode('string_escape') calls for future py3 compatibility Yuya Nishihara <yuya@tcha.org> parents: 31474 diff changeset	354 def unescapestr(s):
31492 cad95575dc46 py3: call codecs.escape_decode() directly Yuya Nishihara <yuya@tcha.org> parents: 31491 diff changeset	355 return codecs.escape_decode(s)[0]
31491 afb335353d28 util: wrap s.decode('string_escape') calls for future py3 compatibility Yuya Nishihara <yuya@tcha.org> parents: 31474 diff changeset	356
33708 1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	357 def forcebytestr(obj):
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	358 """Portably format an arbitrary object (e.g. exception) into a byte
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	359 string."""
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	360 try:
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	361 return pycompat.bytestr(obj)
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	362 except UnicodeEncodeError:
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	363 # non-ascii string, may be lossy
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	364 return pycompat.bytestr(encoding.strtolocal(str(obj)))
1d5e497c08b3 py3: convert arbitrary exception object to byte string more reliably Yuya Nishihara <yuya@tcha.org> parents: 33691 diff changeset	365
5291 23651848d638 extdiff: avoid repr() doubling paths backslashes under Windows Patrick Mezard <pmezard@gmail.com> parents: 5213 diff changeset	366 def uirepr(s):
23651848d638 extdiff: avoid repr() doubling paths backslashes under Windows Patrick Mezard <pmezard@gmail.com> parents: 5213 diff changeset	367 # Avoid double backslash in Windows path repr()
36299 1fa33bd848ee py3: fix bytes-unicode dance while building docstring of extdiff Yuya Nishihara <yuya@tcha.org> parents: 36272 diff changeset	368 return pycompat.byterepr(pycompat.bytestr(s)).replace(b'\\\\', b'\\')
7547 4949729ee9ee python implementation of diffstat Alexander Solovyov <piranha@piranha.org.ua> parents: 7537 diff changeset	369
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	370 # delay import of textwrap
37082 736024df4498 util: mark MBTextWrapper as private Yuya Nishihara <yuya@tcha.org> parents: 37081 diff changeset	371 def _MBTextWrapper(**kwargs):
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	372 class tw(textwrap.TextWrapper):
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	373 """
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	374 Extend TextWrapper for width-awareness.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	375
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	376 Neither number of 'bytes' in any encoding nor 'characters' is
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	377 appropriate to calculate terminal columns for specified string.
12957 9f2ac318b92e util: clarify purpose of MBTextWrapper class Nicolas Dumazet <nicdumz.commits@gmail.com> parents: 12938 diff changeset	378
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	379 Original TextWrapper implementation uses built-in 'len()' directly,
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	380 so overriding is needed to use width information of each characters.
12957 9f2ac318b92e util: clarify purpose of MBTextWrapper class Nicolas Dumazet <nicdumz.commits@gmail.com> parents: 12938 diff changeset	381
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	382 In addition, characters classified into 'ambiguous' width are
17424 e7cfe3587ea4 fix trivial spelling errors Mads Kiilerich <mads@kiilerich.com> parents: 17391 diff changeset	383 treated as wide in East Asian area, but as narrow in other.
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	384
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	385 This requires use decision to determine width of such characters.
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	386 """
15065 24a6c3f903bb util: wrap lines with multi-byte characters correctly (issue2943) Mads Kiilerich <mads@kiilerich.com> parents: 15024 diff changeset	387 def _cutdown(self, ucstr, space_left):
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	388 l = 0
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	389 colwidth = encoding.ucolwidth
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	390 for i in xrange(len(ucstr)):
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	391 l += colwidth(ucstr[i])
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	392 if space_left < l:
15065 24a6c3f903bb util: wrap lines with multi-byte characters correctly (issue2943) Mads Kiilerich <mads@kiilerich.com> parents: 15024 diff changeset	393 return (ucstr[:i], ucstr[i:])
24a6c3f903bb util: wrap lines with multi-byte characters correctly (issue2943) Mads Kiilerich <mads@kiilerich.com> parents: 15024 diff changeset	394 return ucstr, ''
11297 d320e70442a5 replace Python standard textwrap by MBCS sensitive one for i18n text FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 11256 diff changeset	395
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	396 # overriding of base class
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	397 def _handle_long_word(self, reversed_chunks, cur_line, cur_len, width):
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	398 space_left = max(width - cur_len, 1)
11297 d320e70442a5 replace Python standard textwrap by MBCS sensitive one for i18n text FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 11256 diff changeset	399
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	400 if self.break_long_words:
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	401 cut, res = self._cutdown(reversed_chunks[-1], space_left)
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	402 cur_line.append(cut)
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	403 reversed_chunks[-1] = res
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	404 elif not cur_line:
d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	405 cur_line.append(reversed_chunks.pop())
11297 d320e70442a5 replace Python standard textwrap by MBCS sensitive one for i18n text FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 11256 diff changeset	406
26201 c5b2074ae8c0 util: capitalize Python in MBTextWrapper._wrap_chunks comment timeless@mozdev.org parents: 26126 diff changeset	407 # this overriding code is imported from TextWrapper of Python 2.6
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	408 # to calculate columns of string by 'encoding.ucolwidth()'
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	409 def _wrap_chunks(self, chunks):
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	410 colwidth = encoding.ucolwidth
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	411
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	412 lines = []
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	413 if self.width <= 0:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	414 raise ValueError("invalid width %r (must be > 0)" % self.width)
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	415
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	416 # Arrange in reverse order so items can be efficiently popped
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	417 # from a stack of chucks.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	418 chunks.reverse()
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	419
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	420 while chunks:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	421
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	422 # Start the list of chunks that will make up the current line.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	423 # cur_len is just the length of all the chunks in cur_line.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	424 cur_line = []
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	425 cur_len = 0
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	426
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	427 # Figure out which static string will prefix this line.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	428 if lines:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	429 indent = self.subsequent_indent
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	430 else:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	431 indent = self.initial_indent
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	432
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	433 # Maximum width for this line.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	434 width = self.width - len(indent)
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	435
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	436 # First chunk on line is whitespace -- drop it, unless this
17424 e7cfe3587ea4 fix trivial spelling errors Mads Kiilerich <mads@kiilerich.com> parents: 17391 diff changeset	437 # is the very beginning of the text (i.e. no lines started yet).
32560 47ce079b1afa util: look for empty-sysstr instead of empty-bytesstr in textwrap code Augie Fackler <raf@durin42.com> parents: 32496 diff changeset	438 if self.drop_whitespace and chunks[-1].strip() == r'' and lines:
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	439 del chunks[-1]
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	440
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	441 while chunks:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	442 l = colwidth(chunks[-1])
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	443
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	444 # Can at least squeeze this chunk onto the current line.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	445 if cur_len + l <= width:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	446 cur_line.append(chunks.pop())
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	447 cur_len += l
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	448
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	449 # Nope, this line is full.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	450 else:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	451 break
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	452
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	453 # The current line is full, and the next chunk is too big to
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	454 # fit on any line (not just this one).
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	455 if chunks and colwidth(chunks[-1]) > width:
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	456 self._handle_long_word(chunks, cur_line, cur_len, width)
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	457
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	458 # If the last chunk on this line is all whitespace, drop it.
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	459 if (self.drop_whitespace and
32560 47ce079b1afa util: look for empty-sysstr instead of empty-bytesstr in textwrap code Augie Fackler <raf@durin42.com> parents: 32496 diff changeset	460 cur_line and cur_line[-1].strip() == r''):
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	461 del cur_line[-1]
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	462
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	463 # Convert current line back to a string and store it in list
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	464 # of all lines (return value).
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	465 if cur_line:
32579 3b8155305fbe util: use sysstr.join instead of bytes.join in textwrap wrapper Augie Fackler <raf@durin42.com> parents: 32560 diff changeset	466 lines.append(indent + r''.join(cur_line))
15066 24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	467
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	468 return lines
24efa83d81cb i18n: calculate terminal columns by width information of each characters FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 15065 diff changeset	469
37082 736024df4498 util: mark MBTextWrapper as private Yuya Nishihara <yuya@tcha.org> parents: 37081 diff changeset	470 global _MBTextWrapper
736024df4498 util: mark MBTextWrapper as private Yuya Nishihara <yuya@tcha.org> parents: 37081 diff changeset	471 _MBTextWrapper = tw
13316 d119403fd266 util: delay loading of textwrap Matt Mackall <mpm@selenic.com> parents: 13313 diff changeset	472 return tw(**kwargs)
11297 d320e70442a5 replace Python standard textwrap by MBCS sensitive one for i18n text FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 11256 diff changeset	473
12698 7aef77e74cf3 util: make wrap() require a width argument Matt Mackall <mpm@selenic.com> parents: 12689 diff changeset	474 def wrap(line, width, initindent='', hangindent=''):
11297 d320e70442a5 replace Python standard textwrap by MBCS sensitive one for i18n text FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 11256 diff changeset	475 maxindent = max(len(hangindent), len(initindent))
d320e70442a5 replace Python standard textwrap by MBCS sensitive one for i18n text FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 11256 diff changeset	476 if width <= maxindent:
9417 4c3fb45123e5 util, minirst: do not crash with COLUMNS=0 Martin Geisler <mg@lazybytes.net> parents: 9397 diff changeset	477 # adjust for weird terminal size
11297 d320e70442a5 replace Python standard textwrap by MBCS sensitive one for i18n text FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 11256 diff changeset	478 width = max(78, maxindent + 1)
31347 a9a28ca17615 util: pass encoding.[encoding\|encodingmode] as unicodes Pulkit Goyal <7895pulkit@gmail.com> parents: 31324 diff changeset	479 line = line.decode(pycompat.sysstr(encoding.encoding),
37083 bad90b80b315 util: adjust indent level in wrap() Yuya Nishihara <yuya@tcha.org> parents: 37082 diff changeset	480 pycompat.sysstr(encoding.encodingmode))
31347 a9a28ca17615 util: pass encoding.[encoding\|encodingmode] as unicodes Pulkit Goyal <7895pulkit@gmail.com> parents: 31324 diff changeset	481 initindent = initindent.decode(pycompat.sysstr(encoding.encoding),
37083 bad90b80b315 util: adjust indent level in wrap() Yuya Nishihara <yuya@tcha.org> parents: 37082 diff changeset	482 pycompat.sysstr(encoding.encodingmode))
31347 a9a28ca17615 util: pass encoding.[encoding\|encodingmode] as unicodes Pulkit Goyal <7895pulkit@gmail.com> parents: 31324 diff changeset	483 hangindent = hangindent.decode(pycompat.sysstr(encoding.encoding),
37083 bad90b80b315 util: adjust indent level in wrap() Yuya Nishihara <yuya@tcha.org> parents: 37082 diff changeset	484 pycompat.sysstr(encoding.encodingmode))
37082 736024df4498 util: mark MBTextWrapper as private Yuya Nishihara <yuya@tcha.org> parents: 37081 diff changeset	485 wrapper = _MBTextWrapper(width=width,
736024df4498 util: mark MBTextWrapper as private Yuya Nishihara <yuya@tcha.org> parents: 37081 diff changeset	486 initial_indent=initindent,
736024df4498 util: mark MBTextWrapper as private Yuya Nishihara <yuya@tcha.org> parents: 37081 diff changeset	487 subsequent_indent=hangindent)
31347 a9a28ca17615 util: pass encoding.[encoding\|encodingmode] as unicodes Pulkit Goyal <7895pulkit@gmail.com> parents: 31324 diff changeset	488 return wrapper.fill(line).encode(pycompat.sysstr(encoding.encoding))
8938 9b8c9266c59d commands: wrap short descriptions in 'hg help' Martin Geisler <mg@lazybytes.net> parents: 8785 diff changeset	489
12088 1f71dffabc53 parsebool: accept always as true and never as false Augie Fackler <durin42@gmail.com> parents: 12087 diff changeset	490 _booleans = {'1': True, 'yes': True, 'true': True, 'on': True, 'always': True,
1f71dffabc53 parsebool: accept always as true and never as false Augie Fackler <durin42@gmail.com> parents: 12087 diff changeset	491 '0': False, 'no': False, 'false': False, 'off': False,
1f71dffabc53 parsebool: accept always as true and never as false Augie Fackler <durin42@gmail.com> parents: 12087 diff changeset	492 'never': False}
12087 a88a4720c2f0 parsebool: create new function and use it for config parsing Augie Fackler <durin42@gmail.com> parents: 12086 diff changeset	493
a88a4720c2f0 parsebool: create new function and use it for config parsing Augie Fackler <durin42@gmail.com> parents: 12086 diff changeset	494 def parsebool(s):
a88a4720c2f0 parsebool: create new function and use it for config parsing Augie Fackler <durin42@gmail.com> parents: 12086 diff changeset	495 """Parse s into a boolean.
a88a4720c2f0 parsebool: create new function and use it for config parsing Augie Fackler <durin42@gmail.com> parents: 12086 diff changeset	496
a88a4720c2f0 parsebool: create new function and use it for config parsing Augie Fackler <durin42@gmail.com> parents: 12086 diff changeset	497 If s is not a valid boolean, returns None.
a88a4720c2f0 parsebool: create new function and use it for config parsing Augie Fackler <durin42@gmail.com> parents: 12086 diff changeset	498 """
a88a4720c2f0 parsebool: create new function and use it for config parsing Augie Fackler <durin42@gmail.com> parents: 12086 diff changeset	499 return _booleans.get(s.lower(), None)

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/utils/stringutil.py @ 37248:0e7550b0964c