epicsarchiver.common.base_archiver
==================================

.. py:module:: epicsarchiver.common.base_archiver

.. autoapi-nested-parse::

   Base Archiver Client module for get, post etc requests.



Attributes
----------

.. autoapisummary::

   epicsarchiver.common.base_archiver.LOG
   epicsarchiver.common.base_archiver.DEFAULT_RETRIEVAL_PORT


Classes
-------

.. autoapisummary::

   epicsarchiver.common.base_archiver.BaseArchiverAppliance


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

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

.. py:data:: DEFAULT_RETRIEVAL_PORT
   :value: 17668


.. py:class:: BaseArchiverAppliance(hostname: str = 'localhost', port: int = DEFAULT_RETRIEVAL_PORT)

   Base EPICS Archiver Appliance client.

   Hold a session to the Archiver Appliance web application.

   :param hostname: EPICS Archiver Appliance hostname
   :param port: EPICS Archiver Appliance retrieval port


   .. py:attribute:: hostname
      :value: 'localhost'



   .. py:attribute:: port
      :value: 17668



   .. py:attribute:: _base_url
      :type:  str
      :value: 'http://localhost:17668'



   .. py:attribute:: session


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

      String representation of Archiver Appliance.

      :returns: details including hostname of Archiver appliance.
      :rtype: str



   .. py:method:: _get(endpoint: str, params: dict[str, str]) -> requests.Response

      Sends a request using the session.

      :param endpoint: API endpoint (relative or absolute)
      :param params: query parameters to include in the request.

      :returns: :class:`requests.Response <Response>` object

      :raises ArchiverConnectionError: If there is a connection error.
      :raises ArchiverResponseError: If the response is not successful.