epicsarchiver.retrieval.dataframe
=================================

.. py:module:: epicsarchiver.retrieval.dataframe

.. autoapi-nested-parse::

   Polars DataFrame utilities for archived events.

   Requires the [polars] extra: pip install epicsarchiver-retrieval-client[polars]



Attributes
----------

.. autoapisummary::

   epicsarchiver.retrieval.dataframe._FIELD_VALUE_DTYPE


Classes
-------

.. autoapisummary::

   epicsarchiver.retrieval.dataframe._EventColumns


Functions
---------

.. autoapisummary::

   epicsarchiver.retrieval.dataframe._fv_list
   epicsarchiver.retrieval.dataframe.dataframe_from_events
   epicsarchiver.retrieval.dataframe.json_to_dataframe


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

.. py:data:: _FIELD_VALUE_DTYPE

.. py:function:: _fv_list(fvs: list[epicsarchiver.retrieval.archive_event.FieldValue] | None) -> list[dict[str, str]]

.. py:class:: _EventColumns

   .. py:attribute:: date
      :type:  list[int]


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


   .. py:attribute:: val
      :type:  list[Any]


   .. py:attribute:: severity
      :type:  list[int]


   .. py:attribute:: status
      :type:  list[int]


   .. py:attribute:: field_values
      :type:  list[list[dict[str, str]]]


   .. py:attribute:: headers
      :type:  list[list[dict[str, str]]]


   .. py:method:: from_list(events: list[epicsarchiver.retrieval.archive_event.ArchiveEvent], metadata: dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta]) -> _EventColumns
      :staticmethod:



.. py:function:: dataframe_from_events(events: list[epicsarchiver.retrieval.archive_event.ArchiveEvent], metadata: dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta] | None = None) -> polars.DataFrame

   Converts a list of ArchiveEvent to pl.DataFrame.

   :param events: input events
   :type events: list[ArchiveEvent]
   :param metadata: optional per-year metadata;
                    when provided, populates the "headers" column.
   :type metadata: dict[int, ArchiveEventsMeta] | None

   :returns:

             columns "date", "pv", "val", "severity", "status",
                 "field_values", "headers".
   :rtype: pl.DataFrame


.. py:function:: json_to_dataframe(data: Any) -> polars.DataFrame

   Converts json from the archiver.

   Converts to a dataframe with columns "date", "val", and any other fields
   returned by the API (typically "severity", "status").

   :param data: json from a json archiver request

   :returns: pl.DataFrame