:py:mod:`buildtest.utils.table`
===============================

.. py:module:: buildtest.utils.table


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   buildtest.utils.table.create_table
   buildtest.utils.table.print_table
   buildtest.utils.table.print_terse_format



.. py:function:: create_table(columns, data, title=None, header_style='blue', column_style=None, show_lines=False)

   Create a table object with the given columns and data. This function is a wrapper around rich.Table
   and it can be used to alter table settings. The return value is a rich.Table object.

   :param columns: List of column names
   :type columns: list
   :param data: List of rows, where each row is a list of values
   :type data: list
   :param title: Title of the table
   :type title: str
   :param header_style: Style of the header
   :type header_style: str
   :param column_style: Style of the columns
   :type column_style: str
   :param show_lines: Whether to show lines in the table
   :type show_lines: bool


.. py:function:: print_table(table, row_count=None, pager=None)

   Print the given table, optionally showing the row count or using a pager.

   :param table: Table to print
   :type table: Table
   :param row_count: Whether to show the row count
   :type row_count: bool
   :param pager: Whether to use a pager
   :type pager: bool


.. py:function:: print_terse_format(tdata, headers, color=None, display_header=False, pager=None)

   This method will print the output of ``buildtest buildspec find`` in terse format.

   :param tdata: Table data to print in terse format
   :type tdata: list
   :param headers: List of headers to print in terse format
   :type headers: list
   :param color: Specify color to use when printing output
   :type color: str
   :param display_header: Display header when printing output
   :type display_header: bool
   :param pager: Use pager when printing output
   :type pager: bool