# 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.

"""Generic output formatting for Mercurial

The formatter provides API to show data in various ways. The following

functions should be used in place of ui.write():

- fm.write() for unconditional output

- fm.condwrite() to show some extra data conditionally in plain output

- fm.context() to provide changectx to template output

- fm.data() to provide extra data to JSON or template output

- fm.plain() to show raw text that isn't provided to JSON or template output

To show structured data (e.g. date tuples, dicts, lists), apply fm.format*()

beforehand so the data is converted to the appropriate data type. Use

fm.isplain() if you need to convert or format data conditionally which isn't

supported by the formatter API.

To build nested structure (i.e. a list of dicts), use fm.nested().

See also https://www.mercurial-scm.org/wiki/GenericTemplatingPlan

fm.condwrite() vs 'if cond:':

In most cases, use fm.condwrite() so users can selectively show the data

in template output. If it's costly to build data, use plain 'if cond:' with

fm.write().

fm.nested() vs fm.formatdict() (or fm.formatlist()):

fm.nested() should be used to form a tree structure (a list of dicts of

lists of dicts...) which can be accessed through template keywords, e.g.

"{foo % "{bar % {...}} {baz % {...}}"}". On the other hand, fm.formatdict()

exports a dict-type object to template, which can be accessed by e.g.

"{get(foo, key)}" function.

Doctest helper:

>>> def show(fn, verbose=False, **opts):

...     import sys

...     from . import ui as uimod

...     ui = uimod.ui()

...     ui.verbose = verbose

...     ui.pushbuffer()

...     try:

...         return fn(ui, ui.formatter(pycompat.sysbytes(fn.__name__),

...                   pycompat.byteskwargs(opts)))

...     finally:

...         print(pycompat.sysstr(ui.popbuffer()), end='')

Basic example:

>>> def files(ui, fm):

...     files = [(b'foo', 123, (0, 0)), (b'bar', 456, (1, 0))]

...     for f in files:

...         fm.startitem()

...         fm.write(b'path', b'%s', f[0])

...         fm.condwrite(ui.verbose, b'date', b'  %s',

...                      fm.formatdate(f[2], b'%Y-%m-%d %H:%M:%S'))

...         fm.data(size=f[1])

...         fm.plain(b'\\n')

...     fm.end()

>>> show(files)

foo

bar

>>> show(files, verbose=True)

foo  1970-01-01 00:00:00

bar  1970-01-01 00:00:01

>>> show(files, template=b'json')

[

 {

  "date": [0, 0],

  "path": "foo",

  "size": 123

 },

 {

  "date": [1, 0],

  "path": "bar",

  "size": 456

 }

]

>>> show(files, template=b'path: {path}\\ndate: {date|rfc3339date}\\n')

path: foo

date: 1970-01-01T00:00:00+00:00

path: bar

date: 1970-01-01T00:00:01+00:00

Nested example:

>>> def subrepos(ui, fm):

...     fm.startitem()

...     fm.write(b'reponame', b'[%s]\\n', b'baz')

...     files(ui, fm.nested(b'files', tmpl=b'{reponame}'))

...     fm.end()

>>> show(subrepos)

[baz]

foo

bar

>>> show(subrepos, template=b'{reponame}: {join(files % "{path}", ", ")}\\n')

baz: foo, bar

"""

from __future__ import absolute_import, print_function

import contextlib

import itertools

import os

from .i18n import _

from .node import (

    hex,

    short,

)

from .thirdparty import attr

from . import (

    error,

    pycompat,

    templatefilters,

    templatekw,

    templater,

    templateutil,

    util,

)

from .utils import (

    cborutil,

    dateutil,

    stringutil,

)

pickle = util.pickle

class _nullconverter(object):

    '''convert non-primitive data types to be processed by formatter'''

    # set to True if context object should be stored as item

    storecontext = False

    @staticmethod

    def wrapnested(data, tmpl, sep):

        '''wrap nested data by appropriate type'''

        return data

    @staticmethod

    def formatdate(date, fmt):

        '''convert date tuple to appropriate format'''

        # timestamp can be float, but the canonical form should be int

        ts, tz = date

        return (int(ts), tz)

    @staticmethod

    def formatdict(data, key, value, fmt, sep):

        '''convert dict or key-value pairs to appropriate dict format'''

        # use plain dict instead of util.sortdict so that data can be

        # serialized as a builtin dict in pickle output

        return dict(data)

    @staticmethod

    def formatlist(data, name, fmt, sep):

        '''convert iterable to appropriate list format'''

        return list(data)

class baseformatter(object):

    def __init__(self, ui, topic, opts, converter):

        self._ui = ui

        self._topic = topic

        self._opts = opts

        self._converter = converter

        self._item = None

        # function to convert node to string suitable for this output

        self.hexfunc = hex

    def __enter__(self):

        return self

    def __exit__(self, exctype, excvalue, traceback):

        if exctype is None:

            self.end()

    def _showitem(self):

        '''show a formatted item once all data is collected'''

    def startitem(self):

        '''begin an item in the format list'''

        if self._item is not None:

            self._showitem()

        self._item = {}

    def formatdate(self, date, fmt=b'%a %b %d %H:%M:%S %Y %1%2'):

        '''convert date tuple to appropriate format'''

        return self._converter.formatdate(date, fmt)

    def formatdict(self, data, key=b'key', value=b'value', fmt=None, sep=b' '):

        '''convert dict or key-value pairs to appropriate dict format'''

        return self._converter.formatdict(data, key, value, fmt, sep)

    def formatlist(self, data, name, fmt=None, sep=b' '):

        '''convert iterable to appropriate list format'''

        # name is mandatory argument for now, but it could be optional if

        # we have default template keyword, e.g. {item}

        return self._converter.formatlist(data, name, fmt, sep)

    def context(self, **ctxs):

        '''insert context objects to be used to render template keywords'''

        ctxs = pycompat.byteskwargs(ctxs)

        assert all(k in {b'repo', b'ctx', b'fctx'} for k in ctxs)

        if self._converter.storecontext:

            # populate missing resources in fctx -> ctx -> repo order

            if b'fctx' in ctxs and b'ctx' not in ctxs:

                ctxs[b'ctx'] = ctxs[b'fctx'].changectx()

            if b'ctx' in ctxs and b'repo' not in ctxs:

                ctxs[b'repo'] = ctxs[b'ctx'].repo()

            self._item.update(ctxs)

    def datahint(self):

        '''set of field names to be referenced'''

        return set()

    def data(self, **data):

        '''insert data into item that's not shown in default output'''

        data = pycompat.byteskwargs(data)

        self._item.update(data)

    def write(self, fields, deftext, *fielddata, **opts):

        '''do default text output while assigning data to item'''

        fieldkeys = fields.split()

        assert len(fieldkeys) == len(fielddata), (fieldkeys, fielddata)

        self._item.update(zip(fieldkeys, fielddata))

    def condwrite(self, cond, fields, deftext, *fielddata, **opts):

        '''do conditional write (primarily for plain formatter)'''

        fieldkeys = fields.split()

        assert len(fieldkeys) == len(fielddata)

        self._item.update(zip(fieldkeys, fielddata))

    def plain(self, text, **opts):

        '''show raw text for non-templated mode'''

    def isplain(self):

        '''check for plain formatter usage'''

        return False

    def nested(self, field, tmpl=None, sep=b''):

        '''sub formatter to store nested data in the specified field'''

        data = []

        self._item[field] = self._converter.wrapnested(data, tmpl, sep)

        return _nestedformatter(self._ui, self._converter, data)

    def end(self):

        '''end output for the formatter'''

        if self._item is not None:

            self._showitem()

def nullformatter(ui, topic, opts):

    '''formatter that prints nothing'''

    return baseformatter(ui, topic, opts, converter=_nullconverter)

class _nestedformatter(baseformatter):

    '''build sub items and store them in the parent formatter'''

    def __init__(self, ui, converter, data):

        baseformatter.__init__(

            self, ui, topic=b'', opts={}, converter=converter

        )

        self._data = data

    def _showitem(self):

        self._data.append(self._item)

def _iteritems(data):

    '''iterate key-value pairs in stable order'''

    if isinstance(data, dict):

        return sorted(data.iteritems())

    return data

class _plainconverter(object):

    '''convert non-primitive data types to text'''

    storecontext = False

    @staticmethod

    def wrapnested(data, tmpl, sep):

        raise error.ProgrammingError(b'plainformatter should never be nested')

    @staticmethod

    def formatdate(date, fmt):

        '''stringify date tuple in the given format'''

        return dateutil.datestr(date, fmt)

    @staticmethod

    def formatdict(data, key, value, fmt, sep):

        '''stringify key-value pairs separated by sep'''

        prefmt = pycompat.identity

        if fmt is None:

            fmt = b'%s=%s'

            prefmt = pycompat.bytestr

        return sep.join(

            fmt % (prefmt(k), prefmt(v)) for k, v in _iteritems(data)

        )

    @staticmethod

    def formatlist(data, name, fmt, sep):

        '''stringify iterable separated by sep'''

        prefmt = pycompat.identity

        if fmt is None:

            fmt = b'%s'

            prefmt = pycompat.bytestr

        return sep.join(fmt % prefmt(e) for e in data)

class plainformatter(baseformatter):

    '''the default text output scheme'''

    def __init__(self, ui, out, topic, opts):

        baseformatter.__init__(self, ui, topic, opts, _plainconverter)

        if ui.debugflag:

            self.hexfunc = hex

        else:

            self.hexfunc = short

        if ui is out:

            self._write = ui.write

        else:

            self._write = lambda s, **opts: out.write(s)

    def startitem(self):

        pass

    def data(self, **data):

        pass

    def write(self, fields, deftext, *fielddata, **opts):

        self._write(deftext % fielddata, **opts)

    def condwrite(self, cond, fields, deftext, *fielddata, **opts):

        '''do conditional write'''

        if cond:

            self._write(deftext % fielddata, **opts)

    def plain(self, text, **opts):

        self._write(text, **opts)

    def isplain(self):

        return True

    def nested(self, field, tmpl=None, sep=b''):

        # nested data will be directly written to ui

        return self

    def end(self):

        pass

class debugformatter(baseformatter):

    def __init__(self, ui, out, topic, opts):

        baseformatter.__init__(self, ui, topic, opts, _nullconverter)

        self._out = out

        self._out.write(b"%s = [\n" % self._topic)

    def _showitem(self):

        self._out.write(

            b'    %s,\n' % stringutil.pprint(self._item, indent=4, level=1)

        )

    def end(self):

        baseformatter.end(self)

        self._out.write(b"]\n")

class pickleformatter(baseformatter):

    def __init__(self, ui, out, topic, opts):

        baseformatter.__init__(self, ui, topic, opts, _nullconverter)

        self._out = out

        self._data = []

    def _showitem(self):

        self._data.append(self._item)

    def end(self):

        baseformatter.end(self)

        self._out.write(pickle.dumps(self._data))

class cborformatter(baseformatter):

    '''serialize items as an indefinite-length CBOR array'''