maestral.cli.output
===================

.. py:module:: maestral.cli.output

.. autoapi-nested-parse::

   This module provides classes and methods for beautifully formatted output to stdout.
   This includes printing tables and grids, formatting dates and eliding strings.









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

.. py:data:: TABLE_STYLE

.. py:function:: rich_table(*headers)

.. py:class:: RichDateField(dt, style = '')

   A datetime renderable.


   .. py:attribute:: dt


   .. py:attribute:: style
      :value: ''



   .. py:method:: format(max_width)


.. py:class:: Prefix

   Bases: :py:obj:`enum.Enum`


   Prefix for command line output


   .. py:attribute:: Info
      :value: 0



   .. py:attribute:: Ok
      :value: 1



   .. py:attribute:: Warn
      :value: 2



   .. py:attribute:: NONE
      :value: 3



.. py:function:: echo(message, nl = True, prefix = Prefix.NONE)

   Print a message to stdout.

   :param message: The string to output.
   :param nl: Whether to end with a new line.
   :param prefix: Any prefix to output before the message,


.. py:function:: info(message, nl = True)

   Print an info message to stdout. Will be prefixed with a dash.

   :param message: The string to output.
   :param nl: Whether to end with a new line.


.. py:function:: warn(message, nl = True)

   Print a warning to stdout. Will be prefixed with an exclamation mark.

   :param message: The string to output.
   :param nl: Whether to end with a new line.


.. py:function:: ok(message, nl = True)

   Print a confirmation to stdout. Will be prefixed with a checkmark.

   :param message: The string to output.
   :param nl: Whether to end with a new line.


.. py:function:: echo_via_pager(text_or_generator, color = None)