99 lines
4 KiB
Python
99 lines
4 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""Format adapter for the tabulate module."""
|
|
|
|
from __future__ import unicode_literals
|
|
|
|
from cli_helpers.utils import filter_dict_by_key
|
|
from cli_helpers.compat import (Terminal256Formatter, StringIO)
|
|
from .preprocessors import (convert_to_string, truncate_string, override_missing_value,
|
|
style_output, HAS_PYGMENTS)
|
|
|
|
import tabulate
|
|
|
|
supported_markup_formats = ('mediawiki', 'html', 'latex', 'latex_booktabs',
|
|
'textile', 'moinmoin', 'jira')
|
|
supported_table_formats = ('plain', 'simple', 'grid', 'fancy_grid', 'pipe',
|
|
'orgtbl', 'psql', 'rst')
|
|
supported_formats = supported_markup_formats + supported_table_formats
|
|
|
|
preprocessors = (override_missing_value, convert_to_string, truncate_string, style_output)
|
|
|
|
|
|
def style_output_table(format_name=""):
|
|
def style_output(data, headers, style=None,
|
|
table_separator_token='Token.Output.TableSeparator', **_):
|
|
"""Style the *table* a(e.g. bold, italic, and colors)
|
|
|
|
.. NOTE::
|
|
This requires the `Pygments <http://pygments.org/>`_ library to
|
|
be installed. You can install it with CLI Helpers as an extra::
|
|
$ pip install cli_helpers[styles]
|
|
|
|
Example usage::
|
|
|
|
from cli_helpers.tabular_output import tabulate_adapter
|
|
from pygments.style import Style
|
|
from pygments.token import Token
|
|
|
|
class YourStyle(Style):
|
|
default_style = ""
|
|
styles = {
|
|
Token.Output.TableSeparator: '#ansigray'
|
|
}
|
|
|
|
headers = ('First Name', 'Last Name')
|
|
data = [['Fred', 'Roberts'], ['George', 'Smith']]
|
|
style_output_table = tabulate_adapter.style_output_table('psql')
|
|
style_output_table(data, headers, style=CliStyle)
|
|
|
|
data, headers = style_output(data, headers, style=YourStyle)
|
|
output = tabulate_adapter.adapter(data, headers, style=YourStyle)
|
|
|
|
:param iterable data: An :term:`iterable` (e.g. list) of rows.
|
|
:param iterable headers: The column headers.
|
|
:param str/pygments.style.Style style: A Pygments style. You can `create
|
|
your own styles <https://pygments.org/docs/styles#creating-own-styles>`_.
|
|
:param str table_separator_token: The token type to be used for the table separator.
|
|
:return: data and headers.
|
|
:rtype: tuple
|
|
|
|
"""
|
|
if style and HAS_PYGMENTS and format_name in supported_table_formats:
|
|
formatter = Terminal256Formatter(style=style)
|
|
|
|
def style_field(token, field):
|
|
"""Get the styled text for a *field* using *token* type."""
|
|
s = StringIO()
|
|
formatter.format(((token, field),), s)
|
|
return s.getvalue()
|
|
|
|
def addColorInElt(elt):
|
|
if not elt:
|
|
return elt
|
|
if elt.__class__ == tabulate.Line:
|
|
return tabulate.Line(*(style_field(table_separator_token, val) for val in elt))
|
|
if elt.__class__ == tabulate.DataRow:
|
|
return tabulate.DataRow(*(style_field(table_separator_token, val) for val in elt))
|
|
return elt
|
|
|
|
srcfmt = tabulate._table_formats[format_name]
|
|
newfmt = tabulate.TableFormat(
|
|
*(addColorInElt(val) for val in srcfmt))
|
|
tabulate._table_formats[format_name] = newfmt
|
|
|
|
return iter(data), headers
|
|
return style_output
|
|
|
|
def adapter(data, headers, table_format=None, preserve_whitespace=False,
|
|
**kwargs):
|
|
"""Wrap tabulate inside a function for TabularOutputFormatter."""
|
|
keys = ('floatfmt', 'numalign', 'stralign', 'showindex', 'disable_numparse')
|
|
tkwargs = {'tablefmt': table_format}
|
|
tkwargs.update(filter_dict_by_key(kwargs, keys))
|
|
|
|
if table_format in supported_markup_formats:
|
|
tkwargs.update(numalign=None, stralign=None)
|
|
|
|
tabulate.PRESERVE_WHITESPACE = preserve_whitespace
|
|
|
|
return iter(tabulate.tabulate(data, headers, **tkwargs).split('\n'))
|