epicsarchiver.common.base_archiver

Base Archiver Client module for get, post etc requests.

Attributes

LOG

DEFAULT_RETRIEVAL_PORT

Classes

BaseArchiverAppliance

Base EPICS Archiver Appliance client.

Module Contents

epicsarchiver.common.base_archiver.LOG: logging.Logger[source]
epicsarchiver.common.base_archiver.DEFAULT_RETRIEVAL_PORT = 17668[source]
class epicsarchiver.common.base_archiver.BaseArchiverAppliance(hostname: str = 'localhost', port: int = DEFAULT_RETRIEVAL_PORT)[source]

Base EPICS Archiver Appliance client.

Hold a session to the Archiver Appliance web application.

Parameters:

  • hostname – EPICS Archiver Appliance hostname

  • port – EPICS Archiver Appliance retrieval port

hostname = 'localhost'[source]
port = 17668[source]
_base_url: str = 'http://localhost:17668'[source]
session[source]
__repr__() → str[source]

String representation of Archiver Appliance.

Returns:

details including hostname of Archiver appliance.

Return type:

str

_get(endpoint: str, params: dict[str, str]) → requests.Response[source]

Sends a request using the session.

Parameters:

  • endpoint – API endpoint (relative or absolute)

  • params – query parameters to include in the request.

Returns:

requests.Response object

Raises: