formatter.py
251 lines
| 8.2 KiB
| text/x-python
|
PythonLexer
/ mercurial / formatter.py
|
r16134 | # formatter.py - generic output formatting for mercurial | ||
# | ||||
# Copyright 2012 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
|
r25950 | from __future__ import absolute_import | ||
|
r25511 | import os | ||
|
r22428 | |||
|
r25950 | from .i18n import _ | ||
from .node import ( | ||||
hex, | ||||
short, | ||||
) | ||||
from . import ( | ||||
encoding, | ||||
|
r26587 | error, | ||
|
r29676 | templatekw, | ||
|
r25950 | templater, | ||
|
r29324 | util, | ||
|
r25950 | ) | ||
|
r29324 | pickle = util.pickle | ||
|
r16134 | class baseformatter(object): | ||
def __init__(self, ui, topic, opts): | ||||
self._ui = ui | ||||
self._topic = topic | ||||
self._style = opts.get("style") | ||||
self._template = opts.get("template") | ||||
self._item = None | ||||
|
r22701 | # function to convert node to string suitable for this output | ||
self.hexfunc = hex | ||||
|
r22447 | def __nonzero__(self): | ||
|
r16134 | '''return False if we're not doing real templating so we can | ||
skip extra work''' | ||||
return True | ||||
def _showitem(self): | ||||
'''show a formatted item once all data is collected''' | ||||
pass | ||||
def startitem(self): | ||||
'''begin an item in the format list''' | ||||
if self._item is not None: | ||||
self._showitem() | ||||
self._item = {} | ||||
|
r29676 | @staticmethod | ||
|
r29678 | def formatdate(date, fmt='%a %b %d %H:%M:%S %Y %1%2'): | ||
'''convert date tuple to appropriate format''' | ||||
return date | ||||
@staticmethod | ||||
|
r29676 | def formatlist(data, name, fmt='%s', sep=' '): | ||
'''convert iterable to appropriate list format''' | ||||
return list(data) | ||||
|
r16134 | def data(self, **data): | ||
'''insert data into item that's not shown in default output''' | ||||
|
r17630 | self._item.update(data) | ||
|
r16134 | def write(self, fields, deftext, *fielddata, **opts): | ||
'''do default text output while assigning data to item''' | ||||
|
r26372 | fieldkeys = fields.split() | ||
assert len(fieldkeys) == len(fielddata) | ||||
|
r26373 | self._item.update(zip(fieldkeys, fielddata)) | ||
|
r17909 | def condwrite(self, cond, fields, deftext, *fielddata, **opts): | ||
'''do conditional write (primarily for plain formatter)''' | ||||
|
r26372 | fieldkeys = fields.split() | ||
assert len(fieldkeys) == len(fielddata) | ||||
|
r26373 | self._item.update(zip(fieldkeys, fielddata)) | ||
|
r16134 | def plain(self, text, **opts): | ||
'''show raw text for non-templated mode''' | ||||
pass | ||||
def end(self): | ||||
'''end output for the formatter''' | ||||
if self._item is not None: | ||||
self._showitem() | ||||
class plainformatter(baseformatter): | ||||
'''the default text output scheme''' | ||||
def __init__(self, ui, topic, opts): | ||||
baseformatter.__init__(self, ui, topic, opts) | ||||
|
r22701 | if ui.debugflag: | ||
self.hexfunc = hex | ||||
else: | ||||
self.hexfunc = short | ||||
|
r22447 | def __nonzero__(self): | ||
|
r16134 | return False | ||
def startitem(self): | ||||
pass | ||||
|
r29676 | @staticmethod | ||
|
r29678 | def formatdate(date, fmt='%a %b %d %H:%M:%S %Y %1%2'): | ||
'''stringify date tuple in the given format''' | ||||
return util.datestr(date, fmt) | ||||
@staticmethod | ||||
|
r29676 | def formatlist(data, name, fmt='%s', sep=' '): | ||
'''stringify iterable separated by sep''' | ||||
return sep.join(fmt % e for e in data) | ||||
|
r16134 | def data(self, **data): | ||
pass | ||||
def write(self, fields, deftext, *fielddata, **opts): | ||||
self._ui.write(deftext % fielddata, **opts) | ||||
|
r17909 | def condwrite(self, cond, fields, deftext, *fielddata, **opts): | ||
'''do conditional write''' | ||||
if cond: | ||||
self._ui.write(deftext % fielddata, **opts) | ||||
|
r16134 | def plain(self, text, **opts): | ||
self._ui.write(text, **opts) | ||||
def end(self): | ||||
pass | ||||
class debugformatter(baseformatter): | ||||
def __init__(self, ui, topic, opts): | ||||
baseformatter.__init__(self, ui, topic, opts) | ||||
|
r22424 | self._ui.write("%s = [\n" % self._topic) | ||
|
r16134 | def _showitem(self): | ||
self._ui.write(" " + repr(self._item) + ",\n") | ||||
def end(self): | ||||
baseformatter.end(self) | ||||
|
r22424 | self._ui.write("]\n") | ||
|
r16134 | |||
|
r22430 | class pickleformatter(baseformatter): | ||
def __init__(self, ui, topic, opts): | ||||
baseformatter.__init__(self, ui, topic, opts) | ||||
self._data = [] | ||||
def _showitem(self): | ||||
self._data.append(self._item) | ||||
def end(self): | ||||
baseformatter.end(self) | ||||
|
r29324 | self._ui.write(pickle.dumps(self._data)) | ||
|
r22430 | |||
|
r22474 | def _jsonifyobj(v): | ||
|
r29676 | if isinstance(v, (list, tuple)): | ||
|
r22475 | return '[' + ', '.join(_jsonifyobj(e) for e in v) + ']' | ||
|
r24321 | elif v is None: | ||
return 'null' | ||||
|
r22674 | elif v is True: | ||
return 'true' | ||||
elif v is False: | ||||
return 'false' | ||||
|
r22476 | elif isinstance(v, (int, float)): | ||
return str(v) | ||||
|
r22474 | else: | ||
return '"%s"' % encoding.jsonescape(v) | ||||
|
r22428 | class jsonformatter(baseformatter): | ||
def __init__(self, ui, topic, opts): | ||||
baseformatter.__init__(self, ui, topic, opts) | ||||
self._ui.write("[") | ||||
self._ui._first = True | ||||
def _showitem(self): | ||||
if self._ui._first: | ||||
self._ui._first = False | ||||
else: | ||||
self._ui.write(",") | ||||
self._ui.write("\n {\n") | ||||
first = True | ||||
for k, v in sorted(self._item.items()): | ||||
if first: | ||||
first = False | ||||
else: | ||||
self._ui.write(",\n") | ||||
|
r22474 | self._ui.write(' "%s": %s' % (k, _jsonifyobj(v))) | ||
|
r22428 | self._ui.write("\n }") | ||
def end(self): | ||||
baseformatter.end(self) | ||||
self._ui.write("\n]\n") | ||||
|
r25513 | class templateformatter(baseformatter): | ||
def __init__(self, ui, topic, opts): | ||||
baseformatter.__init__(self, ui, topic, opts) | ||||
self._topic = topic | ||||
self._t = gettemplater(ui, topic, opts.get('template', '')) | ||||
def _showitem(self): | ||||
|
r28384 | g = self._t(self._topic, ui=self._ui, **self._item) | ||
|
r25513 | self._ui.write(templater.stringify(g)) | ||
|
r29676 | @staticmethod | ||
def formatlist(data, name, fmt='%s', sep=' '): | ||||
'''build object that can be evaluated as either plain string or list''' | ||||
# name is mandatory argument for now, but it could be optional if | ||||
# we have default template keyword, e.g. {item} | ||||
data = list(data) | ||||
def f(): | ||||
yield plainformatter.formatlist(data, name, fmt, sep) | ||||
return templatekw._hybrid(f(), data, lambda x: {name: x}, | ||||
lambda d: fmt % d[name]) | ||||
|
r25513 | |||
|
r25511 | def lookuptemplate(ui, topic, tmpl): | ||
# looks like a literal template? | ||||
if '{' in tmpl: | ||||
return tmpl, None | ||||
# perhaps a stock style? | ||||
if not os.path.split(tmpl)[0]: | ||||
mapname = (templater.templatepath('map-cmdline.' + tmpl) | ||||
or templater.templatepath(tmpl)) | ||||
if mapname and os.path.isfile(mapname): | ||||
return None, mapname | ||||
# perhaps it's a reference to [templates] | ||||
t = ui.config('templates', tmpl) | ||||
if t: | ||||
|
r28630 | return templater.unquotestring(t), None | ||
|
r25511 | |||
if tmpl == 'list': | ||||
ui.write(_("available styles: %s\n") % templater.stylelist()) | ||||
|
r26587 | raise error.Abort(_("specify a template")) | ||
|
r25511 | |||
# perhaps it's a path to a map or a template | ||||
if ('/' in tmpl or '\\' in tmpl) and os.path.isfile(tmpl): | ||||
# is it a mapfile for a style? | ||||
if os.path.basename(tmpl).startswith("map-"): | ||||
return None, os.path.realpath(tmpl) | ||||
tmpl = open(tmpl).read() | ||||
return tmpl, None | ||||
# constant string? | ||||
return tmpl, None | ||||
|
r25512 | def gettemplater(ui, topic, spec): | ||
tmpl, mapfile = lookuptemplate(ui, topic, spec) | ||||
|
r28954 | assert not (tmpl and mapfile) | ||
if mapfile: | ||||
return templater.templater.frommapfile(mapfile) | ||||
|
r28955 | return maketemplater(ui, topic, tmpl) | ||
def maketemplater(ui, topic, tmpl, filters=None, cache=None): | ||||
"""Create a templater from a string template 'tmpl'""" | ||||
|
r28957 | aliases = ui.configitems('templatealias') | ||
t = templater.templater(filters=filters, cache=cache, aliases=aliases) | ||||
|
r25512 | if tmpl: | ||
t.cache[topic] = tmpl | ||||
return t | ||||
|
r16134 | def formatter(ui, topic, opts): | ||
|
r22428 | template = opts.get("template", "") | ||
if template == "json": | ||||
return jsonformatter(ui, topic, opts) | ||||
|
r22430 | elif template == "pickle": | ||
return pickleformatter(ui, topic, opts) | ||||
|
r22428 | elif template == "debug": | ||
|
r16134 | return debugformatter(ui, topic, opts) | ||
|
r22428 | elif template != "": | ||
|
r25513 | return templateformatter(ui, topic, opts) | ||
|
r25838 | # developer config: ui.formatdebug | ||
|
r22428 | elif ui.configbool('ui', 'formatdebug'): | ||
return debugformatter(ui, topic, opts) | ||||
|
r25838 | # deprecated config: ui.formatjson | ||
|
r22428 | elif ui.configbool('ui', 'formatjson'): | ||
return jsonformatter(ui, topic, opts) | ||||
|
r16134 | return plainformatter(ui, topic, opts) | ||