epicsarchiver.mgmt.archive_files
================================

.. py:module:: epicsarchiver.mgmt.archive_files

.. autoapi-nested-parse::

   Handle parsing files of lists of PVs to submit for archiver operations.



Attributes
----------

.. autoapisummary::

   epicsarchiver.mgmt.archive_files.LOG


Functions
---------

.. autoapisummary::

   epicsarchiver.mgmt.archive_files.parse_archive_file
   epicsarchiver.mgmt.archive_files._parse_rename_line
   epicsarchiver.mgmt.archive_files.parse_rename_file
   epicsarchiver.mgmt.archive_files.get_pvs_from_files
   epicsarchiver.mgmt.archive_files.get_rename_pvs_from_files


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

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

.. py:function:: parse_archive_file(filename: pathlib.Path, appliance: str | None = None) -> collections.abc.Generator[dict[str, str], None, None]

   Parses an archive file.

   Archive file is a list of PVs with an archive policy
   name as optional arguement.

   :param filename: filename of archive file
   :type filename: str
   :param appliance: archiver to archive pv in. Defaults to None.
   :type appliance: str | None, optional

   :Yields: *Generator[dict[str, str], None, None]* -- produces
            dictionary with keys {"pv", "policy", "appliance"}


.. py:function:: _parse_rename_line(line: str) -> tuple[str, str] | None

.. py:function:: parse_rename_file(filename: pathlib.Path) -> collections.abc.Generator[tuple[str, str], None, None]

   Parses a file with a list of pv as old_pv_name new_pv_name.

   :param filename: filename of rename file
   :type filename: str

   :Yields: *Generator[tuple[str, str], None, None]* -- produces a pair old_pv_name, new_pv_name


.. py:function:: get_pvs_from_files(files: list[pathlib.Path], appliance: str | None = None) -> list[dict[str, str]]

   Return a list of PV (as dict) from a list of files.


.. py:function:: get_rename_pvs_from_files(files: list[str] | list[pathlib.Path]) -> list[tuple[str, str]]

   Return a list of (current, new) PV names from a list of files.