epicsarchiver.write.table_format
================================

.. py:module:: epicsarchiver.write.table_format

.. autoapi-nested-parse::

   Terminal table formatter for archived events.



Classes
-------

.. autoapisummary::

   epicsarchiver.write.table_format.FormatTable


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

.. py:class:: FormatTable

   Renders a flat list of ArchiveEvents as a Rich table to the terminal.


   .. py:attribute:: events
      :type:  list[epicsarchiver.retrieval.archive_event.ArchiveEvent]


   .. py:attribute:: pvs
      :type:  tuple[str, Ellipsis]


   .. py:attribute:: start
      :type:  datetime.datetime


   .. py:attribute:: end
      :type:  datetime.datetime


   .. py:attribute:: processor
      :type:  epicsarchiver.retrieval.client.processor.Processor | None


   .. py:attribute:: meta
      :type:  dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta] | None


   .. py:method:: _meta_field_values() -> dict[int, dict[str, str]]


   .. py:method:: _table_caption(field_values: dict[int, dict[str, str]]) -> str | None
      :staticmethod:



   .. py:method:: _table_title() -> str


   .. py:method:: _create_table(title: str, caption: str | None) -> rich.table.Table


   .. py:method:: render() -> rich.table.Table

      Render events as a Rich Table.

      :returns: Rich Table ready to print.
      :rtype: Table



   .. py:method:: write() -> None

      Print the rendered table to the terminal.