templater.py
289 lines
| 9.3 KiB
| text/x-python
|
PythonLexer
/ mercurial / templater.py
|
r1909 | # templater.py - template expansion for output | ||
# | ||||
# Copyright 2005, 2006 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r1909 | |||
|
r3891 | from i18n import _ | ||
|
r10843 | import sys, os | ||
|
r8360 | import util, config, templatefilters | ||
|
r1901 | |||
|
r7107 | path = ['templates', '../templates'] | ||
|
r8360 | stringify = templatefilters.stringify | ||
|
r7107 | |||
|
r10850 | def _flatten(thing): | ||
'''yield a single stream from a possibly nested set of iterators''' | ||||
if isinstance(thing, str): | ||||
yield thing | ||||
elif not hasattr(thing, '__iter__'): | ||||
|
r11305 | if thing is not None: | ||
|
r10852 | yield str(thing) | ||
else: | ||||
|
r10850 | for i in thing: | ||
if isinstance(i, str): | ||||
yield i | ||||
elif not hasattr(i, '__iter__'): | ||||
|
r10852 | if i is not None: | ||
yield str(i) | ||||
|
r10850 | elif i is not None: | ||
for j in _flatten(i): | ||||
yield j | ||||
|
r1902 | def parsestring(s, quoted=True): | ||
|
r1909 | '''parse a string using simple c-like syntax. | ||
string must be in quotes if quoted is True.''' | ||||
|
r1902 | if quoted: | ||
|
r3639 | if len(s) < 2 or s[0] != s[-1]: | ||
raise SyntaxError(_('unmatched quotes')) | ||||
return s[1:-1].decode('string_escape') | ||||
|
r3632 | |||
return s.decode('string_escape') | ||||
|
r1896 | |||
|
r8218 | class engine(object): | ||
|
r1909 | '''template expansion engine. | ||
template expansion works like this. a map file contains key=value | ||||
pairs. if value is quoted, it is treated as string. otherwise, it | ||||
is treated as name of template file. | ||||
templater is asked to expand a key in map. it looks up key, and | ||||
|
r4334 | looks for strings like this: {foo}. it expands {foo} by looking up | ||
|
r1909 | foo in map, and substituting it. expansion is recursive: it stops | ||
when there is no more {foo} to replace. | ||||
expansion also allows formatting and filtering. | ||||
format uses key to expand each item in list. syntax is | ||||
{key%format}. | ||||
filter uses function to transform value. syntax is | ||||
{key|filter1|filter2|...}.''' | ||||
|
r8218 | def __init__(self, loader, filters={}, defaults={}): | ||
|
r10848 | self._loader = loader | ||
self._filters = filters | ||||
self._defaults = defaults | ||||
self._cache = {} | ||||
|
r8218 | |||
|
r10853 | def process(self, t, mapping): | ||
'''Perform expansion. t is name of map element to expand. | ||||
mapping contains added elements for use during expansion. Is a | ||||
generator.''' | ||||
return _flatten(self._process(self._load(t), mapping)) | ||||
|
r10852 | def _load(self, t): | ||
'''load, parse, and cache a template''' | ||||
|
r10848 | if t not in self._cache: | ||
self._cache[t] = self._parse(self._loader(t)) | ||||
|
r10852 | return self._cache[t] | ||
def _get(self, mapping, key): | ||||
v = mapping.get(key) | ||||
if v is None: | ||||
v = self._defaults.get(key, '') | ||||
if hasattr(v, '__call__'): | ||||
v = v(**mapping) | ||||
return v | ||||
def _filter(self, mapping, parts): | ||||
filters, val = parts | ||||
x = self._get(mapping, val) | ||||
for f in filters: | ||||
x = f(x) | ||||
return x | ||||
def _format(self, mapping, args): | ||||
key, parsed = args | ||||
v = self._get(mapping, key) | ||||
if not hasattr(v, '__iter__'): | ||||
raise SyntaxError(_("error expanding '%s%%%s'") | ||||
% (key, format)) | ||||
lm = mapping.copy() | ||||
for i in v: | ||||
if isinstance(i, dict): | ||||
lm.update(i) | ||||
yield self._process(parsed, lm) | ||||
else: | ||||
# v is not an iterable of dicts, this happen when 'key' | ||||
# has been fully expanded already and format is useless. | ||||
# If so, return the expanded value. | ||||
yield i | ||||
|
r8218 | |||
|
r10845 | def _parse(self, tmpl): | ||
'''preparse a template''' | ||||
parsed = [] | ||||
pos, stop = 0, len(tmpl) | ||||
while pos < stop: | ||||
n = tmpl.find('{', pos) | ||||
if n < 0: | ||||
|
r10853 | parsed.append((None, tmpl[pos:stop])) | ||
|
r10845 | break | ||
if n > 0 and tmpl[n - 1] == '\\': | ||||
# escaped | ||||
|
r10855 | parsed.append((None, tmpl[pos:n - 1] + "{")) | ||
|
r10845 | pos = n + 1 | ||
continue | ||||
if n > pos: | ||||
|
r10853 | parsed.append((None, tmpl[pos:n])) | ||
|
r10845 | |||
pos = n | ||||
n = tmpl.find('}', pos) | ||||
if n < 0: | ||||
# no closing | ||||
|
r10853 | parsed.append((None, tmpl[pos:stop])) | ||
|
r10845 | break | ||
expr = tmpl[pos + 1:n] | ||||
pos = n + 1 | ||||
if '%' in expr: | ||||
|
r12402 | # the keyword should be formatted with a template | ||
|
r10852 | key, t = expr.split('%') | ||
|
r10854 | parsed.append((self._format, (key.strip(), | ||
self._load(t.strip())))) | ||||
|
r10845 | elif '|' in expr: | ||
|
r12402 | # process the keyword value with one or more filters | ||
|
r10846 | parts = expr.split('|') | ||
|
r10854 | val = parts[0].strip() | ||
|
r10846 | try: | ||
|
r10854 | filters = [self._filters[f.strip()] for f in parts[1:]] | ||
|
r10846 | except KeyError, i: | ||
raise SyntaxError(_("unknown filter '%s'") % i[0]) | ||||
|
r10852 | parsed.append((self._filter, (filters, val))) | ||
|
r10845 | else: | ||
|
r12402 | # just get the keyword | ||
|
r10854 | parsed.append((self._get, expr.strip())) | ||
|
r10845 | |||
return parsed | ||||
|
r10846 | def _process(self, parsed, mapping): | ||
|
r8218 | '''Render a template. Returns a generator.''' | ||
|
r10846 | for f, e in parsed: | ||
|
r10853 | if f: | ||
yield f(mapping, e) | ||||
else: | ||||
yield e | ||||
|
r8218 | |||
|
r8361 | engines = {'default': engine} | ||
|
r8218 | class templater(object): | ||
|
r7396 | def __init__(self, mapfile, filters={}, defaults={}, cache={}, | ||
minchunk=1024, maxchunk=65536): | ||||
|
r1909 | '''set up template engine. | ||
mapfile is name of file to read map definitions from. | ||||
filters is dict of functions. each transforms a value into another. | ||||
defaults is dict of default map definitions.''' | ||||
|
r1905 | self.mapfile = mapfile or 'template' | ||
|
r1975 | self.cache = cache.copy() | ||
|
r1896 | self.map = {} | ||
|
r1905 | self.base = (mapfile and os.path.dirname(mapfile)) or '' | ||
|
r8360 | self.filters = templatefilters.filters.copy() | ||
self.filters.update(filters) | ||||
|
r1964 | self.defaults = defaults | ||
|
r7396 | self.minchunk, self.maxchunk = minchunk, maxchunk | ||
|
r8361 | self.engines = {} | ||
|
r1896 | |||
|
r1905 | if not mapfile: | ||
return | ||||
|
r6337 | if not os.path.exists(mapfile): | ||
raise util.Abort(_('style not found: %s') % mapfile) | ||||
|
r8194 | conf = config.config() | ||
conf.read(mapfile) | ||||
for key, val in conf[''].items(): | ||||
if val[0] in "'\"": | ||||
try: | ||||
self.cache[key] = parsestring(val) | ||||
except SyntaxError, inst: | ||||
raise SyntaxError('%s: %s' % | ||||
|
r8198 | (conf.source('', key), inst.args[0])) | ||
|
r1896 | else: | ||
|
r8361 | val = 'default', val | ||
if ':' in val[1]: | ||||
val = val[1].split(':', 1) | ||||
self.map[key] = val[0], os.path.join(self.base, val[1]) | ||||
|
r1896 | |||
|
r1899 | def __contains__(self, key): | ||
|
r3637 | return key in self.cache or key in self.map | ||
|
r1899 | |||
|
r8218 | def load(self, t): | ||
|
r6783 | '''Get the template for the given template name. Use a local cache.''' | ||
|
r5915 | if not t in self.cache: | ||
|
r1905 | try: | ||
|
r8361 | self.cache[t] = open(self.map[t][1]).read() | ||
|
r1905 | except IOError, inst: | ||
raise IOError(inst.args[0], _('template file %s: %s') % | ||||
|
r8361 | (self.map[t][1], inst.args[1])) | ||
|
r6783 | return self.cache[t] | ||
|
r1896 | |||
|
r10847 | def __call__(self, t, **mapping): | ||
|
r8361 | ttype = t in self.map and self.map[t][0] or 'default' | ||
proc = self.engines.get(ttype) | ||||
if proc is None: | ||||
proc = engines[ttype](self.load, self.filters, self.defaults) | ||||
self.engines[ttype] = proc | ||||
|
r10847 | stream = proc.process(t, mapping) | ||
|
r7396 | if self.minchunk: | ||
stream = util.increasingchunks(stream, min=self.minchunk, | ||||
max=self.maxchunk) | ||||
return stream | ||||
|
r7434 | |||
|
r1899 | def templatepath(name=None): | ||
|
r1909 | '''return location of template file or directory (if no name). | ||
returns None if not found.''' | ||||
|
r7107 | normpaths = [] | ||
|
r2189 | |||
|
r2001 | # executable version (py2exe) doesn't support __file__ | ||
if hasattr(sys, 'frozen'): | ||||
module = sys.executable | ||||
else: | ||||
module = __file__ | ||||
|
r7107 | for f in path: | ||
if f.startswith('/'): | ||||
p = f | ||||
else: | ||||
fl = f.split('/') | ||||
p = os.path.join(os.path.dirname(module), *fl) | ||||
if name: | ||||
p = os.path.join(p, name) | ||||
if name and os.path.exists(p): | ||||
|
r1897 | return os.path.normpath(p) | ||
|
r7107 | elif os.path.isdir(p): | ||
normpaths.append(os.path.normpath(p)) | ||||
return normpaths | ||||
|
r2189 | |||
|
r9842 | def stylemap(styles, paths=None): | ||
|
r7966 | """Return path to mapfile for a given style. | ||
Searches mapfile in the following locations: | ||||
1. templatepath/style/map | ||||
2. templatepath/map-style | ||||
3. templatepath/map | ||||
""" | ||||
if paths is None: | ||||
paths = templatepath() | ||||
elif isinstance(paths, str): | ||||
|
r8223 | paths = [paths] | ||
|
r7966 | |||
|
r9842 | if isinstance(styles, str): | ||
styles = [styles] | ||||
for style in styles: | ||||
if not style: | ||||
continue | ||||
locations = [os.path.join(style, 'map'), 'map-' + style] | ||||
locations.append('map') | ||||
for path in paths: | ||||
for location in locations: | ||||
mapfile = os.path.join(path, location) | ||||
if os.path.isfile(mapfile): | ||||
return style, mapfile | ||||
|
r7966 | |||
raise RuntimeError("No hgweb templates found in %r" % paths) | ||||