mercurial-source: mercurial/templateutil.py annotate

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Fri, 13 Apr 2018 12:50:47 -0700 (2018-04-13)
parents	40c7347f6848
children	61cecab0cc20

rev	line source
37699 da2977e674a3 templater: extract template evaluation utility to new module Yuya Nishihara <yuya@tcha.org> parents: 37698 diff changeset	1 # templateutil.py - utility for template evaluation
1909 37b9f80a5fbb add doc comments to template code. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1906 diff changeset	2 #
37b9f80a5fbb add doc comments to template code. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1906 diff changeset	3 # Copyright 2005, 2006 Matt Mackall <mpm@selenic.com>
37b9f80a5fbb add doc comments to template code. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1906 diff changeset	4 #
8225 46293a0c7e9f updated license to be explicit about GPL version 2 Martin Geisler <mg@lazybytes.net> parents: 8223 diff changeset	5 # 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: 9842 diff changeset	6 # GNU General Public License version 2 or any later version.
1909 37b9f80a5fbb add doc comments to template code. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 1906 diff changeset	7
37699 da2977e674a3 templater: extract template evaluation utility to new module Yuya Nishihara <yuya@tcha.org> parents: 37698 diff changeset	8 from __future__ import absolute_import
26569 7eb357b5f774 templater: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 26375 diff changeset	9
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	10 import abc
17982 e06e9fd2d99f template engine: convert generator-based iterator to list-based iterator Weiwen <weiwen@fb.com> parents: 17890 diff changeset	11 import types
26569 7eb357b5f774 templater: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 26375 diff changeset	12
7eb357b5f774 templater: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 26375 diff changeset	13 from .i18n import _
7eb357b5f774 templater: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 26375 diff changeset	14 from . import (
7eb357b5f774 templater: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 26375 diff changeset	15 error,
31394 bb77654dc7ae py3: replace os.sep with pycompat.ossep (part 3 of 4) Pulkit Goyal <7895pulkit@gmail.com> parents: 31111 diff changeset	16 pycompat,
26569 7eb357b5f774 templater: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 26375 diff changeset	17 util,
7eb357b5f774 templater: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 26375 diff changeset	18 )
37870 f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37860 diff changeset	19 from .utils import (
38010 67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	20 dateutil,
37870 f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37860 diff changeset	21 stringutil,
f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37860 diff changeset	22 )
13177 895f54a79c6e templater: use the parser.py parser to extend the templater syntax Matt Mackall <mpm@selenic.com> parents: 13176 diff changeset	23
37230 717a279c0c21 templater: specialize ResourceUnavailable error so that it can be caught Yuya Nishihara <yuya@tcha.org> parents: 37229 diff changeset	24 class ResourceUnavailable(error.Abort):
717a279c0c21 templater: specialize ResourceUnavailable error so that it can be caught Yuya Nishihara <yuya@tcha.org> parents: 37229 diff changeset	25 pass
717a279c0c21 templater: specialize ResourceUnavailable error so that it can be caught Yuya Nishihara <yuya@tcha.org> parents: 37229 diff changeset	26
37229 8dbd97aef915 templater: move specialized exception types to top Yuya Nishihara <yuya@tcha.org> parents: 37031 diff changeset	27 class TemplateNotFound(error.Abort):
8dbd97aef915 templater: move specialized exception types to top Yuya Nishihara <yuya@tcha.org> parents: 37031 diff changeset	28 pass
8dbd97aef915 templater: move specialized exception types to top Yuya Nishihara <yuya@tcha.org> parents: 37031 diff changeset	29
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	30 class wrapped(object):
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	31 """Object requiring extra conversion prior to displaying or processing
38065 26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	32 as value
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	33
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	34 Use unwrapvalue(), unwrapastype(), or unwraphybrid() to obtain the inner
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	35 object.
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	36 """
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	37
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	38 __metaclass__ = abc.ABCMeta
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	39
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	40 @abc.abstractmethod
38110 c2f74b8f6b7f templater: pass context to itermaps() for future extension Yuya Nishihara <yuya@tcha.org> parents: 38109 diff changeset	41 def itermaps(self, context):
38109 8c31b434697f templater: define interface for objects which act as iterator of mappings Yuya Nishihara <yuya@tcha.org> parents: 38065 diff changeset	42 """Yield each template mapping"""
8c31b434697f templater: define interface for objects which act as iterator of mappings Yuya Nishihara <yuya@tcha.org> parents: 38065 diff changeset	43
8c31b434697f templater: define interface for objects which act as iterator of mappings Yuya Nishihara <yuya@tcha.org> parents: 38065 diff changeset	44 @abc.abstractmethod
38113 ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	45 def join(self, context, mapping, sep):
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	46 """Join items with the separator; Returns a bytes or (possibly nested)
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	47 generator of bytes
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	48
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	49 A pre-configured template may be rendered per item if this container
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	50 holds unprintable items.
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	51 """
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	52
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	53 @abc.abstractmethod
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	54 def show(self, context, mapping):
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	55 """Return a bytes or (possibly nested) generator of bytes representing
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	56 the underlying object
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	57
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	58 A pre-configured template may be rendered if the underlying object is
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	59 not printable.
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	60 """
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	61
38065 26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	62 @abc.abstractmethod
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	63 def tovalue(self, context, mapping):
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	64 """Move the inner value object out or create a value representation
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	65
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	66 A returned value must be serializable by templaterfilters.json().
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	67 """
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	68
38013 9bcf096a2da2 templatefilters: declare input type as date where appropriate Yuya Nishihara <yuya@tcha.org> parents: 38012 diff changeset	69 # stub for representing a date type; may be a real date type that can
9bcf096a2da2 templatefilters: declare input type as date where appropriate Yuya Nishihara <yuya@tcha.org> parents: 38012 diff changeset	70 # provide a readable string value
9bcf096a2da2 templatefilters: declare input type as date where appropriate Yuya Nishihara <yuya@tcha.org> parents: 38012 diff changeset	71 class date(object):
9bcf096a2da2 templatefilters: declare input type as date where appropriate Yuya Nishihara <yuya@tcha.org> parents: 38012 diff changeset	72 pass
9bcf096a2da2 templatefilters: declare input type as date where appropriate Yuya Nishihara <yuya@tcha.org> parents: 38012 diff changeset	73
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	74 class hybrid(wrapped):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	75 """Wrapper for list or dict to support legacy template
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	76
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	77 This class allows us to handle both:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	78 - "{files}" (legacy command-line-specific list hack) and
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	79 - "{files % '{file}\n'}" (hgweb-style with inlining and function support)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	80 and to access raw values:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	81 - "{ifcontains(file, files, ...)}", "{ifcontains(key, extras, ...)}"
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	82 - "{get(extras, key)}"
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	83 - "{files\|json}"
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	84 """
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	85
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	86 def __init__(self, gen, values, makemap, joinfmt, keytype=None):
38111 41a5d815d2c1 templater: factor out generator of join()-ed items Yuya Nishihara <yuya@tcha.org> parents: 38110 diff changeset	87 self._gen = gen # generator or function returning generator
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	88 self._values = values
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	89 self._makemap = makemap
38115 676664592313 templater: mark .joinfmt as a private attribute Yuya Nishihara <yuya@tcha.org> parents: 38113 diff changeset	90 self._joinfmt = joinfmt
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	91 self.keytype = keytype # hint for 'x in y' where type(x) is unresolved
38061 8c84dc8264dc templater: mark .gen as a private attribute Yuya Nishihara <yuya@tcha.org> parents: 38059 diff changeset	92
38110 c2f74b8f6b7f templater: pass context to itermaps() for future extension Yuya Nishihara <yuya@tcha.org> parents: 38109 diff changeset	93 def itermaps(self, context):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	94 makemap = self._makemap
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	95 for x in self._values:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	96 yield makemap(x)
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	97
38113 ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	98 def join(self, context, mapping, sep):
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	99 # TODO: switch gen to (context, mapping) API?
38115 676664592313 templater: mark .joinfmt as a private attribute Yuya Nishihara <yuya@tcha.org> parents: 38113 diff changeset	100 return joinitems((self._joinfmt(x) for x in self._values), sep)
38113 ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	101
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	102 def show(self, context, mapping):
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	103 # TODO: switch gen to (context, mapping) API?
38061 8c84dc8264dc templater: mark .gen as a private attribute Yuya Nishihara <yuya@tcha.org> parents: 38059 diff changeset	104 gen = self._gen
38111 41a5d815d2c1 templater: factor out generator of join()-ed items Yuya Nishihara <yuya@tcha.org> parents: 38110 diff changeset	105 if gen is None:
38113 ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	106 return self.join(context, mapping, ' ')
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	107 if callable(gen):
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	108 return gen()
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	109 return gen
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	110
38065 26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	111 def tovalue(self, context, mapping):
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	112 # TODO: return self._values and get rid of proxy methods
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	113 return self
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	114
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	115 def __contains__(self, x):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	116 return x in self._values
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	117 def __getitem__(self, key):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	118 return self._values[key]
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	119 def __len__(self):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	120 return len(self._values)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	121 def __iter__(self):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	122 return iter(self._values)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	123 def __getattr__(self, name):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	124 if name not in (r'get', r'items', r'iteritems', r'iterkeys',
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	125 r'itervalues', r'keys', r'values'):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	126 raise AttributeError(name)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	127 return getattr(self._values, name)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	128
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	129 class mappable(wrapped):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	130 """Wrapper for non-list/dict object to support map operation
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	131
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	132 This class allows us to handle both:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	133 - "{manifest}"
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	134 - "{manifest % '{rev}:{node}'}"
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	135 - "{manifest.rev}"
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	136
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	137 Unlike a hybrid, this does not simulate the behavior of the underling
38065 26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	138 value.
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	139 """
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	140
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	141 def __init__(self, gen, key, value, makemap):
38062 b4630e332a99 templater: drop unneeded generator from mappable object Yuya Nishihara <yuya@tcha.org> parents: 38061 diff changeset	142 self._gen = gen # generator or function returning generator
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	143 self._key = key
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	144 self._value = value # may be generator of strings
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	145 self._makemap = makemap
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	146
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	147 def tomap(self):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	148 return self._makemap(self._key)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	149
38110 c2f74b8f6b7f templater: pass context to itermaps() for future extension Yuya Nishihara <yuya@tcha.org> parents: 38109 diff changeset	150 def itermaps(self, context):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	151 yield self.tomap()
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	152
38113 ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	153 def join(self, context, mapping, sep):
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	154 # TODO: just copies the old behavior where a value was a generator
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	155 # yielding one item, but reconsider about it. join() over a string
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	156 # has no consistent result because a string may be a bytes, or a
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	157 # generator yielding an item, or a generator yielding multiple items.
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	158 # Preserving all of the current behaviors wouldn't make any sense.
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	159 return self.show(context, mapping)
ebf139cbd4a1 templater: abstract away from joinfmt Yuya Nishihara <yuya@tcha.org> parents: 38112 diff changeset	160
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	161 def show(self, context, mapping):
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	162 # TODO: switch gen to (context, mapping) API?
38061 8c84dc8264dc templater: mark .gen as a private attribute Yuya Nishihara <yuya@tcha.org> parents: 38059 diff changeset	163 gen = self._gen
38062 b4630e332a99 templater: drop unneeded generator from mappable object Yuya Nishihara <yuya@tcha.org> parents: 38061 diff changeset	164 if gen is None:
b4630e332a99 templater: drop unneeded generator from mappable object Yuya Nishihara <yuya@tcha.org> parents: 38061 diff changeset	165 return pycompat.bytestr(self._value)
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	166 if callable(gen):
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	167 return gen()
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	168 return gen
83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	169
38065 26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	170 def tovalue(self, context, mapping):
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	171 return _unthunk(context, mapping, self._value)
26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	172
38185 0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	173 class _mappingsequence(wrapped):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	174 """Wrapper for sequence of template mappings
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	175
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	176 This represents an inner template structure (i.e. a list of dicts),
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	177 which can also be rendered by the specified named/literal template.
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	178
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	179 Template mappings may be nested.
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	180 """
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	181
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	182 def __init__(self, name=None, tmpl=None, sep=''):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	183 if name is not None and tmpl is not None:
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	184 raise error.ProgrammingError('name and tmpl are mutually exclusive')
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	185 self._name = name
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	186 self._tmpl = tmpl
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	187 self._defaultsep = sep
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	188
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	189 def join(self, context, mapping, sep):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	190 mapsiter = _iteroverlaymaps(context, mapping, self.itermaps(context))
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	191 if self._name:
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	192 itemiter = (context.process(self._name, m) for m in mapsiter)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	193 elif self._tmpl:
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	194 itemiter = (context.expand(self._tmpl, m) for m in mapsiter)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	195 else:
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	196 raise error.ParseError(_('not displayable without template'))
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	197 return joinitems(itemiter, sep)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	198
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	199 def show(self, context, mapping):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	200 return self.join(context, mapping, self._defaultsep)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	201
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	202 def tovalue(self, context, mapping):
38288 40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	203 knownres = context.knownresourcekeys()
40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	204 items = []
40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	205 for nm in self.itermaps(context):
40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	206 # drop internal resources (recursively) which shouldn't be displayed
40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	207 lm = context.overlaymap(mapping, nm)
40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	208 items.append({k: unwrapvalue(context, lm, v)
40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	209 for k, v in nm.iteritems() if k not in knownres})
40c7347f6848 formatter: remove template resources from nested items before generating JSON Yuya Nishihara <yuya@tcha.org> parents: 38285 diff changeset	210 return items
38185 0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	211
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	212 class mappinggenerator(_mappingsequence):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	213 """Wrapper for generator of template mappings
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	214
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	215 The function ``make(context, *args)`` should return a generator of
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	216 mapping dicts.
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	217 """
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	218
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	219 def __init__(self, make, args=(), name=None, tmpl=None, sep=''):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	220 super(mappinggenerator, self).__init__(name, tmpl, sep)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	221 self._make = make
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	222 self._args = args
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	223
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	224 def itermaps(self, context):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	225 return self._make(context, *self._args)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	226
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	227 class mappinglist(_mappingsequence):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	228 """Wrapper for list of template mappings"""
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	229
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	230 def __init__(self, mappings, name=None, tmpl=None, sep=''):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	231 super(mappinglist, self).__init__(name, tmpl, sep)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	232 self._mappings = mappings
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	233
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	234 def itermaps(self, context):
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	235 return iter(self._mappings)
0b64416224d9 templater: add class representing a nested mappings Yuya Nishihara <yuya@tcha.org> parents: 38115 diff changeset	236
38285 75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	237 class mappedgenerator(wrapped):
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	238 """Wrapper for generator of strings which acts as a list
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	239
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	240 The function ``make(context, *args)`` should return a generator of
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	241 byte strings, or a generator of (possibly nested) generators of byte
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	242 strings (i.e. a generator for a list of byte strings.)
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	243 """
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	244
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	245 def __init__(self, make, args=()):
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	246 self._make = make
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	247 self._args = args
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	248
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	249 def _gen(self, context):
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	250 return self._make(context, *self._args)
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	251
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	252 def itermaps(self, context):
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	253 raise error.ParseError(_('list of strings is not mappable'))
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	254
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	255 def join(self, context, mapping, sep):
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	256 return joinitems(self._gen(context), sep)
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	257
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	258 def show(self, context, mapping):
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	259 return self.join(context, mapping, '')
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	260
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	261 def tovalue(self, context, mapping):
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	262 return [stringify(context, mapping, x) for x in self._gen(context)]
75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk Yuya Nishihara <yuya@tcha.org> parents: 38191 diff changeset	263
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	264 def hybriddict(data, key='key', value='value', fmt=None, gen=None):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	265 """Wrap data to support both dict-like and string-like operations"""
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	266 prefmt = pycompat.identity
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	267 if fmt is None:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	268 fmt = '%s=%s'
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	269 prefmt = pycompat.bytestr
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	270 return hybrid(gen, data, lambda k: {key: k, value: data[k]},
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	271 lambda k: fmt % (prefmt(k), prefmt(data[k])))
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	272
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	273 def hybridlist(data, name, fmt=None, gen=None):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	274 """Wrap data to support both list-like and string-like operations"""
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	275 prefmt = pycompat.identity
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	276 if fmt is None:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	277 fmt = '%s'
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	278 prefmt = pycompat.bytestr
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	279 return hybrid(gen, data, lambda x: {name: x}, lambda x: fmt % prefmt(x))
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	280
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	281 def unwraphybrid(context, mapping, thing):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	282 """Return an object which can be stringified possibly by using a legacy
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	283 template"""
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	284 if not isinstance(thing, wrapped):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	285 return thing
38059 83e1bbd48991 templater: define interface for objects requiring unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38058 diff changeset	286 return thing.show(context, mapping)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	287
38063 9e8128e84326 templater: pass (context, mapping) down to unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38062 diff changeset	288 def unwrapvalue(context, mapping, thing):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	289 """Move the inner value object out of the wrapper"""
38065 26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	290 if not isinstance(thing, wrapped):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	291 return thing
38065 26f6fc179e62 templater: define interface for objects requiring unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38064 diff changeset	292 return thing.tovalue(context, mapping)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	293
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	294 def wraphybridvalue(container, key, value):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	295 """Wrap an element of hybrid container to be mappable
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	296
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	297 The key is passed to the makemap function of the given container, which
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	298 should be an item generated by iter(container).
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	299 """
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	300 makemap = getattr(container, '_makemap', None)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	301 if makemap is None:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	302 return value
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	303 if util.safehasattr(value, '_makemap'):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	304 # a nested hybrid list/dict, which has its own way of map operation
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	305 return value
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	306 return mappable(None, key, value, makemap)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	307
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	308 def compatdict(context, mapping, name, data, key='key', value='value',
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	309 fmt=None, plural=None, separator=' '):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	310 """Wrap data like hybriddict(), but also supports old-style list template
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	311
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	312 This exists for backward compatibility with the old-style template. Use
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	313 hybriddict() for new template keywords.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	314 """
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	315 c = [{key: k, value: v} for k, v in data.iteritems()]
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	316 f = _showcompatlist(context, mapping, name, c, plural, separator)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	317 return hybriddict(data, key=key, value=value, fmt=fmt, gen=f)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	318
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	319 def compatlist(context, mapping, name, data, element=None, fmt=None,
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	320 plural=None, separator=' '):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	321 """Wrap data like hybridlist(), but also supports old-style list template
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	322
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	323 This exists for backward compatibility with the old-style template. Use
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	324 hybridlist() for new template keywords.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	325 """
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	326 f = _showcompatlist(context, mapping, name, data, plural, separator)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	327 return hybridlist(data, name=element or name, fmt=fmt, gen=f)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	328
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	329 def _showcompatlist(context, mapping, name, values, plural=None, separator=' '):
aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	330 """Return a generator that renders old-style list template
aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	331
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	332 name is name of key in template map.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	333 values is list of strings or dicts.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	334 plural is plural of name, if not simply name + 's'.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	335 separator is used to join values as a string
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	336
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	337 expansion works like this, given name 'foo'.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	338
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	339 if values is empty, expand 'no_foos'.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	340
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	341 if 'foo' not in template map, return values as a string,
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	342 joined by 'separator'.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	343
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	344 expand 'start_foos'.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	345
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	346 for each value, expand 'foo'. if 'last_foo' in template
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	347 map, expand it instead of 'foo' for last key.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	348
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	349 expand 'end_foos'.
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	350 """
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	351 if not plural:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	352 plural = name + 's'
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	353 if not values:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	354 noname = 'no_' + plural
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	355 if context.preload(noname):
aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	356 yield context.process(noname, mapping)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	357 return
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	358 if not context.preload(name):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	359 if isinstance(values[0], bytes):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	360 yield separator.join(values)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	361 else:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	362 for v in values:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	363 r = dict(v)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	364 r.update(mapping)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	365 yield r
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	366 return
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	367 startname = 'start_' + plural
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	368 if context.preload(startname):
aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	369 yield context.process(startname, mapping)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	370 def one(v, tag=name):
37860 2891079fb0c0 templater: factor out function to create mapping dict for nested evaluation Yuya Nishihara <yuya@tcha.org> parents: 37859 diff changeset	371 vmapping = {}
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	372 try:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	373 vmapping.update(v)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	374 # Python 2 raises ValueError if the type of v is wrong. Python
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	375 # 3 raises TypeError.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	376 except (AttributeError, TypeError, ValueError):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	377 try:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	378 # Python 2 raises ValueError trying to destructure an e.g.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	379 # bytes. Python 3 raises TypeError.
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	380 for a, b in v:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	381 vmapping[a] = b
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	382 except (TypeError, ValueError):
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	383 vmapping[name] = v
37860 2891079fb0c0 templater: factor out function to create mapping dict for nested evaluation Yuya Nishihara <yuya@tcha.org> parents: 37859 diff changeset	384 vmapping = context.overlaymap(mapping, vmapping)
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	385 return context.process(tag, vmapping)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	386 lastname = 'last_' + name
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	387 if context.preload(lastname):
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	388 last = values.pop()
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	389 else:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	390 last = None
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	391 for v in values:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	392 yield one(v)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	393 if last is not None:
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	394 yield one(last, tag=lastname)
32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	395 endname = 'end_' + plural
37854 aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	396 if context.preload(endname):
aa97e06a1912 templater: use template context to render old-style list template Yuya Nishihara <yuya@tcha.org> parents: 37805 diff changeset	397 yield context.process(endname, mapping)
37707 32f9b7e3f056 templater: move hybrid class and functions to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37706 diff changeset	398
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	399 def flatten(context, mapping, thing):
37943 888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	400 """Yield a single stream from a possibly nested set of iterators"""
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	401 thing = unwraphybrid(context, mapping, thing)
37943 888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	402 if isinstance(thing, bytes):
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	403 yield thing
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	404 elif isinstance(thing, str):
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	405 # We can only hit this on Python 3, and it's here to guard
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	406 # against infinite recursion.
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	407 raise error.ProgrammingError('Mercurial IO including templates is done'
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	408 ' with bytes, not strings, got %r' % thing)
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	409 elif thing is None:
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	410 pass
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	411 elif not util.safehasattr(thing, '__iter__'):
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	412 yield pycompat.bytestr(thing)
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	413 else:
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	414 for i in thing:
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	415 i = unwraphybrid(context, mapping, i)
37943 888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	416 if isinstance(i, bytes):
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	417 yield i
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	418 elif i is None:
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	419 pass
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	420 elif not util.safehasattr(i, '__iter__'):
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	421 yield pycompat.bytestr(i)
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	422 else:
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	423 for j in flatten(context, mapping, i):
37943 888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	424 yield j
888507ec655e templateutil: move flatten() from templater Yuya Nishihara <yuya@tcha.org> parents: 37890 diff changeset	425
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	426 def stringify(context, mapping, thing):
37706 6ff6e1d6b5b8 templater: move stringify() to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37699 diff changeset	427 """Turn values into bytes by converting into text and concatenating them"""
37944 e09d2183e226 templateutil: reimplement stringify() using flatten() Yuya Nishihara <yuya@tcha.org> parents: 37943 diff changeset	428 if isinstance(thing, bytes):
e09d2183e226 templateutil: reimplement stringify() using flatten() Yuya Nishihara <yuya@tcha.org> parents: 37943 diff changeset	429 return thing # retain localstr to be round-tripped
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	430 return b''.join(flatten(context, mapping, thing))
37706 6ff6e1d6b5b8 templater: move stringify() to templateutil module Yuya Nishihara <yuya@tcha.org> parents: 37699 diff changeset	431
32706 2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	432 def findsymbolicname(arg):
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	433 """Find symbolic name for the given compiled expression; returns None
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	434 if nothing found reliably"""
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	435 while True:
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	436 func, data = arg
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	437 if func is runsymbol:
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	438 return data
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	439 elif func is runfilter:
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	440 arg = data[0]
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	441 else:
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	442 return None
2abc556dbe92 templater: find keyword name more thoroughly on filtering error Yuya Nishihara <yuya@tcha.org> parents: 32705 diff changeset	443
38064 671a01cd50b5 templater: extract private function to evaluate generator to byte string Yuya Nishihara <yuya@tcha.org> parents: 38063 diff changeset	444 def _unthunk(context, mapping, thing):
671a01cd50b5 templater: extract private function to evaluate generator to byte string Yuya Nishihara <yuya@tcha.org> parents: 38063 diff changeset	445 """Evaluate a lazy byte string into value"""
671a01cd50b5 templater: extract private function to evaluate generator to byte string Yuya Nishihara <yuya@tcha.org> parents: 38063 diff changeset	446 if not isinstance(thing, types.GeneratorType):
671a01cd50b5 templater: extract private function to evaluate generator to byte string Yuya Nishihara <yuya@tcha.org> parents: 38063 diff changeset	447 return thing
671a01cd50b5 templater: extract private function to evaluate generator to byte string Yuya Nishihara <yuya@tcha.org> parents: 38063 diff changeset	448 return stringify(context, mapping, thing)
671a01cd50b5 templater: extract private function to evaluate generator to byte string Yuya Nishihara <yuya@tcha.org> parents: 38063 diff changeset	449
35109 e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	450 def evalrawexp(context, mapping, arg):
e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	451 """Evaluate given argument as a bare template object which may require
e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	452 further processing (such as folding generator of strings)"""
26720 604a7c941103 templater: extract helper that evaluates filter or function argument Yuya Nishihara <yuya@tcha.org> parents: 26693 diff changeset	453 func, data = arg
35109 e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	454 return func(context, mapping, data)
e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	455
e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	456 def evalfuncarg(context, mapping, arg):
e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	457 """Evaluate given argument as value type"""
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	458 return _unwrapvalue(context, mapping, evalrawexp(context, mapping, arg))
37947 0023da2910c9 templater: extract type conversion from evalfuncarg() Yuya Nishihara <yuya@tcha.org> parents: 37946 diff changeset	459
0023da2910c9 templater: extract type conversion from evalfuncarg() Yuya Nishihara <yuya@tcha.org> parents: 37946 diff changeset	460 # TODO: unify this with unwrapvalue() once the bug of templatefunc.join()
0023da2910c9 templater: extract type conversion from evalfuncarg() Yuya Nishihara <yuya@tcha.org> parents: 37946 diff changeset	461 # is fixed. we can't do that right now because join() has to take a generator
0023da2910c9 templater: extract type conversion from evalfuncarg() Yuya Nishihara <yuya@tcha.org> parents: 37946 diff changeset	462 # of byte strings as it is, not a lazy byte string.
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	463 def _unwrapvalue(context, mapping, thing):
38063 9e8128e84326 templater: pass (context, mapping) down to unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38062 diff changeset	464 thing = unwrapvalue(context, mapping, thing)
35109 e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	465 # evalrawexp() may return string, generator of strings or arbitrary object
e60c601953d7 templater: extract helper to just evaluate template expression Yuya Nishihara <yuya@tcha.org> parents: 35108 diff changeset	466 # such as date tuple, but filter does not want generator.
38064 671a01cd50b5 templater: extract private function to evaluate generator to byte string Yuya Nishihara <yuya@tcha.org> parents: 38063 diff changeset	467 return _unthunk(context, mapping, thing)
26720 604a7c941103 templater: extract helper that evaluates filter or function argument Yuya Nishihara <yuya@tcha.org> parents: 26693 diff changeset	468
30586 034412ca28c3 templater: fix if() to not evaluate False as bool('False') Yuya Nishihara <yuya@tcha.org> parents: 30585 diff changeset	469 def evalboolean(context, mapping, arg):
30587 cc11079644fc templater: make pad() evaluate boolean argument (BC) Yuya Nishihara <yuya@tcha.org> parents: 30586 diff changeset	470 """Evaluate given argument as boolean, but also takes boolean literals"""
30586 034412ca28c3 templater: fix if() to not evaluate False as bool('False') Yuya Nishihara <yuya@tcha.org> parents: 30585 diff changeset	471 func, data = arg
30587 cc11079644fc templater: make pad() evaluate boolean argument (BC) Yuya Nishihara <yuya@tcha.org> parents: 30586 diff changeset	472 if func is runsymbol:
cc11079644fc templater: make pad() evaluate boolean argument (BC) Yuya Nishihara <yuya@tcha.org> parents: 30586 diff changeset	473 thing = func(context, mapping, data, default=None)
cc11079644fc templater: make pad() evaluate boolean argument (BC) Yuya Nishihara <yuya@tcha.org> parents: 30586 diff changeset	474 if thing is None:
cc11079644fc templater: make pad() evaluate boolean argument (BC) Yuya Nishihara <yuya@tcha.org> parents: 30586 diff changeset	475 # not a template keyword, takes as a boolean literal
37870 f0b6fbea00cf stringutil: bulk-replace call sites to point to new module Yuya Nishihara <yuya@tcha.org> parents: 37860 diff changeset	476 thing = stringutil.parsebool(data)
30587 cc11079644fc templater: make pad() evaluate boolean argument (BC) Yuya Nishihara <yuya@tcha.org> parents: 30586 diff changeset	477 else:
cc11079644fc templater: make pad() evaluate boolean argument (BC) Yuya Nishihara <yuya@tcha.org> parents: 30586 diff changeset	478 thing = func(context, mapping, data)
38063 9e8128e84326 templater: pass (context, mapping) down to unwrapvalue() Yuya Nishihara <yuya@tcha.org> parents: 38062 diff changeset	479 thing = unwrapvalue(context, mapping, thing)
30586 034412ca28c3 templater: fix if() to not evaluate False as bool('False') Yuya Nishihara <yuya@tcha.org> parents: 30585 diff changeset	480 if isinstance(thing, bool):
034412ca28c3 templater: fix if() to not evaluate False as bool('False') Yuya Nishihara <yuya@tcha.org> parents: 30585 diff changeset	481 return thing
034412ca28c3 templater: fix if() to not evaluate False as bool('False') Yuya Nishihara <yuya@tcha.org> parents: 30585 diff changeset	482 # other objects are evaluated as strings, which means 0 is True, but
034412ca28c3 templater: fix if() to not evaluate False as bool('False') Yuya Nishihara <yuya@tcha.org> parents: 30585 diff changeset	483 # empty dict/list should be False as they are expected to be ''
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	484 return bool(stringify(context, mapping, thing))
30586 034412ca28c3 templater: fix if() to not evaluate False as bool('False') Yuya Nishihara <yuya@tcha.org> parents: 30585 diff changeset	485
38010 67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	486 def evaldate(context, mapping, arg, err=None):
67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	487 """Evaluate given argument as a date tuple or a date string; returns
67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	488 a (unixtime, offset) tuple"""
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	489 thing = evalrawexp(context, mapping, arg)
7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	490 return unwrapdate(context, mapping, thing, err)
38010 67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	491
38058 7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	492 def unwrapdate(context, mapping, thing, err=None):
7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid() Yuya Nishihara <yuya@tcha.org> parents: 38017 diff changeset	493 thing = _unwrapvalue(context, mapping, thing)
38010 67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	494 try:
67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	495 return dateutil.parsedate(thing)
67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	496 except AttributeError:
67efce231633 templater: factor out function that parses argument as date tuple Yuya Nishihara <yuya@tcha.org> parents: 38008 diff changeset	497 raise error.ParseError(err or _('not a date tuple nor a string'))
38011 e70a90a72b80 templatefuncs: use evaldate() where seems appropriate Yuya Nishihara <yuya@tcha.org> parents: 38010 diff changeset	498 except error.ParseError:
e70a90a72b80 templatefuncs: use evaldate() where seems appropriate Yuya Nishihara <yuya@tcha.org> parents: 38010 diff changeset	499 if not err:
e70a90a72b80 templatefuncs: use evaldate() where seems appropriate Yuya Nishihara <yuya@tcha.org> parents: 38010 diff changeset	500 raise

37699

da2977e674a3 templater: extract template evaluation utility to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37698

diff changeset

1 # templateutil.py - utility for template evaluation

1909

37b9f80a5fbb add doc comments to template code.

Vadim Gelfer <vadim.gelfer@gmail.com>

parents: 1906

diff changeset

2 #

37b9f80a5fbb add doc comments to template code.

Vadim Gelfer <vadim.gelfer@gmail.com>

parents: 1906

diff changeset

37b9f80a5fbb add doc comments to template code.

Vadim Gelfer <vadim.gelfer@gmail.com>

parents: 1906

diff changeset

4 #

8225

46293a0c7e9f updated license to be explicit about GPL version 2

Martin Geisler <mg@lazybytes.net>

parents: 8223

diff changeset

5 # 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: 9842

diff changeset

6 # GNU General Public License version 2 or any later version.

1909

37b9f80a5fbb add doc comments to template code.

Vadim Gelfer <vadim.gelfer@gmail.com>

parents: 1906

diff changeset

7

37699

da2977e674a3 templater: extract template evaluation utility to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37698

diff changeset

8 from __future__ import absolute_import

26569

7eb357b5f774 templater: use absolute_import

Gregory Szorc <gregory.szorc@gmail.com>

parents: 26375

diff changeset

9

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

10 import abc

17982

e06e9fd2d99f template engine: convert generator-based iterator to list-based iterator

Weiwen <weiwen@fb.com>

parents: 17890

diff changeset

11 import types

26569

7eb357b5f774 templater: use absolute_import

Gregory Szorc <gregory.szorc@gmail.com>

parents: 26375

diff changeset

12

7eb357b5f774 templater: use absolute_import

Gregory Szorc <gregory.szorc@gmail.com>

parents: 26375

diff changeset

13 from .i18n import _

7eb357b5f774 templater: use absolute_import

Gregory Szorc <gregory.szorc@gmail.com>

parents: 26375

diff changeset

14 from . import (

7eb357b5f774 templater: use absolute_import

Gregory Szorc <gregory.szorc@gmail.com>

parents: 26375

diff changeset

15 error,

31394

bb77654dc7ae py3: replace os.sep with pycompat.ossep (part 3 of 4)

Pulkit Goyal <7895pulkit@gmail.com>

parents: 31111

diff changeset

16 pycompat,

26569

7eb357b5f774 templater: use absolute_import

Gregory Szorc <gregory.szorc@gmail.com>

parents: 26375

diff changeset

17 util,

7eb357b5f774 templater: use absolute_import

Gregory Szorc <gregory.szorc@gmail.com>

parents: 26375

diff changeset

18 )

37870

f0b6fbea00cf stringutil: bulk-replace call sites to point to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37860

diff changeset

19 from .utils import (

38010

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

20 dateutil,

37870

f0b6fbea00cf stringutil: bulk-replace call sites to point to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37860

diff changeset

21 stringutil,

f0b6fbea00cf stringutil: bulk-replace call sites to point to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37860

diff changeset

22 )

13177

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

23

37230

717a279c0c21 templater: specialize ResourceUnavailable error so that it can be caught

Yuya Nishihara <yuya@tcha.org>

parents: 37229

diff changeset

24 class ResourceUnavailable(error.Abort):

717a279c0c21 templater: specialize ResourceUnavailable error so that it can be caught

Yuya Nishihara <yuya@tcha.org>

parents: 37229

diff changeset

25 pass

717a279c0c21 templater: specialize ResourceUnavailable error so that it can be caught

Yuya Nishihara <yuya@tcha.org>

parents: 37229

diff changeset

26

37229

8dbd97aef915 templater: move specialized exception types to top

Yuya Nishihara <yuya@tcha.org>

parents: 37031

diff changeset

27 class TemplateNotFound(error.Abort):

8dbd97aef915 templater: move specialized exception types to top

Yuya Nishihara <yuya@tcha.org>

parents: 37031

diff changeset

28 pass

8dbd97aef915 templater: move specialized exception types to top

Yuya Nishihara <yuya@tcha.org>

parents: 37031

diff changeset

29

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

30 class wrapped(object):

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

31 """Object requiring extra conversion prior to displaying or processing

38065

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

32 as value

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

33

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

34 Use unwrapvalue(), unwrapastype(), or unwraphybrid() to obtain the inner

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

35 object.

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

36 """

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

37

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

38 __metaclass__ = abc.ABCMeta

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

39

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

40 @abc.abstractmethod

38110

c2f74b8f6b7f templater: pass context to itermaps() for future extension

Yuya Nishihara <yuya@tcha.org>

parents: 38109

diff changeset

41 def itermaps(self, context):

38109

8c31b434697f templater: define interface for objects which act as iterator of mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38065

diff changeset

42 """Yield each template mapping"""

8c31b434697f templater: define interface for objects which act as iterator of mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38065

diff changeset

43

8c31b434697f templater: define interface for objects which act as iterator of mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38065

diff changeset

44 @abc.abstractmethod

38113

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

45 def join(self, context, mapping, sep):

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

46 """Join items with the separator; Returns a bytes or (possibly nested)

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

47 generator of bytes

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

48

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

49 A pre-configured template may be rendered per item if this container

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

50 holds unprintable items.

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

51 """

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

52

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

53 @abc.abstractmethod

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

54 def show(self, context, mapping):

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

55 """Return a bytes or (possibly nested) generator of bytes representing

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

56 the underlying object

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

57

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

58 A pre-configured template may be rendered if the underlying object is

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

59 not printable.

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

60 """

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

61

38065

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

62 @abc.abstractmethod

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

63 def tovalue(self, context, mapping):

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

64 """Move the inner value object out or create a value representation

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

65

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

66 A returned value must be serializable by templaterfilters.json().

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

67 """

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

68

38013

9bcf096a2da2 templatefilters: declare input type as date where appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38012

diff changeset

69 # stub for representing a date type; may be a real date type that can

9bcf096a2da2 templatefilters: declare input type as date where appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38012

diff changeset

70 # provide a readable string value

9bcf096a2da2 templatefilters: declare input type as date where appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38012

diff changeset

71 class date(object):

9bcf096a2da2 templatefilters: declare input type as date where appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38012

diff changeset

72 pass

9bcf096a2da2 templatefilters: declare input type as date where appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38012

diff changeset

73

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

74 class hybrid(wrapped):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

75 """Wrapper for list or dict to support legacy template

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

76

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

77 This class allows us to handle both:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

78 - "{files}" (legacy command-line-specific list hack) and

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

79 - "{files % '{file}\n'}" (hgweb-style with inlining and function support)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

80 and to access raw values:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

81 - "{ifcontains(file, files, ...)}", "{ifcontains(key, extras, ...)}"

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

82 - "{get(extras, key)}"

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

83 - "{files|json}"

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

84 """

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

85

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

86 def __init__(self, gen, values, makemap, joinfmt, keytype=None):

38111

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

87 self._gen = gen # generator or function returning generator

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

88 self._values = values

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

89 self._makemap = makemap

38115

676664592313 templater: mark .joinfmt as a private attribute

Yuya Nishihara <yuya@tcha.org>

parents: 38113

diff changeset

90 self._joinfmt = joinfmt

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

91 self.keytype = keytype # hint for 'x in y' where type(x) is unresolved

38061

8c84dc8264dc templater: mark .gen as a private attribute

Yuya Nishihara <yuya@tcha.org>

parents: 38059

diff changeset

92

38110

c2f74b8f6b7f templater: pass context to itermaps() for future extension

Yuya Nishihara <yuya@tcha.org>

parents: 38109

diff changeset

93 def itermaps(self, context):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

94 makemap = self._makemap

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

95 for x in self._values:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

96 yield makemap(x)

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

97

38113

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

98 def join(self, context, mapping, sep):

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

99 # TODO: switch gen to (context, mapping) API?

38115

676664592313 templater: mark .joinfmt as a private attribute

Yuya Nishihara <yuya@tcha.org>

parents: 38113

diff changeset

100 return joinitems((self._joinfmt(x) for x in self._values), sep)

38113

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

101

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

102 def show(self, context, mapping):

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

103 # TODO: switch gen to (context, mapping) API?

38061

8c84dc8264dc templater: mark .gen as a private attribute

Yuya Nishihara <yuya@tcha.org>

parents: 38059

diff changeset

104 gen = self._gen

38111

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

105 if gen is None:

38113

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

106 return self.join(context, mapping, ' ')

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

107 if callable(gen):

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

108 return gen()

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

109 return gen

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

110

38065

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

111 def tovalue(self, context, mapping):

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

112 # TODO: return self._values and get rid of proxy methods

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

113 return self

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

114

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

115 def __contains__(self, x):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

116 return x in self._values

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

117 def __getitem__(self, key):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

118 return self._values[key]

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

119 def __len__(self):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

120 return len(self._values)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

121 def __iter__(self):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

122 return iter(self._values)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

123 def __getattr__(self, name):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

124 if name not in (r'get', r'items', r'iteritems', r'iterkeys',

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

125 r'itervalues', r'keys', r'values'):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

126 raise AttributeError(name)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

127 return getattr(self._values, name)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

128

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

129 class mappable(wrapped):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

130 """Wrapper for non-list/dict object to support map operation

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

131

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

132 This class allows us to handle both:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

133 - "{manifest}"

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

134 - "{manifest % '{rev}:{node}'}"

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

135 - "{manifest.rev}"

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

136

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

137 Unlike a hybrid, this does not simulate the behavior of the underling

38065

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

138 value.

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

139 """

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

140

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

141 def __init__(self, gen, key, value, makemap):

38062

b4630e332a99 templater: drop unneeded generator from mappable object

Yuya Nishihara <yuya@tcha.org>

parents: 38061

diff changeset

142 self._gen = gen # generator or function returning generator

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

143 self._key = key

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

144 self._value = value # may be generator of strings

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

145 self._makemap = makemap

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

146

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

147 def tomap(self):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

148 return self._makemap(self._key)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

149

38110

c2f74b8f6b7f templater: pass context to itermaps() for future extension

Yuya Nishihara <yuya@tcha.org>

parents: 38109

diff changeset

150 def itermaps(self, context):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

151 yield self.tomap()

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

152

38113

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

153 def join(self, context, mapping, sep):

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

154 # TODO: just copies the old behavior where a value was a generator

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

155 # yielding one item, but reconsider about it. join() over a string

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

156 # has no consistent result because a string may be a bytes, or a

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

157 # generator yielding an item, or a generator yielding multiple items.

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

158 # Preserving all of the current behaviors wouldn't make any sense.

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

159 return self.show(context, mapping)

ebf139cbd4a1 templater: abstract away from joinfmt

Yuya Nishihara <yuya@tcha.org>

parents: 38112

diff changeset

160

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

161 def show(self, context, mapping):

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

162 # TODO: switch gen to (context, mapping) API?

38061

8c84dc8264dc templater: mark .gen as a private attribute

Yuya Nishihara <yuya@tcha.org>

parents: 38059

diff changeset

163 gen = self._gen

38062

b4630e332a99 templater: drop unneeded generator from mappable object

Yuya Nishihara <yuya@tcha.org>

parents: 38061

diff changeset

164 if gen is None:

b4630e332a99 templater: drop unneeded generator from mappable object

Yuya Nishihara <yuya@tcha.org>

parents: 38061

diff changeset

165 return pycompat.bytestr(self._value)

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

166 if callable(gen):

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

167 return gen()

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

168 return gen

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

169

38065

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

170 def tovalue(self, context, mapping):

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

171 return _unthunk(context, mapping, self._value)

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

172

38185

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

173 class _mappingsequence(wrapped):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

174 """Wrapper for sequence of template mappings

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

175

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

176 This represents an inner template structure (i.e. a list of dicts),

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

177 which can also be rendered by the specified named/literal template.

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

178

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

179 Template mappings may be nested.

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

180 """

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

181

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

182 def __init__(self, name=None, tmpl=None, sep=''):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

183 if name is not None and tmpl is not None:

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

184 raise error.ProgrammingError('name and tmpl are mutually exclusive')

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

185 self._name = name

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

186 self._tmpl = tmpl

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

187 self._defaultsep = sep

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

188

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

189 def join(self, context, mapping, sep):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

190 mapsiter = _iteroverlaymaps(context, mapping, self.itermaps(context))

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

191 if self._name:

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

192 itemiter = (context.process(self._name, m) for m in mapsiter)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

193 elif self._tmpl:

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

194 itemiter = (context.expand(self._tmpl, m) for m in mapsiter)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

195 else:

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

196 raise error.ParseError(_('not displayable without template'))

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

197 return joinitems(itemiter, sep)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

198

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

199 def show(self, context, mapping):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

200 return self.join(context, mapping, self._defaultsep)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

201

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

202 def tovalue(self, context, mapping):

38288

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

203 knownres = context.knownresourcekeys()

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

204 items = []

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

205 for nm in self.itermaps(context):

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

206 # drop internal resources (recursively) which shouldn't be displayed

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

207 lm = context.overlaymap(mapping, nm)

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

208 items.append({k: unwrapvalue(context, lm, v)

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

209 for k, v in nm.iteritems() if k not in knownres})

40c7347f6848 formatter: remove template resources from nested items before generating JSON

Yuya Nishihara <yuya@tcha.org>

parents: 38285

diff changeset

210 return items

38185

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

211

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

212 class mappinggenerator(_mappingsequence):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

213 """Wrapper for generator of template mappings

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

214

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

215 The function ``make(context, *args)`` should return a generator of

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

216 mapping dicts.

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

217 """

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

218

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

219 def __init__(self, make, args=(), name=None, tmpl=None, sep=''):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

220 super(mappinggenerator, self).__init__(name, tmpl, sep)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

221 self._make = make

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

222 self._args = args

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

223

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

224 def itermaps(self, context):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

225 return self._make(context, *self._args)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

226

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

227 class mappinglist(_mappingsequence):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

228 """Wrapper for list of template mappings"""

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

229

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

230 def __init__(self, mappings, name=None, tmpl=None, sep=''):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

231 super(mappinglist, self).__init__(name, tmpl, sep)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

232 self._mappings = mappings

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

233

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

234 def itermaps(self, context):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

235 return iter(self._mappings)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

236

38285

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

237 class mappedgenerator(wrapped):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

238 """Wrapper for generator of strings which acts as a list

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

239

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

240 The function ``make(context, *args)`` should return a generator of

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

241 byte strings, or a generator of (possibly nested) generators of byte

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

242 strings (i.e. a generator for a list of byte strings.)

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

243 """

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

244

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

245 def __init__(self, make, args=()):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

246 self._make = make

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

247 self._args = args

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

248

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

249 def _gen(self, context):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

250 return self._make(context, *self._args)

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

251

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

252 def itermaps(self, context):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

253 raise error.ParseError(_('list of strings is not mappable'))

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

254

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

255 def join(self, context, mapping, sep):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

256 return joinitems(self._gen(context), sep)

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

257

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

258 def show(self, context, mapping):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

259 return self.join(context, mapping, '')

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

260

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

261 def tovalue(self, context, mapping):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

262 return [stringify(context, mapping, x) for x in self._gen(context)]

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

263

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

264 def hybriddict(data, key='key', value='value', fmt=None, gen=None):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

265 """Wrap data to support both dict-like and string-like operations"""

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

266 prefmt = pycompat.identity

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

267 if fmt is None:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

268 fmt = '%s=%s'

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

269 prefmt = pycompat.bytestr

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

270 return hybrid(gen, data, lambda k: {key: k, value: data[k]},

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

271 lambda k: fmt % (prefmt(k), prefmt(data[k])))

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

272

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

273 def hybridlist(data, name, fmt=None, gen=None):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

274 """Wrap data to support both list-like and string-like operations"""

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

275 prefmt = pycompat.identity

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

276 if fmt is None:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

277 fmt = '%s'

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

278 prefmt = pycompat.bytestr

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

279 return hybrid(gen, data, lambda x: {name: x}, lambda x: fmt % prefmt(x))

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

280

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

281 def unwraphybrid(context, mapping, thing):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

282 """Return an object which can be stringified possibly by using a legacy

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

283 template"""

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

284 if not isinstance(thing, wrapped):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

285 return thing

38059

83e1bbd48991 templater: define interface for objects requiring unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38058

diff changeset

286 return thing.show(context, mapping)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

287

38063

9e8128e84326 templater: pass (context, mapping) down to unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38062

diff changeset

288 def unwrapvalue(context, mapping, thing):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

289 """Move the inner value object out of the wrapper"""

38065

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

290 if not isinstance(thing, wrapped):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

291 return thing

38065

26f6fc179e62 templater: define interface for objects requiring unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38064

diff changeset

292 return thing.tovalue(context, mapping)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

293

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

294 def wraphybridvalue(container, key, value):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

295 """Wrap an element of hybrid container to be mappable

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

296

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

297 The key is passed to the makemap function of the given container, which

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

298 should be an item generated by iter(container).

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

299 """

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

300 makemap = getattr(container, '_makemap', None)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

301 if makemap is None:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

302 return value

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

303 if util.safehasattr(value, '_makemap'):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

304 # a nested hybrid list/dict, which has its own way of map operation

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

305 return value

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

306 return mappable(None, key, value, makemap)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

307

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

308 def compatdict(context, mapping, name, data, key='key', value='value',

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

309 fmt=None, plural=None, separator=' '):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

310 """Wrap data like hybriddict(), but also supports old-style list template

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

311

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

312 This exists for backward compatibility with the old-style template. Use

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

313 hybriddict() for new template keywords.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

314 """

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

315 c = [{key: k, value: v} for k, v in data.iteritems()]

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

316 f = _showcompatlist(context, mapping, name, c, plural, separator)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

317 return hybriddict(data, key=key, value=value, fmt=fmt, gen=f)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

318

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

319 def compatlist(context, mapping, name, data, element=None, fmt=None,

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

320 plural=None, separator=' '):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

321 """Wrap data like hybridlist(), but also supports old-style list template

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

322

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

323 This exists for backward compatibility with the old-style template. Use

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

324 hybridlist() for new template keywords.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

325 """

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

326 f = _showcompatlist(context, mapping, name, data, plural, separator)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

327 return hybridlist(data, name=element or name, fmt=fmt, gen=f)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

328

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

329 def _showcompatlist(context, mapping, name, values, plural=None, separator=' '):

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

330 """Return a generator that renders old-style list template

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

331

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

332 name is name of key in template map.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

333 values is list of strings or dicts.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

334 plural is plural of name, if not simply name + 's'.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

335 separator is used to join values as a string

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

336

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

337 expansion works like this, given name 'foo'.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

338

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

339 if values is empty, expand 'no_foos'.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

340

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

341 if 'foo' not in template map, return values as a string,

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

342 joined by 'separator'.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

343

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

344 expand 'start_foos'.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

345

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

346 for each value, expand 'foo'. if 'last_foo' in template

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

347 map, expand it instead of 'foo' for last key.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

348

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

349 expand 'end_foos'.

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

350 """

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

351 if not plural:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

352 plural = name + 's'

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

353 if not values:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

354 noname = 'no_' + plural

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

355 if context.preload(noname):

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

356 yield context.process(noname, mapping)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

357 return

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

358 if not context.preload(name):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

359 if isinstance(values[0], bytes):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

360 yield separator.join(values)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

361 else:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

362 for v in values:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

363 r = dict(v)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

364 r.update(mapping)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

365 yield r

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

366 return

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

367 startname = 'start_' + plural

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

368 if context.preload(startname):

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

369 yield context.process(startname, mapping)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

370 def one(v, tag=name):

37860

2891079fb0c0 templater: factor out function to create mapping dict for nested evaluation

Yuya Nishihara <yuya@tcha.org>

parents: 37859

diff changeset

371 vmapping = {}

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

372 try:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

373 vmapping.update(v)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

374 # Python 2 raises ValueError if the type of v is wrong. Python

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

375 # 3 raises TypeError.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

376 except (AttributeError, TypeError, ValueError):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

377 try:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

378 # Python 2 raises ValueError trying to destructure an e.g.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

379 # bytes. Python 3 raises TypeError.

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

380 for a, b in v:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

381 vmapping[a] = b

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

382 except (TypeError, ValueError):

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

383 vmapping[name] = v

37860

2891079fb0c0 templater: factor out function to create mapping dict for nested evaluation

Yuya Nishihara <yuya@tcha.org>

parents: 37859

diff changeset

384 vmapping = context.overlaymap(mapping, vmapping)

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

385 return context.process(tag, vmapping)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

386 lastname = 'last_' + name

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

387 if context.preload(lastname):

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

388 last = values.pop()

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

389 else:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

390 last = None

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

391 for v in values:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

392 yield one(v)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

393 if last is not None:

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

394 yield one(last, tag=lastname)

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

395 endname = 'end_' + plural

37854

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

396 if context.preload(endname):

aa97e06a1912 templater: use template context to render old-style list template

Yuya Nishihara <yuya@tcha.org>

parents: 37805

diff changeset

397 yield context.process(endname, mapping)

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

398

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

399 def flatten(context, mapping, thing):

37943

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

400 """Yield a single stream from a possibly nested set of iterators"""

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

401 thing = unwraphybrid(context, mapping, thing)

37943

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

402 if isinstance(thing, bytes):

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

403 yield thing

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

404 elif isinstance(thing, str):

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

405 # We can only hit this on Python 3, and it's here to guard

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

406 # against infinite recursion.

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

407 raise error.ProgrammingError('Mercurial IO including templates is done'

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

408 ' with bytes, not strings, got %r' % thing)

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

409 elif thing is None:

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

410 pass

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

411 elif not util.safehasattr(thing, '__iter__'):

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

412 yield pycompat.bytestr(thing)

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

413 else:

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

414 for i in thing:

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

415 i = unwraphybrid(context, mapping, i)

37943

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

416 if isinstance(i, bytes):

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

417 yield i

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

418 elif i is None:

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

419 pass

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

420 elif not util.safehasattr(i, '__iter__'):

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

421 yield pycompat.bytestr(i)

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

422 else:

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

423 for j in flatten(context, mapping, i):

37943

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

424 yield j

888507ec655e templateutil: move flatten() from templater

Yuya Nishihara <yuya@tcha.org>

parents: 37890

diff changeset

425

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

426 def stringify(context, mapping, thing):

37706

6ff6e1d6b5b8 templater: move stringify() to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37699

diff changeset

427 """Turn values into bytes by converting into text and concatenating them"""

37944

e09d2183e226 templateutil: reimplement stringify() using flatten()

Yuya Nishihara <yuya@tcha.org>

parents: 37943

diff changeset

428 if isinstance(thing, bytes):

e09d2183e226 templateutil: reimplement stringify() using flatten()

Yuya Nishihara <yuya@tcha.org>

parents: 37943

diff changeset

429 return thing # retain localstr to be round-tripped

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

430 return b''.join(flatten(context, mapping, thing))

37706

6ff6e1d6b5b8 templater: move stringify() to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37699

diff changeset

431

32706

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

432 def findsymbolicname(arg):

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

433 """Find symbolic name for the given compiled expression; returns None

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

434 if nothing found reliably"""

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

435 while True:

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

436 func, data = arg

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

437 if func is runsymbol:

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

438 return data

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

439 elif func is runfilter:

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

440 arg = data[0]

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

441 else:

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

442 return None

2abc556dbe92 templater: find keyword name more thoroughly on filtering error

Yuya Nishihara <yuya@tcha.org>

parents: 32705

diff changeset

443

38064

671a01cd50b5 templater: extract private function to evaluate generator to byte string

Yuya Nishihara <yuya@tcha.org>

parents: 38063

diff changeset

444 def _unthunk(context, mapping, thing):

671a01cd50b5 templater: extract private function to evaluate generator to byte string

Yuya Nishihara <yuya@tcha.org>

parents: 38063

diff changeset

445 """Evaluate a lazy byte string into value"""

671a01cd50b5 templater: extract private function to evaluate generator to byte string

Yuya Nishihara <yuya@tcha.org>

parents: 38063

diff changeset

446 if not isinstance(thing, types.GeneratorType):

671a01cd50b5 templater: extract private function to evaluate generator to byte string

Yuya Nishihara <yuya@tcha.org>

parents: 38063

diff changeset

447 return thing

671a01cd50b5 templater: extract private function to evaluate generator to byte string

Yuya Nishihara <yuya@tcha.org>

parents: 38063

diff changeset

448 return stringify(context, mapping, thing)

671a01cd50b5 templater: extract private function to evaluate generator to byte string

Yuya Nishihara <yuya@tcha.org>

parents: 38063

diff changeset

449

35109

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

450 def evalrawexp(context, mapping, arg):

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

451 """Evaluate given argument as a bare template object which may require

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

452 further processing (such as folding generator of strings)"""

26720

604a7c941103 templater: extract helper that evaluates filter or function argument

Yuya Nishihara <yuya@tcha.org>

parents: 26693

diff changeset

453 func, data = arg

35109

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

454 return func(context, mapping, data)

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

455

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

456 def evalfuncarg(context, mapping, arg):

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

457 """Evaluate given argument as value type"""

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

458 return _unwrapvalue(context, mapping, evalrawexp(context, mapping, arg))

37947

0023da2910c9 templater: extract type conversion from evalfuncarg()

Yuya Nishihara <yuya@tcha.org>

parents: 37946

diff changeset

459

0023da2910c9 templater: extract type conversion from evalfuncarg()

Yuya Nishihara <yuya@tcha.org>

parents: 37946

diff changeset

460 # TODO: unify this with unwrapvalue() once the bug of templatefunc.join()

0023da2910c9 templater: extract type conversion from evalfuncarg()

Yuya Nishihara <yuya@tcha.org>

parents: 37946

diff changeset

461 # is fixed. we can't do that right now because join() has to take a generator

0023da2910c9 templater: extract type conversion from evalfuncarg()

Yuya Nishihara <yuya@tcha.org>

parents: 37946

diff changeset

462 # of byte strings as it is, not a lazy byte string.

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

463 def _unwrapvalue(context, mapping, thing):

38063

9e8128e84326 templater: pass (context, mapping) down to unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38062

diff changeset

464 thing = unwrapvalue(context, mapping, thing)

35109

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

465 # evalrawexp() may return string, generator of strings or arbitrary object

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

466 # such as date tuple, but filter does not want generator.

38064

671a01cd50b5 templater: extract private function to evaluate generator to byte string

Yuya Nishihara <yuya@tcha.org>

parents: 38063

diff changeset

467 return _unthunk(context, mapping, thing)

26720

604a7c941103 templater: extract helper that evaluates filter or function argument

Yuya Nishihara <yuya@tcha.org>

parents: 26693

diff changeset

468

30586

034412ca28c3 templater: fix if() to not evaluate False as bool('False')

Yuya Nishihara <yuya@tcha.org>

parents: 30585

diff changeset

469 def evalboolean(context, mapping, arg):

30587

cc11079644fc templater: make pad() evaluate boolean argument (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 30586

diff changeset

470 """Evaluate given argument as boolean, but also takes boolean literals"""

30586

034412ca28c3 templater: fix if() to not evaluate False as bool('False')

Yuya Nishihara <yuya@tcha.org>

parents: 30585

diff changeset

471 func, data = arg

30587

cc11079644fc templater: make pad() evaluate boolean argument (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 30586

diff changeset

472 if func is runsymbol:

cc11079644fc templater: make pad() evaluate boolean argument (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 30586

diff changeset

473 thing = func(context, mapping, data, default=None)

cc11079644fc templater: make pad() evaluate boolean argument (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 30586

diff changeset

474 if thing is None:

cc11079644fc templater: make pad() evaluate boolean argument (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 30586

diff changeset

475 # not a template keyword, takes as a boolean literal

37870

f0b6fbea00cf stringutil: bulk-replace call sites to point to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37860

diff changeset

476 thing = stringutil.parsebool(data)

30587

cc11079644fc templater: make pad() evaluate boolean argument (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 30586

diff changeset

477 else:

cc11079644fc templater: make pad() evaluate boolean argument (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 30586

diff changeset

478 thing = func(context, mapping, data)

38063

9e8128e84326 templater: pass (context, mapping) down to unwrapvalue()

Yuya Nishihara <yuya@tcha.org>

parents: 38062

diff changeset

479 thing = unwrapvalue(context, mapping, thing)

30586

034412ca28c3 templater: fix if() to not evaluate False as bool('False')

Yuya Nishihara <yuya@tcha.org>

parents: 30585

diff changeset

480 if isinstance(thing, bool):

034412ca28c3 templater: fix if() to not evaluate False as bool('False')

Yuya Nishihara <yuya@tcha.org>

parents: 30585

diff changeset

481 return thing

034412ca28c3 templater: fix if() to not evaluate False as bool('False')

Yuya Nishihara <yuya@tcha.org>

parents: 30585

diff changeset

482 # other objects are evaluated as strings, which means 0 is True, but

034412ca28c3 templater: fix if() to not evaluate False as bool('False')

Yuya Nishihara <yuya@tcha.org>

parents: 30585

diff changeset

483 # empty dict/list should be False as they are expected to be ''

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

484 return bool(stringify(context, mapping, thing))

30586

034412ca28c3 templater: fix if() to not evaluate False as bool('False')

Yuya Nishihara <yuya@tcha.org>

parents: 30585

diff changeset

485

38010

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

486 def evaldate(context, mapping, arg, err=None):

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

487 """Evaluate given argument as a date tuple or a date string; returns

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

488 a (unixtime, offset) tuple"""

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

489 thing = evalrawexp(context, mapping, arg)

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

490 return unwrapdate(context, mapping, thing, err)

38010

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

491

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

492 def unwrapdate(context, mapping, thing, err=None):

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

493 thing = _unwrapvalue(context, mapping, thing)

38010

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

494 try:

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

495 return dateutil.parsedate(thing)

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

496 except AttributeError:

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

497 raise error.ParseError(err or _('not a date tuple nor a string'))

38011

e70a90a72b80 templatefuncs: use evaldate() where seems appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38010

diff changeset

498 except error.ParseError:

e70a90a72b80 templatefuncs: use evaldate() where seems appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38010

diff changeset

499 if not err:

e70a90a72b80 templatefuncs: use evaldate() where seems appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38010

diff changeset

500 raise

e70a90a72b80 templatefuncs: use evaldate() where seems appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38010

diff changeset

501 raise error.ParseError(err)

38010

67efce231633 templater: factor out function that parses argument as date tuple

Yuya Nishihara <yuya@tcha.org>

parents: 38008

diff changeset

502

35364

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

503 def evalinteger(context, mapping, arg, err=None):

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

504 thing = evalrawexp(context, mapping, arg)

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

505 return unwrapinteger(context, mapping, thing, err)

37948

9ab3491f84c2 templater: extract unwrapinteger() function from evalinteger()

Yuya Nishihara <yuya@tcha.org>

parents: 37947

diff changeset

506

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

507 def unwrapinteger(context, mapping, thing, err=None):

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

508 thing = _unwrapvalue(context, mapping, thing)

29014

a6c2310b3827 templater: factor out function that evaluates argument as integer

Yuya Nishihara <yuya@tcha.org>

parents: 29005

diff changeset

509 try:

37948

9ab3491f84c2 templater: extract unwrapinteger() function from evalinteger()

Yuya Nishihara <yuya@tcha.org>

parents: 37947

diff changeset

510 return int(thing)

29015

ac371d4c007f templater: drop redundant type conversion when evaluating integer argument

Yuya Nishihara <yuya@tcha.org>

parents: 29014

diff changeset

511 except (TypeError, ValueError):

35364

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

512 raise error.ParseError(err or _('not an integer'))

29014

a6c2310b3827 templater: factor out function that evaluates argument as integer

Yuya Nishihara <yuya@tcha.org>

parents: 29005

diff changeset

513

29019

ccedb17a5657 templater: factor out thin helper that evaluates argument as string

Yuya Nishihara <yuya@tcha.org>

parents: 29017

diff changeset

514 def evalstring(context, mapping, arg):

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

515 return stringify(context, mapping, evalrawexp(context, mapping, arg))

29019

ccedb17a5657 templater: factor out thin helper that evaluates argument as string

Yuya Nishihara <yuya@tcha.org>

parents: 29017

diff changeset

516

29044

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

517 def evalstringliteral(context, mapping, arg):

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

518 """Evaluate given argument as string template, but returns symbol name

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

519 if it is unknown"""

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

520 func, data = arg

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

521 if func is runsymbol:

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

522 thing = func(context, mapping, data, default=data)

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

523 else:

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

524 thing = func(context, mapping, data)

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

525 return stringify(context, mapping, thing)

29044

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

526

37949

0fb28899e81a templater: factor out unwrapastype() from evalastype()

Yuya Nishihara <yuya@tcha.org>

parents: 37948

diff changeset

527 _unwrapfuncbytype = {

38008

54355c243042 templatefilters: allow declaration of input data type

Yuya Nishihara <yuya@tcha.org>

parents: 37949

diff changeset

528 None: _unwrapvalue,

37949

0fb28899e81a templater: factor out unwrapastype() from evalastype()

Yuya Nishihara <yuya@tcha.org>

parents: 37948

diff changeset

529 bytes: stringify,

38013

9bcf096a2da2 templatefilters: declare input type as date where appropriate

Yuya Nishihara <yuya@tcha.org>

parents: 38012

diff changeset

530 date: unwrapdate,

37949

0fb28899e81a templater: factor out unwrapastype() from evalastype()

Yuya Nishihara <yuya@tcha.org>

parents: 37948

diff changeset

531 int: unwrapinteger,

35364

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

532 }

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

533

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

534 def unwrapastype(context, mapping, thing, typ):

37949

0fb28899e81a templater: factor out unwrapastype() from evalastype()

Yuya Nishihara <yuya@tcha.org>

parents: 37948

diff changeset

535 """Move the inner value object out of the wrapper and coerce its type"""

35364

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

536 try:

37949

0fb28899e81a templater: factor out unwrapastype() from evalastype()

Yuya Nishihara <yuya@tcha.org>

parents: 37948

diff changeset

537 f = _unwrapfuncbytype[typ]

35364

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

538 except KeyError:

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

539 raise error.ProgrammingError('invalid type specified: %r' % typ)

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

540 return f(context, mapping, thing)

35364

ee0d74083a22 templater: store revisions as ints so min/max won't compare them as strings

Yuya Nishihara <yuya@tcha.org>

parents: 35319

diff changeset

541

25393

829faf8ab605 templater: tokenize decimal integer literal (issue4638) (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 25392

diff changeset

542 def runinteger(context, mapping, data):

829faf8ab605 templater: tokenize decimal integer literal (issue4638) (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 25392

diff changeset

543 return int(data)

829faf8ab605 templater: tokenize decimal integer literal (issue4638) (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 25392

diff changeset

544

13177

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

545 def runstring(context, mapping, data):

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

546 return data

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

547

28610

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

548 def _recursivesymbolblocker(key):

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

549 def showrecursion(**args):

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

550 raise error.Abort(_("recursive reference '%s' in template") % key)

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

551 return showrecursion

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

552

29044

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

553 def runsymbol(context, mapping, key, default=''):

36250

d6cfa722b044 templater: look up mapping table through template engine

Yuya Nishihara <yuya@tcha.org>

parents: 36197

diff changeset

554 v = context.symbol(mapping, key)

19770

0361163efbaf templater: support using templates with non-standard names from map file

Alexander Plavin <alexander@plav.in>

parents: 19390

diff changeset

555 if v is None:

28610

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

556 # put poison to cut recursion. we can't move this to parsing phase

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

557 # because "x = {x}" is allowed if "x" is a keyword. (issue4758)

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

558 safemapping = mapping.copy()

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

559 safemapping[key] = _recursivesymbolblocker(key)

19770

0361163efbaf templater: support using templates with non-standard names from map file

Alexander Plavin <alexander@plav.in>

parents: 19390

diff changeset

560 try:

28610

7ed3a3c0cef1 templater: abort if infinite recursion detected while evaluation (issue4758)

Yuya Nishihara <yuya@tcha.org>

parents: 28547

diff changeset

561 v = context.process(key, safemapping)

19770

0361163efbaf templater: support using templates with non-standard names from map file

Alexander Plavin <alexander@plav.in>

parents: 19390

diff changeset

562 except TemplateNotFound:

29044

9a9dd71e882c templater: make label() take unknown symbol as color literal

Yuya Nishihara <yuya@tcha.org>

parents: 29020

diff changeset

563 v = default

37231

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

564 if callable(v) and getattr(v, '_requires', None) is None:

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

565 # old templatekw: expand all keywords and resources

37856

1101d6747d2d templater: drop 'templ' from resources dict

Yuya Nishihara <yuya@tcha.org>

parents: 37854

diff changeset

566 # (TODO: deprecate this after porting web template keywords to new API)

37859

44757e6dad93 templater: introduce resourcemapper class

Yuya Nishihara <yuya@tcha.org>

parents: 37856

diff changeset

567 props = {k: context._resources.lookup(context, mapping, k)

44757e6dad93 templater: introduce resourcemapper class

Yuya Nishihara <yuya@tcha.org>

parents: 37856

diff changeset

568 for k in context._resources.knownkeys()}

37856

1101d6747d2d templater: drop 'templ' from resources dict

Yuya Nishihara <yuya@tcha.org>

parents: 37854

diff changeset

569 # pass context to _showcompatlist() through templatekw._showlist()

1101d6747d2d templater: drop 'templ' from resources dict

Yuya Nishihara <yuya@tcha.org>

parents: 37854

diff changeset

570 props['templ'] = context

36251

32c278eb876f templater: keep default resources per template engine (API)

Yuya Nishihara <yuya@tcha.org>

parents: 36250

diff changeset

571 props.update(mapping)

36374

dadbf213a765 py3: convert dict keys' to str before passing as kwargs

Pulkit Goyal <7895pulkit@gmail.com>

parents: 36264

diff changeset

572 return v(**pycompat.strkwargs(props))

37231

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

573 if callable(v):

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

574 # new templatekw

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

575 try:

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

576 return v(context, mapping)

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

577 except ResourceUnavailable:

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

578 # unsupported keyword is mapped to empty just like unknown keyword

e8d37838f5df templatekw: add 'requires' flag to switch to exception-safe interface

Yuya Nishihara <yuya@tcha.org>

parents: 37230

diff changeset

579 return None

13177

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

580 return v

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

581

26138

a7dd6692e5cb templater: move runtemplate function out of buildmap/runmap pair

Yuya Nishihara <yuya@tcha.org>

parents: 26123

diff changeset

582 def runtemplate(context, mapping, template):

35109

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

583 for arg in template:

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

584 yield evalrawexp(context, mapping, arg)

26138

a7dd6692e5cb templater: move runtemplate function out of buildmap/runmap pair

Yuya Nishihara <yuya@tcha.org>

parents: 26123

diff changeset

585

13177

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

586 def runfilter(context, mapping, data):

26721

c990afab2243 templater: drop unneeded destructuring of argument tuple at buildfilter

Yuya Nishihara <yuya@tcha.org>

parents: 26720

diff changeset

587 arg, filt = data

38008

54355c243042 templatefilters: allow declaration of input data type

Yuya Nishihara <yuya@tcha.org>

parents: 37949

diff changeset

588 thing = evalrawexp(context, mapping, arg)

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

589 intype = getattr(filt, '_intype', None)

17383

099c778ceb33 templater: abort when a template filter raises an exception (issue2987)

Neil Kodner <neilk@fb.com>

parents: 17334

diff changeset

590 try:

38058

7d3bc1d4e871 templater: pass (context, mapping) down to unwraphybrid()

Yuya Nishihara <yuya@tcha.org>

parents: 38017

diff changeset

591 thing = unwrapastype(context, mapping, thing, intype)

24387

6c55e37ba5f2 templater: allow piping generator-type function output to filters

Yuya Nishihara <yuya@tcha.org>

parents: 24342

diff changeset

592 return filt(thing)

38012

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

593 except error.ParseError as e:

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

594 raise error.ParseError(bytes(e), hint=_formatfiltererror(arg, filt))

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

595

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

596 def _formatfiltererror(arg, filt):

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

597 fn = pycompat.sysbytes(filt.__name__)

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

598 sym = findsymbolicname(arg)

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

599 if not sym:

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

600 return _("incompatible use of template filter '%s'") % fn

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

601 return (_("template filter '%s' is not compatible with keyword '%s'")

920589f52be9 templater: attach hint to input-type error of runfilter()

Yuya Nishihara <yuya@tcha.org>

parents: 38011

diff changeset

602 % (fn, sym))

13177

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

603

38190

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

604 def _checkeditermaps(darg, d):

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

605 try:

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

606 for v in d:

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

607 if not isinstance(v, dict):

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

608 raise TypeError

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

609 yield v

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

610 except TypeError:

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

611 sym = findsymbolicname(darg)

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

612 if sym:

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

613 raise error.ParseError(_("keyword '%s' is not iterable of mappings")

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

614 % sym)

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

615 else:

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

616 raise error.ParseError(_("%r is not iterable of mappings") % d)

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

617

38185

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

618 def _iteroverlaymaps(context, origmapping, newmappings):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

619 """Generate combined mappings from the original mapping and an iterable

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

620 of partial mappings to override the original"""

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

621 for i, nm in enumerate(newmappings):

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

622 lm = context.overlaymap(origmapping, nm)

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

623 lm['index'] = i

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

624 yield lm

0b64416224d9 templater: add class representing a nested mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38115

diff changeset

625

38285

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

626 def _applymap(context, mapping, diter, targ):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

627 for lm in _iteroverlaymaps(context, mapping, diter):

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

628 yield evalrawexp(context, lm, targ)

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

629

13177

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

630 def runmap(context, mapping, data):

35109

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

631 darg, targ = data

e60c601953d7 templater: extract helper to just evaluate template expression

Yuya Nishihara <yuya@tcha.org>

parents: 35108

diff changeset

632 d = evalrawexp(context, mapping, darg)

38190

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

633 # TODO: a generator should be rejected because it is a thunk of lazy

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

634 # string, but we can't because hgweb abuses generator as a keyword

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

635 # that returns a list of dicts.

38285

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

636 # TODO: drop _checkeditermaps() and pass 'd' to mappedgenerator so it

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

637 # can be restarted.

38109

8c31b434697f templater: define interface for objects which act as iterator of mappings

Yuya Nishihara <yuya@tcha.org>

parents: 38065

diff changeset

638 if isinstance(d, wrapped):

38110

c2f74b8f6b7f templater: pass context to itermaps() for future extension

Yuya Nishihara <yuya@tcha.org>

parents: 38109

diff changeset

639 diter = d.itermaps(context)

29020

7cb2f2438f85 templater: handle exception when applying map operator to non-iterable object

Yuya Nishihara <yuya@tcha.org>

parents: 29019

diff changeset

640 else:

38190

7c902a8345ef templater: complain about invalid application of '%' operator (BC)

Yuya Nishihara <yuya@tcha.org>

parents: 38185

diff changeset

641 diter = _checkeditermaps(darg, d)

38285

75c13343cf38 templater: wrap result of '%' operation so it never looks like a thunk

Yuya Nishihara <yuya@tcha.org>

parents: 38191

diff changeset

642 return mappedgenerator(_applymap, args=(mapping, diter, targ))

13177

895f54a79c6e templater: use the parser.py parser to extend the templater syntax

Matt Mackall <mpm@selenic.com>

parents: 13176

diff changeset

643

35318

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

644 def runmember(context, mapping, data):

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

645 darg, memb = data

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

646 d = evalrawexp(context, mapping, darg)

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

647 if util.safehasattr(d, 'tomap'):

37860

2891079fb0c0 templater: factor out function to create mapping dict for nested evaluation

Yuya Nishihara <yuya@tcha.org>

parents: 37859

diff changeset

648 lm = context.overlaymap(mapping, d.tomap())

35318

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

649 return runsymbol(context, lm, memb)

35319

4c1cfe54c08d templater: extend dot operator as a short for get(dict, key)

Yuya Nishihara <yuya@tcha.org>

parents: 35318

diff changeset

650 if util.safehasattr(d, 'get'):

37699

da2977e674a3 templater: extract template evaluation utility to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37698

diff changeset

651 return getdictitem(d, memb)

35318

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

652

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

653 sym = findsymbolicname(darg)

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

654 if sym:

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

655 raise error.ParseError(_("keyword '%s' has no member") % sym)

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

656 else:

37331

ab7f86a748e6 py3: drop b'' from error message generated by templater.runmember()

Yuya Nishihara <yuya@tcha.org>

parents: 37330

diff changeset

657 raise error.ParseError(_("%r has no member") % pycompat.bytestr(d))

35318

78590585c0db templater: add dot operator to easily access a sub item

Yuya Nishihara <yuya@tcha.org>

parents: 35317

diff changeset

658

30894

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

659 def runnegate(context, mapping, data):

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

660 data = evalinteger(context, mapping, data,

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

661 _('negation needs an integer argument'))

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

662 return -data

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

663

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

664 def runarithmetic(context, mapping, data):

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

665 func, left, right = data

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

666 left = evalinteger(context, mapping, left,

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

667 _('arithmetic only defined on integers'))

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

668 right = evalinteger(context, mapping, right,

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

669 _('arithmetic only defined on integers'))

30895

1c01fa29630f templater: handle division by zero in arithmetic

Simon Farnsworth <simonfar@fb.com>

parents: 30894

diff changeset

670 try:

1c01fa29630f templater: handle division by zero in arithmetic

Simon Farnsworth <simonfar@fb.com>

parents: 30894

diff changeset

671 return func(left, right)

1c01fa29630f templater: handle division by zero in arithmetic

Simon Farnsworth <simonfar@fb.com>

parents: 30894

diff changeset

672 except ZeroDivisionError:

1c01fa29630f templater: handle division by zero in arithmetic

Simon Farnsworth <simonfar@fb.com>

parents: 30894

diff changeset

673 raise error.Abort(_('division by zero is not defined'))

30894

8e42dfde93d1 templater: provide arithmetic operations on integers

Simon Farnsworth <simonfar@fb.com>

parents: 30862

diff changeset

674

37699

da2977e674a3 templater: extract template evaluation utility to new module

Yuya Nishihara <yuya@tcha.org>

parents: 37698

diff changeset

675 def getdictitem(dictarg, key):

35317

b3073e175c17 templater: wrap get/min/max result so map operation can apply to element

Yuya Nishihara <yuya@tcha.org>

parents: 35241

diff changeset

676 val = dictarg.get(key)

b3073e175c17 templater: wrap get/min/max result so map operation can apply to element

Yuya Nishihara <yuya@tcha.org>

parents: 35241

diff changeset

677 if val is None:

b3073e175c17 templater: wrap get/min/max result so map operation can apply to element

Yuya Nishihara <yuya@tcha.org>

parents: 35241

diff changeset

678 return

37707

32f9b7e3f056 templater: move hybrid class and functions to templateutil module

Yuya Nishihara <yuya@tcha.org>

parents: 37706

diff changeset

679 return wraphybridvalue(dictarg, key, val)

38111

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

680

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

681 def joinitems(itemiter, sep):

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

682 """Join items with the separator; Returns generator of bytes"""

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

683 first = True

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

684 for x in itemiter:

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

685 if first:

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

686 first = False

38112

9cd88dd3bf64 templater: micro-optimize join() with empty separator

Yuya Nishihara <yuya@tcha.org>

parents: 38111

diff changeset

687 elif sep:

38111

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

688 yield sep

41a5d815d2c1 templater: factor out generator of join()-ed items

Yuya Nishihara <yuya@tcha.org>

parents: 38110

diff changeset

689 yield x

Mercurial > hg > mercurial-source

annotate mercurial/templateutil.py @ 38443:23c4ddda7bbe