mercurial-scm/hg-stable: mercurial/formatter.py annotate

annotate mercurial/formatter.py @ 32891:2ecce24dfcd3

templater: add simple interface for unnamed template (API) This provides a simpler API for callers which don't need full templating stack. Instead of storing the given template as the name specified by topic, use '' as the default template to be rendered.

author	Yuya Nishihara <yuya@tcha.org>
date	Sat, 22 Apr 2017 19:56:47 +0900
parents	883adaea9e80
children	c8f2cf18b82e

rev	line source
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	1 # formatter.py - generic output formatting for mercurial
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	2 #
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	3 # Copyright 2012 Matt Mackall <mpm@selenic.com>
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	4 #
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	5 # This software may be used and distributed according to the terms of the
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	6 # GNU General Public License version 2 or any later version.
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	7
30565 783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	8 """Generic output formatting for Mercurial
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	9
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	10 The formatter provides API to show data in various ways. The following
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	11 functions should be used in place of ui.write():
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	12
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	13 - fm.write() for unconditional output
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	14 - fm.condwrite() to show some extra data conditionally in plain output
31182 16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	15 - fm.context() to provide changectx to template output
30565 783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	16 - fm.data() to provide extra data to JSON or template output
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	17 - fm.plain() to show raw text that isn't provided to JSON or template output
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	18
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	19 To show structured data (e.g. date tuples, dicts, lists), apply fm.format*()
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	20 beforehand so the data is converted to the appropriate data type. Use
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	21 fm.isplain() if you need to convert or format data conditionally which isn't
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	22 supported by the formatter API.
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	23
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	24 To build nested structure (i.e. a list of dicts), use fm.nested().
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	25
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	26 See also https://www.mercurial-scm.org/wiki/GenericTemplatingPlan
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	27
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	28 fm.condwrite() vs 'if cond:':
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	29
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	30 In most cases, use fm.condwrite() so users can selectively show the data
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	31 in template output. If it's costly to build data, use plain 'if cond:' with
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	32 fm.write().
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	33
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	34 fm.nested() vs fm.formatdict() (or fm.formatlist()):
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	35
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	36 fm.nested() should be used to form a tree structure (a list of dicts of
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	37 lists of dicts...) which can be accessed through template keywords, e.g.
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	38 "{foo % "{bar % {...}} {baz % {...}}"}". On the other hand, fm.formatdict()
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	39 exports a dict-type object to template, which can be accessed by e.g.
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	40 "{get(foo, key)}" function.
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	41
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	42 Doctest helper:
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	43
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	44 >>> def show(fn, verbose=False, **opts):
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	45 ... import sys
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	46 ... from . import ui as uimod
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	47 ... ui = uimod.ui()
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	48 ... ui.fout = sys.stdout # redirect to doctest
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	49 ... ui.verbose = verbose
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	50 ... return fn(ui, ui.formatter(fn.__name__, opts))
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	51
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	52 Basic example:
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	53
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	54 >>> def files(ui, fm):
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	55 ... files = [('foo', 123, (0, 0)), ('bar', 456, (1, 0))]
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	56 ... for f in files:
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	57 ... fm.startitem()
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	58 ... fm.write('path', '%s', f[0])
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	59 ... fm.condwrite(ui.verbose, 'date', ' %s',
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	60 ... fm.formatdate(f[2], '%Y-%m-%d %H:%M:%S'))
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	61 ... fm.data(size=f[1])
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	62 ... fm.plain('\\n')
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	63 ... fm.end()
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	64 >>> show(files)
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	65 foo
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	66 bar
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	67 >>> show(files, verbose=True)
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	68 foo 1970-01-01 00:00:00
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	69 bar 1970-01-01 00:00:01
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	70 >>> show(files, template='json')
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	71 [
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	72 {
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	73 "date": [0, 0],
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	74 "path": "foo",
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	75 "size": 123
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	76 },
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	77 {
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	78 "date": [1, 0],
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	79 "path": "bar",
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	80 "size": 456
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	81 }
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	82 ]
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	83 >>> show(files, template='path: {path}\\ndate: {date\|rfc3339date}\\n')
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	84 path: foo
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	85 date: 1970-01-01T00:00:00+00:00
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	86 path: bar
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	87 date: 1970-01-01T00:00:01+00:00
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	88
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	89 Nested example:
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	90
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	91 >>> def subrepos(ui, fm):
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	92 ... fm.startitem()
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	93 ... fm.write('repo', '[%s]\\n', 'baz')
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	94 ... files(ui, fm.nested('files'))
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	95 ... fm.end()
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	96 >>> show(subrepos)
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	97 [baz]
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	98 foo
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	99 bar
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	100 >>> show(subrepos, template='{repo}: {join(files % "{path}", ", ")}\\n')
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	101 baz: foo, bar
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	102 """
783016005122 formatter: add overview of API and example as doctest Yuya Nishihara <yuya@tcha.org> parents: 29953 diff changeset	103
25950 175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	104 from __future__ import absolute_import
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	105
32856 615ec3f14aa9 formatter: wrap (tmpl, mapfile) by named tuple Yuya Nishihara <yuya@tcha.org> parents: 32853 diff changeset	106 import collections
32606 35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	107 import contextlib
31807 e6eb86b154c5 templater: provide loop counter as "index" keyword Yuya Nishihara <yuya@tcha.org> parents: 31805 diff changeset	108 import itertools
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	109 import os
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	110
25950 175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	111 from .i18n import _
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	112 from .node import (
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	113 hex,
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	114 short,
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	115 )
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	116
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	117 from . import (
26587 56b2bcea2529 error: get Abort from 'error' instead of 'util' Pierre-Yves David <pierre-yves.david@fb.com> parents: 26373 diff changeset	118 error,
32208 0fd15522a848 py3: use pycompat.byteskwargs to converts kwargs to bytes Pulkit Goyal <7895pulkit@gmail.com> parents: 31925 diff changeset	119 pycompat,
31785 654e9a1c8a6c formatter: use templatefilters.json() Yuya Nishihara <yuya@tcha.org> parents: 31405 diff changeset	120 templatefilters,
29690 c3a9cd78b151 formatter: add function to convert list to appropriate format (issue5217) Yuya Nishihara <yuya@tcha.org> parents: 29324 diff changeset	121 templatekw,
25950 175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	122 templater,
29324 b501579147f1 py3: conditionalize cPickle import by adding in util Pulkit Goyal <7895pulkit@gmail.com> parents: 28957 diff changeset	123 util,
25950 175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	124 )
175873e36d03 formatter: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 25838 diff changeset	125
29324 b501579147f1 py3: conditionalize cPickle import by adding in util Pulkit Goyal <7895pulkit@gmail.com> parents: 28957 diff changeset	126 pickle = util.pickle
b501579147f1 py3: conditionalize cPickle import by adding in util Pulkit Goyal <7895pulkit@gmail.com> parents: 28957 diff changeset	127
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	128 class _nullconverter(object):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	129 '''convert non-primitive data types to be processed by formatter'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	130 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	131 def formatdate(date, fmt):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	132 '''convert date tuple to appropriate format'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	133 return date
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	134 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	135 def formatdict(data, key, value, fmt, sep):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	136 '''convert dict or key-value pairs to appropriate dict format'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	137 # use plain dict instead of util.sortdict so that data can be
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	138 # serialized as a builtin dict in pickle output
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	139 return dict(data)
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	140 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	141 def formatlist(data, name, fmt, sep):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	142 '''convert iterable to appropriate list format'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	143 return list(data)
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	144
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	145 class baseformatter(object):
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	146 def __init__(self, ui, topic, opts, converter):
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	147 self._ui = ui
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	148 self._topic = topic
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	149 self._style = opts.get("style")
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	150 self._template = opts.get("template")
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	151 self._converter = converter
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	152 self._item = None
22701 cb28d2b3db0b formatter: add general way to switch hex/short functions Yuya Nishihara <yuya@tcha.org> parents: 22674 diff changeset	153 # function to convert node to string suitable for this output
cb28d2b3db0b formatter: add general way to switch hex/short functions Yuya Nishihara <yuya@tcha.org> parents: 22674 diff changeset	154 self.hexfunc = hex
29886 307b20e5e505 formatter: add context manager interface for convenience Yuya Nishihara <yuya@tcha.org> parents: 29848 diff changeset	155 def __enter__(self):
307b20e5e505 formatter: add context manager interface for convenience Yuya Nishihara <yuya@tcha.org> parents: 29848 diff changeset	156 return self
307b20e5e505 formatter: add context manager interface for convenience Yuya Nishihara <yuya@tcha.org> parents: 29848 diff changeset	157 def __exit__(self, exctype, excvalue, traceback):
307b20e5e505 formatter: add context manager interface for convenience Yuya Nishihara <yuya@tcha.org> parents: 29848 diff changeset	158 if exctype is None:
307b20e5e505 formatter: add context manager interface for convenience Yuya Nishihara <yuya@tcha.org> parents: 29848 diff changeset	159 self.end()
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	160 def _showitem(self):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	161 '''show a formatted item once all data is collected'''
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	162 pass
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	163 def startitem(self):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	164 '''begin an item in the format list'''
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	165 if self._item is not None:
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	166 self._showitem()
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	167 self._item = {}
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	168 def formatdate(self, date, fmt='%a %b %d %H:%M:%S %Y %1%2'):
29692 2f3f18ad55a2 formatter: add function to convert date tuple to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29690 diff changeset	169 '''convert date tuple to appropriate format'''
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	170 return self._converter.formatdate(date, fmt)
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	171 def formatdict(self, data, key='key', value='value', fmt='%s=%s', sep=' '):
29805 4891f3b93182 formatter: add function to convert dict to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29692 diff changeset	172 '''convert dict or key-value pairs to appropriate dict format'''
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	173 return self._converter.formatdict(data, key, value, fmt, sep)
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	174 def formatlist(self, data, name, fmt='%s', sep=' '):
29690 c3a9cd78b151 formatter: add function to convert list to appropriate format (issue5217) Yuya Nishihara <yuya@tcha.org> parents: 29324 diff changeset	175 '''convert iterable to appropriate list format'''
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	176 # name is mandatory argument for now, but it could be optional if
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	177 # we have default template keyword, e.g. {item}
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	178 return self._converter.formatlist(data, name, fmt, sep)
31182 16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	179 def context(self, **ctxs):
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	180 '''insert context objects to be used to render template keywords'''
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	181 pass
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	182 def data(self, **data):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	183 '''insert data into item that's not shown in default output'''
32208 0fd15522a848 py3: use pycompat.byteskwargs to converts kwargs to bytes Pulkit Goyal <7895pulkit@gmail.com> parents: 31925 diff changeset	184 data = pycompat.byteskwargs(data)
17630 ff5ed1ecd43a formatter: improve implementation of data method David M. Carr <david@carrclan.us> parents: 17597 diff changeset	185 self._item.update(data)
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	186 def write(self, fields, deftext, fielddata, *opts):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	187 '''do default text output while assigning data to item'''
26372 55de800937e0 formatter: verify number of arguments passed to write functions Yuya Nishihara <yuya@tcha.org> parents: 25950 diff changeset	188 fieldkeys = fields.split()
55de800937e0 formatter: verify number of arguments passed to write functions Yuya Nishihara <yuya@tcha.org> parents: 25950 diff changeset	189 assert len(fieldkeys) == len(fielddata)
26373 aa610ffad4e8 formatter: use dict.update() to set arguments passed to write functions Yuya Nishihara <yuya@tcha.org> parents: 26372 diff changeset	190 self._item.update(zip(fieldkeys, fielddata))
17909 3326fd05eb1f formatter: add condwrite method Matt Mackall <mpm@selenic.com> parents: 17630 diff changeset	191 def condwrite(self, cond, fields, deftext, fielddata, *opts):
3326fd05eb1f formatter: add condwrite method Matt Mackall <mpm@selenic.com> parents: 17630 diff changeset	192 '''do conditional write (primarily for plain formatter)'''
26372 55de800937e0 formatter: verify number of arguments passed to write functions Yuya Nishihara <yuya@tcha.org> parents: 25950 diff changeset	193 fieldkeys = fields.split()
55de800937e0 formatter: verify number of arguments passed to write functions Yuya Nishihara <yuya@tcha.org> parents: 25950 diff changeset	194 assert len(fieldkeys) == len(fielddata)
26373 aa610ffad4e8 formatter: use dict.update() to set arguments passed to write functions Yuya Nishihara <yuya@tcha.org> parents: 26372 diff changeset	195 self._item.update(zip(fieldkeys, fielddata))
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	196 def plain(self, text, **opts):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	197 '''show raw text for non-templated mode'''
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	198 pass
29953 e7cacb45c4be formatter: introduce isplain() to replace (the inverse of) __nonzero__() (API) Mathias De Mar? <mathias.demare@gmail.com> parents: 29886 diff changeset	199 def isplain(self):
e7cacb45c4be formatter: introduce isplain() to replace (the inverse of) __nonzero__() (API) Mathias De Mar? <mathias.demare@gmail.com> parents: 29886 diff changeset	200 '''check for plain formatter usage'''
e7cacb45c4be formatter: introduce isplain() to replace (the inverse of) __nonzero__() (API) Mathias De Mar? <mathias.demare@gmail.com> parents: 29886 diff changeset	201 return False
29848 5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	202 def nested(self, field):
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	203 '''sub formatter to store nested data in the specified field'''
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	204 self._item[field] = data = []
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	205 return _nestedformatter(self._ui, self._converter, data)
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	206 def end(self):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	207 '''end output for the formatter'''
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	208 if self._item is not None:
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	209 self._showitem()
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	210
32607 e9bf3e132ea9 formatter: add nullformatter Yuya Nishihara <yuya@tcha.org> parents: 32606 diff changeset	211 def nullformatter(ui, topic):
e9bf3e132ea9 formatter: add nullformatter Yuya Nishihara <yuya@tcha.org> parents: 32606 diff changeset	212 '''formatter that prints nothing'''
e9bf3e132ea9 formatter: add nullformatter Yuya Nishihara <yuya@tcha.org> parents: 32606 diff changeset	213 return baseformatter(ui, topic, opts={}, converter=_nullconverter)
e9bf3e132ea9 formatter: add nullformatter Yuya Nishihara <yuya@tcha.org> parents: 32606 diff changeset	214
29848 5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	215 class _nestedformatter(baseformatter):
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	216 '''build sub items and store them in the parent formatter'''
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	217 def __init__(self, ui, converter, data):
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	218 baseformatter.__init__(self, ui, topic='', opts={}, converter=converter)
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	219 self._data = data
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	220 def _showitem(self):
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	221 self._data.append(self._item)
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	222
29805 4891f3b93182 formatter: add function to convert dict to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29692 diff changeset	223 def _iteritems(data):
4891f3b93182 formatter: add function to convert dict to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29692 diff changeset	224 '''iterate key-value pairs in stable order'''
4891f3b93182 formatter: add function to convert dict to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29692 diff changeset	225 if isinstance(data, dict):
4891f3b93182 formatter: add function to convert dict to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29692 diff changeset	226 return sorted(data.iteritems())
4891f3b93182 formatter: add function to convert dict to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29692 diff changeset	227 return data
4891f3b93182 formatter: add function to convert dict to appropriate format Yuya Nishihara <yuya@tcha.org> parents: 29692 diff changeset	228
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	229 class _plainconverter(object):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	230 '''convert non-primitive data types to text'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	231 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	232 def formatdate(date, fmt):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	233 '''stringify date tuple in the given format'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	234 return util.datestr(date, fmt)
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	235 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	236 def formatdict(data, key, value, fmt, sep):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	237 '''stringify key-value pairs separated by sep'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	238 return sep.join(fmt % (k, v) for k, v in _iteritems(data))
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	239 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	240 def formatlist(data, name, fmt, sep):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	241 '''stringify iterable separated by sep'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	242 return sep.join(fmt % e for e in data)
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	243
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	244 class plainformatter(baseformatter):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	245 '''the default text output scheme'''
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	246 def __init__(self, ui, out, topic, opts):
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	247 baseformatter.__init__(self, ui, topic, opts, _plainconverter)
22701 cb28d2b3db0b formatter: add general way to switch hex/short functions Yuya Nishihara <yuya@tcha.org> parents: 22674 diff changeset	248 if ui.debugflag:
cb28d2b3db0b formatter: add general way to switch hex/short functions Yuya Nishihara <yuya@tcha.org> parents: 22674 diff changeset	249 self.hexfunc = hex
cb28d2b3db0b formatter: add general way to switch hex/short functions Yuya Nishihara <yuya@tcha.org> parents: 22674 diff changeset	250 else:
cb28d2b3db0b formatter: add general way to switch hex/short functions Yuya Nishihara <yuya@tcha.org> parents: 22674 diff changeset	251 self.hexfunc = short
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	252 if ui is out:
012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	253 self._write = ui.write
012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	254 else:
012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	255 self._write = lambda s, **opts: out.write(s)
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	256 def startitem(self):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	257 pass
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	258 def data(self, **data):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	259 pass
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	260 def write(self, fields, deftext, fielddata, *opts):
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	261 self._write(deftext % fielddata, **opts)
17909 3326fd05eb1f formatter: add condwrite method Matt Mackall <mpm@selenic.com> parents: 17630 diff changeset	262 def condwrite(self, cond, fields, deftext, fielddata, *opts):
3326fd05eb1f formatter: add condwrite method Matt Mackall <mpm@selenic.com> parents: 17630 diff changeset	263 '''do conditional write'''
3326fd05eb1f formatter: add condwrite method Matt Mackall <mpm@selenic.com> parents: 17630 diff changeset	264 if cond:
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	265 self._write(deftext % fielddata, **opts)
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	266 def plain(self, text, **opts):
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	267 self._write(text, **opts)
29953 e7cacb45c4be formatter: introduce isplain() to replace (the inverse of) __nonzero__() (API) Mathias De Mar? <mathias.demare@gmail.com> parents: 29886 diff changeset	268 def isplain(self):
e7cacb45c4be formatter: introduce isplain() to replace (the inverse of) __nonzero__() (API) Mathias De Mar? <mathias.demare@gmail.com> parents: 29886 diff changeset	269 return True
29848 5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	270 def nested(self, field):
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	271 # nested data will be directly written to ui
5b886289a1ca formatter: add fm.nested(field) to either write or build sub items Yuya Nishihara <yuya@tcha.org> parents: 29847 diff changeset	272 return self
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	273 def end(self):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	274 pass
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	275
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	276 class debugformatter(baseformatter):
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	277 def __init__(self, ui, out, topic, opts):
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	278 baseformatter.__init__(self, ui, topic, opts, _nullconverter)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	279 self._out = out
5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	280 self._out.write("%s = [\n" % self._topic)
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	281 def _showitem(self):
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	282 self._out.write(" " + repr(self._item) + ",\n")
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	283 def end(self):
3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	284 baseformatter.end(self)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	285 self._out.write("]\n")
16134 3c0327ea20c0 formatter: add basic formatters Matt Mackall <mpm@selenic.com> parents: diff changeset	286
22430 968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	287 class pickleformatter(baseformatter):
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	288 def __init__(self, ui, out, topic, opts):
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	289 baseformatter.__init__(self, ui, topic, opts, _nullconverter)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	290 self._out = out
22430 968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	291 self._data = []
968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	292 def _showitem(self):
968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	293 self._data.append(self._item)
968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	294 def end(self):
968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	295 baseformatter.end(self)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	296 self._out.write(pickle.dumps(self._data))
22430 968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	297
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	298 class jsonformatter(baseformatter):
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	299 def __init__(self, ui, out, topic, opts):
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	300 baseformatter.__init__(self, ui, topic, opts, _nullconverter)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	301 self._out = out
5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	302 self._out.write("[")
31307 59d09565ac77 formatter: set _first on formatter, not ui Martin von Zweigbergk <martinvonz@google.com> parents: 31192 diff changeset	303 self._first = True
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	304 def _showitem(self):
31307 59d09565ac77 formatter: set _first on formatter, not ui Martin von Zweigbergk <martinvonz@google.com> parents: 31192 diff changeset	305 if self._first:
59d09565ac77 formatter: set _first on formatter, not ui Martin von Zweigbergk <martinvonz@google.com> parents: 31192 diff changeset	306 self._first = False
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	307 else:
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	308 self._out.write(",")
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	309
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	310 self._out.write("\n {\n")
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	311 first = True
427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	312 for k, v in sorted(self._item.items()):
427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	313 if first:
427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	314 first = False
427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	315 else:
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	316 self._out.write(",\n")
31785 654e9a1c8a6c formatter: use templatefilters.json() Yuya Nishihara <yuya@tcha.org> parents: 31405 diff changeset	317 u = templatefilters.json(v, paranoid=False)
654e9a1c8a6c formatter: use templatefilters.json() Yuya Nishihara <yuya@tcha.org> parents: 31405 diff changeset	318 self._out.write(' "%s": %s' % (k, u))
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	319 self._out.write("\n }")
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	320 def end(self):
427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	321 baseformatter.end(self)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	322 self._out.write("\n]\n")
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	323
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	324 class _templateconverter(object):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	325 '''convert non-primitive data types to be processed by templater'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	326 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	327 def formatdate(date, fmt):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	328 '''return date tuple'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	329 return date
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	330 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	331 def formatdict(data, key, value, fmt, sep):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	332 '''build object that can be evaluated as either plain string or dict'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	333 data = util.sortdict(_iteritems(data))
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	334 def f():
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	335 yield _plainconverter.formatdict(data, key, value, fmt, sep)
31925 5b2241e84982 templatekw: add public function to wrap a dict by _hybrid object Yuya Nishihara <yuya@tcha.org> parents: 31924 diff changeset	336 return templatekw.hybriddict(data, key=key, value=value, fmt=fmt,
5b2241e84982 templatekw: add public function to wrap a dict by _hybrid object Yuya Nishihara <yuya@tcha.org> parents: 31924 diff changeset	337 gen=f())
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	338 @staticmethod
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	339 def formatlist(data, name, fmt, sep):
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	340 '''build object that can be evaluated as either plain string or list'''
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	341 data = list(data)
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	342 def f():
18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	343 yield _plainconverter.formatlist(data, name, fmt, sep)
31924 21f129354dd0 templatekw: add public function to wrap a list by _hybrid object Yuya Nishihara <yuya@tcha.org> parents: 31807 diff changeset	344 return templatekw.hybridlist(data, name=name, fmt=fmt, gen=f())
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	345
25513 0c6f98398f8a formatter: add template support Matt Mackall <mpm@selenic.com> parents: 25512 diff changeset	346 class templateformatter(baseformatter):
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	347 def __init__(self, ui, out, topic, opts):
29847 18bac830eef3 formatter: factor out format() functions to separate classes Yuya Nishihara <yuya@tcha.org>* parents: 29805 diff changeset	348 baseformatter.__init__(self, ui, topic, opts, _templateconverter)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	349 self._out = out
32851 99df35499cae formatter: inline gettemplater() Yuya Nishihara <yuya@tcha.org> parents: 32850 diff changeset	350 spec = lookuptemplate(ui, topic, opts.get('template', ''))
32859 883adaea9e80 formatter: render template specified by templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32858 diff changeset	351 self._tref = spec.ref
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	352 self._t = loadtemplater(ui, spec, cache=templatekw.defaulttempl)
31807 e6eb86b154c5 templater: provide loop counter as "index" keyword Yuya Nishihara <yuya@tcha.org> parents: 31805 diff changeset	353 self._counter = itertools.count()
31182 16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	354 self._cache = {} # for templatekw/funcs to store reusable data
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	355 def context(self, **ctxs):
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	356 '''insert context objects to be used to render template keywords'''
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	357 assert all(k == 'ctx' for k in ctxs)
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	358 self._item.update(ctxs)
25513 0c6f98398f8a formatter: add template support Matt Mackall <mpm@selenic.com> parents: 25512 diff changeset	359 def _showitem(self):
31182 16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	360 # TODO: add support for filectx. probably each template keyword or
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	361 # function will have to declare dependent resources. e.g.
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	362 # @templatekeyword(..., requires=('ctx',))
31805 dca9b6922514 formatter: reorder code that builds template mapping Yuya Nishihara <yuya@tcha.org> parents: 31785 diff changeset	363 props = {}
31182 16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	364 if 'ctx' in self._item:
31805 dca9b6922514 formatter: reorder code that builds template mapping Yuya Nishihara <yuya@tcha.org> parents: 31785 diff changeset	365 props.update(templatekw.keywords)
31807 e6eb86b154c5 templater: provide loop counter as "index" keyword Yuya Nishihara <yuya@tcha.org> parents: 31805 diff changeset	366 props['index'] = next(self._counter)
31805 dca9b6922514 formatter: reorder code that builds template mapping Yuya Nishihara <yuya@tcha.org> parents: 31785 diff changeset	367 # explicitly-defined fields precede templatekw
dca9b6922514 formatter: reorder code that builds template mapping Yuya Nishihara <yuya@tcha.org> parents: 31785 diff changeset	368 props.update(self._item)
dca9b6922514 formatter: reorder code that builds template mapping Yuya Nishihara <yuya@tcha.org> parents: 31785 diff changeset	369 if 'ctx' in self._item:
31182 16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	370 # but template resources must be always available
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	371 props['templ'] = self._t
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	372 props['repo'] = props['ctx'].repo()
16272d8c24f6 formatter: add support for changeset templating Yuya Nishihara <yuya@tcha.org> parents: 31180 diff changeset	373 props['revcache'] = {}
32859 883adaea9e80 formatter: render template specified by templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32858 diff changeset	374 g = self._t(self._tref, ui=self._ui, cache=self._cache, **props)
31192 5660c45ecba6 formatter: add argument to change output file of non-plain formatter Yuya Nishihara <yuya@tcha.org> parents: 31182 diff changeset	375 self._out.write(templater.stringify(g))
25513 0c6f98398f8a formatter: add template support Matt Mackall <mpm@selenic.com> parents: 25512 diff changeset	376
32856 615ec3f14aa9 formatter: wrap (tmpl, mapfile) by named tuple Yuya Nishihara <yuya@tcha.org> parents: 32853 diff changeset	377 templatespec = collections.namedtuple(r'templatespec',
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	378 r'ref tmpl mapfile')
32856 615ec3f14aa9 formatter: wrap (tmpl, mapfile) by named tuple Yuya Nishihara <yuya@tcha.org> parents: 32853 diff changeset	379
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	380 def lookuptemplate(ui, topic, tmpl):
32853 9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	381 """Find the template matching the given -T/--template spec 'tmpl'
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	382
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	383 'tmpl' can be any of the following:
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	384
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	385 - a literal template (e.g. '{rev}')
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	386 - a map-file name or path (e.g. 'changelog')
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	387 - a reference to [templates] in config file
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	388 - a path to raw template file
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	389
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	390 A map file defines a stand-alone template environment. If a map file
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	391 selected, all templates defined in the file will be loaded, and the
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	392 template matching the given topic will be rendered. No aliases will be
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	393 loaded from user config.
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	394 """
9d76812f9b0b formatter: document lookuptemplate() Yuya Nishihara <yuya@tcha.org> parents: 32851 diff changeset	395
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	396 # looks like a literal template?
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	397 if '{' in tmpl:
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	398 return templatespec(topic, tmpl, None)
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	399
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	400 # perhaps a stock style?
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	401 if not os.path.split(tmpl)[0]:
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	402 mapname = (templater.templatepath('map-cmdline.' + tmpl)
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	403 or templater.templatepath(tmpl))
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	404 if mapname and os.path.isfile(mapname):
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	405 return templatespec(topic, None, mapname)
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	406
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	407 # perhaps it's a reference to [templates]
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	408 t = ui.config('templates', tmpl)
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	409 if t:
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	410 return templatespec(topic, templater.unquotestring(t), None)
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	411
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	412 if tmpl == 'list':
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	413 ui.write(_("available styles: %s\n") % templater.stylelist())
26587 56b2bcea2529 error: get Abort from 'error' instead of 'util' Pierre-Yves David <pierre-yves.david@fb.com> parents: 26373 diff changeset	414 raise error.Abort(_("specify a template"))
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	415
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	416 # perhaps it's a path to a map or a template
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	417 if ('/' in tmpl or '\\' in tmpl) and os.path.isfile(tmpl):
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	418 # is it a mapfile for a style?
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	419 if os.path.basename(tmpl).startswith("map-"):
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	420 return templatespec(topic, None, os.path.realpath(tmpl))
32848 470820c2418d formatter: open raw template file in posix semantics Yuya Nishihara <yuya@tcha.org> parents: 32847 diff changeset	421 with util.posixfile(tmpl, 'rb') as f:
32846 526f9f12f707 formatter: close raw template file explicitly Yuya Nishihara <yuya@tcha.org> parents: 32607 diff changeset	422 tmpl = f.read()
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	423 return templatespec(topic, tmpl, None)
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	424
c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	425 # constant string?
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	426 return templatespec(topic, tmpl, None)
25511 c2a4dfe2a336 formatter: move most of template option helper to formatter Matt Mackall <mpm@selenic.com> parents: 24321 diff changeset	427
32858 57c13c0d1cde formatter: put topic in templatespec tuple Yuya Nishihara <yuya@tcha.org> parents: 32856 diff changeset	428 def loadtemplater(ui, spec, cache=None):
32850 11e667a8fcba formatter: factor out function to create templater from literal or map file Yuya Nishihara <yuya@tcha.org> parents: 32848 diff changeset	429 """Create a templater from either a literal template or loading from
11e667a8fcba formatter: factor out function to create templater from literal or map file Yuya Nishihara <yuya@tcha.org> parents: 32848 diff changeset	430 a map file"""
32856 615ec3f14aa9 formatter: wrap (tmpl, mapfile) by named tuple Yuya Nishihara <yuya@tcha.org> parents: 32853 diff changeset	431 assert not (spec.tmpl and spec.mapfile)
615ec3f14aa9 formatter: wrap (tmpl, mapfile) by named tuple Yuya Nishihara <yuya@tcha.org> parents: 32853 diff changeset	432 if spec.mapfile:
615ec3f14aa9 formatter: wrap (tmpl, mapfile) by named tuple Yuya Nishihara <yuya@tcha.org> parents: 32853 diff changeset	433 return templater.templater.frommapfile(spec.mapfile, cache=cache)
32891 2ecce24dfcd3 templater: add simple interface for unnamed template (API) Yuya Nishihara <yuya@tcha.org> parents: 32859 diff changeset	434 return _maketemplater(ui, spec.ref, spec.tmpl, cache=cache)
28955 78759f78a44e templater: factor out function that creates templater from string template Yuya Nishihara <yuya@tcha.org> parents: 28954 diff changeset	435
32891 2ecce24dfcd3 templater: add simple interface for unnamed template (API) Yuya Nishihara <yuya@tcha.org> parents: 32859 diff changeset	436 def maketemplater(ui, tmpl, cache=None):
28955 78759f78a44e templater: factor out function that creates templater from string template Yuya Nishihara <yuya@tcha.org> parents: 28954 diff changeset	437 """Create a templater from a string template 'tmpl'"""
32891 2ecce24dfcd3 templater: add simple interface for unnamed template (API) Yuya Nishihara <yuya@tcha.org> parents: 32859 diff changeset	438 return _maketemplater(ui, '', tmpl, cache=cache)
2ecce24dfcd3 templater: add simple interface for unnamed template (API) Yuya Nishihara <yuya@tcha.org> parents: 32859 diff changeset	439
2ecce24dfcd3 templater: add simple interface for unnamed template (API) Yuya Nishihara <yuya@tcha.org> parents: 32859 diff changeset	440 def _maketemplater(ui, topic, tmpl, cache=None):
28957 d813132ea361 templater: load and expand aliases by template engine (API) (issue4842) Yuya Nishihara <yuya@tcha.org> parents: 28955 diff changeset	441 aliases = ui.configitems('templatealias')
31180 e64b70c96338 formatter: drop filters argument from maketemplater() Yuya Nishihara <yuya@tcha.org> parents: 30565 diff changeset	442 t = templater.templater(cache=cache, aliases=aliases)
25512 8463433c2689 formatter: add a method to build a full templater from a -T option Matt Mackall <mpm@selenic.com> parents: 25511 diff changeset	443 if tmpl:
8463433c2689 formatter: add a method to build a full templater from a -T option Matt Mackall <mpm@selenic.com> parents: 25511 diff changeset	444 t.cache[topic] = tmpl
8463433c2689 formatter: add a method to build a full templater from a -T option Matt Mackall <mpm@selenic.com> parents: 25511 diff changeset	445 return t
8463433c2689 formatter: add a method to build a full templater from a -T option Matt Mackall <mpm@selenic.com> parents: 25511 diff changeset	446
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	447 def formatter(ui, out, topic, opts):
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	448 template = opts.get("template", "")
427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	449 if template == "json":
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	450 return jsonformatter(ui, out, topic, opts)
22430 968247e8f4ac formatter: add pickle format Matt Mackall <mpm@selenic.com> parents: 22428 diff changeset	451 elif template == "pickle":
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	452 return pickleformatter(ui, out, topic, opts)
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	453 elif template == "debug":
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	454 return debugformatter(ui, out, topic, opts)
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	455 elif template != "":
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	456 return templateformatter(ui, out, topic, opts)
25838 31137258ae8b formatter: mark developer options Matt Mackall <mpm@selenic.com> parents: 25513 diff changeset	457 # developer config: ui.formatdebug
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	458 elif ui.configbool('ui', 'formatdebug'):
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	459 return debugformatter(ui, out, topic, opts)
25838 31137258ae8b formatter: mark developer options Matt Mackall <mpm@selenic.com> parents: 25513 diff changeset	460 # deprecated config: ui.formatjson
22428 427e80a18ef8 formatter: add json formatter Matt Mackall <mpm@selenic.com> parents: 22424 diff changeset	461 elif ui.configbool('ui', 'formatjson'):
32605 012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	462 return jsonformatter(ui, out, topic, opts)
012e0da5b759 formatter: add option to redirect output to file object Yuya Nishihara <yuya@tcha.org> parents: 32208 diff changeset	463 return plainformatter(ui, out, topic, opts)
32606 35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	464
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	465 @contextlib.contextmanager
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	466 def openformatter(ui, filename, topic, opts):
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	467 """Create a formatter that writes outputs to the specified file
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	468
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	469 Must be invoked using the 'with' statement.
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	470 """
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	471 with util.posixfile(filename, 'wb') as out:
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	472 with formatter(ui, out, topic, opts) as fm:
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	473 yield fm
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	474
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	475 @contextlib.contextmanager
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	476 def _neverending(fm):
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	477 yield fm
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	478
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	479 def maybereopen(fm, filename, opts):
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	480 """Create a formatter backed by file if filename specified, else return
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	481 the given formatter
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	482
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	483 Must be invoked using the 'with' statement. This will never call fm.end()
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	484 of the given formatter.
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	485 """
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	486 if filename:
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	487 return openformatter(fm._ui, filename, fm._topic, opts)
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	488 else:
35985d407d49 formatter: add helper to create a formatter optionally backed by file Yuya Nishihara <yuya@tcha.org> parents: 32605 diff changeset	489 return _neverending(fm)

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/formatter.py @ 32891:2ecce24dfcd3