epicsarchiver.statistics.configuration
======================================

.. py:module:: epicsarchiver.statistics.configuration

.. autoapi-nested-parse::

   Module for getting the PVs which have been requested to be submitted to the archiver.

   Also calculates if a PV is being archived with no configuration left over, common when
   a PV name has changed.



Attributes
----------

.. autoapisummary::

   epicsarchiver.statistics.configuration.LOG
   epicsarchiver.statistics.configuration.CHANNELFINDER_ARCHIVE_TAG
   epicsarchiver.statistics.configuration.CHANNELFINDER_ARCHIVER_ALIAS


Classes
-------

.. autoapisummary::

   epicsarchiver.statistics.configuration.ConfigOptions


Functions
---------

.. autoapisummary::

   epicsarchiver.statistics.configuration._fetch_configured_pvs_channelfinder
   epicsarchiver.statistics.configuration._fetch_configured_pvs_gitlab
   epicsarchiver.statistics.configuration.get_not_configured
   epicsarchiver.statistics.configuration._get_configuration_responses
   epicsarchiver.statistics.configuration.get_aliases


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

.. py:data:: LOG
   :type:  logging.Logger

.. py:data:: CHANNELFINDER_ARCHIVE_TAG
   :value: 'aa_policy'


.. py:data:: CHANNELFINDER_ARCHIVER_ALIAS
   :value: 'archiver'


.. py:class:: ConfigOptions

   Options in how a PV can be configured.

   gitlab_repo: Repository where archive config files ly
   archiver_alias: Tag used in ChannelFinder to select an archiver cluster.


   .. py:attribute:: gitlab_repo
      :type:  pathlib.Path | None


   .. py:attribute:: archiver_alias
      :type:  str | None


.. py:function:: _fetch_configured_pvs_channelfinder(channelfinder: epicsarchiver.statistics.services.channelfinder.ChannelFinder, archiver_alias: str, filter_pvs: set[str] | None = None) -> set[str]
   :async:


.. py:function:: _fetch_configured_pvs_gitlab(config_gitlab_repo: pathlib.Path) -> set[str]
   :async:


.. py:function:: get_not_configured(archiver: epicsarchiver.statistics.services.archiver_statistics.ArchiverWrapper, channelfinder: epicsarchiver.statistics.services.channelfinder.ChannelFinder, config_options: ConfigOptions, ioc_name: str | None = None, filter_pvs: set[str] | None = None) -> list[epicsarchiver.statistics.models.stat_responses.NoConfigResponse]
   :async:


   Return list of pvs archived but not in config or configured but not archived.

   :param archiver: archiver
   :type archiver: ArchiverAppliance
   :param channelfinder: channelfinder
   :type channelfinder: ChannelFinder
   :param config_options: Options on how submit PV to be archived
   :type config_options: ConfigOptions
   :param ioc_name: Name of an ioc to filter by
   :type ioc_name: str
   :param filter_pvs: Set of pvs to filter by
   :type filter_pvs: set[str]

   :returns: Details of pvs.
   :rtype: list[NoConfigResponse]


.. py:function:: _get_configuration_responses(channelfinder: epicsarchiver.statistics.services.channelfinder.ChannelFinder, all_pvs: set[str], pvs: set[str], status: epicsarchiver.statistics.models.stat_responses.ConfiguredStatus, ioc_name: str | None = None) -> list[epicsarchiver.statistics.models.stat_responses.NoConfigResponse]
   :async:


.. py:function:: get_aliases(channelfinder: epicsarchiver.statistics.services.channelfinder.ChannelFinder, pvs: list[str], ioc_name: str | None) -> dict[str, list[str]]
   :async:


   Get the aliases for a list of pvs.

   :param channelfinder: channelfinder
   :type channelfinder: ChannelFinder
   :param pvs: list of pv names
   :type pvs: list[str]
   :param ioc_name: ioc to filter by
   :type ioc_name: str

   :returns: dictionary mapping pv name to list of aliases
   :rtype: dict[str, list[str]]