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

.. py:module:: epicsarchiver.write

.. autoapi-nested-parse::

   Format writers and terminal table formatters for archived event output.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/epicsarchiver/write/export_format/index
   /autoapi/epicsarchiver/write/search_format/index
   /autoapi/epicsarchiver/write/table_format/index


Classes
-------

.. autoapisummary::

   epicsarchiver.write.Format
   epicsarchiver.write.SearchTable
   epicsarchiver.write.FormatTable


Functions
---------

.. autoapisummary::

   epicsarchiver.write.write_events


Package Contents
----------------

.. py:class:: Format(*args, **kwds)

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


   Supported machine-readable output formats for the export command.


   .. py:attribute:: JSON


   .. py:attribute:: CSV


   .. py:attribute:: ARROW


   .. py:attribute:: PARQUET


   .. py:attribute:: PB


.. py:function:: write_events(dest: IO[Any], fmt: Format, events: list[epicsarchiver.retrieval.archive_event.ArchiveEvent], meta: dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta] | None) -> None

   Write events to dest in the given format. Requires the [polars] extra.

   :param dest: Binary destination to write to.
   :param fmt: Output format (JSON, CSV, ARROW, or PARQUET).
   :param events: Events to write.
   :param meta: Optional per-year metadata.

   :raises ValueError: If fmt is not a supported event format (e.g. PB).


.. py:class:: SearchTable

   Formats a list of PV names into a Rich Table for the search command.


   .. py:attribute:: pvs
      :type:  list[str]


   .. py:attribute:: start
      :type:  datetime.datetime | None


   .. py:attribute:: end
      :type:  datetime.datetime | None


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


   .. py:method:: _create_pv_name_table(title: str) -> rich.table.Table


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

      Return a Rich Table of PV names.



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

      Print the search results table to the terminal.



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