formatter.py
137 lines
| 4.5 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. | ||||
|
r22430 | import cPickle | ||
|
r22428 | from i18n import _ | ||
import encoding, util | ||||
|
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 | ||||
|
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 = {} | ||||
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''' | ||||
for k, v in zip(fields.split(), fielddata): | ||||
self._item[k] = v | ||||
|
r17909 | def condwrite(self, cond, fields, deftext, *fielddata, **opts): | ||
'''do conditional write (primarily for plain formatter)''' | ||||
for k, v in zip(fields.split(), fielddata): | ||||
self._item[k] = v | ||||
|
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) | ||||
|
r22447 | def __nonzero__(self): | ||
|
r16134 | return False | ||
def startitem(self): | ||||
pass | ||||
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) | ||||
self._ui.write(cPickle.dumps(self._data)) | ||||
|
r22474 | def _jsonifyobj(v): | ||
|
r22475 | if isinstance(v, tuple): | ||
return '[' + ', '.join(_jsonifyobj(e) for e in v) + ']' | ||||
|
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") | ||||
|
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 != "": | ||
raise util.Abort(_("custom templates not yet supported")) | ||||
elif ui.configbool('ui', 'formatdebug'): | ||||
return debugformatter(ui, topic, opts) | ||||
elif ui.configbool('ui', 'formatjson'): | ||||
return jsonformatter(ui, topic, opts) | ||||
|
r16134 | return plainformatter(ui, topic, opts) | ||