epicsarchiver_mgmt.commands.basic_commands

Basic commands to modify PVs in the archiver.

Attributes

LOG

PAUSE_EXPECTED_STATUS

Classes

BasicCommand

Basic command to modify PVs in the archiver.

PauseCommand

Pause command to modify PVs in the archiver.

ResumeCommand

Resume command to modify PVs in the archiver.

DeleteCommand

Delete command to modify PVs in the archiver.

AbortCommand

Abort command to modify PVs in the archiver.

Module Contents

epicsarchiver_mgmt.commands.basic_commands.LOG: logging.Logger[source]
epicsarchiver_mgmt.commands.basic_commands.PAUSE_EXPECTED_STATUS[source]
class epicsarchiver_mgmt.commands.basic_commands.BasicCommand[source]

Basic command to modify PVs in the archiver.

command_name: str[source]
expected_statuses: collections.abc.Sequence[epicsarchiver_mgmt.archiver.info.ArchivingStatus | None][source]
expected_operation_results: dict[str, list[str]] | None = None[source]
abstractmethod __call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) → epicsarchiver_mgmt.archiver.mgmt.OperationResult[source]

Command to execute.

Parameters:

  • archiver (ArchiverMgmt) – The archiver to use.

  • pv (str) – The PV to modify.

Returns:

The result of the command.

Return type:

OperationResult

run_command(archiver_fqdns: list[str], pvs: collections.abc.Sequence[str], *, skip_validation: bool = False) → None[source]

Basic command to modify PVs in the archiver.

Parameters:

  • archiver_fqdns (list[str]) – The urls of the archiver.

  • pvs (list[str]) – The PVs to change.

  • skip_validation (bool) – Whether to skip validation of the PVs status.

Raises:

RequestHTTPError – If there is an error changing the PVs.

class epicsarchiver_mgmt.commands.basic_commands.PauseCommand[source]

Bases: BasicCommand

Pause command to modify PVs in the archiver.

__call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) → epicsarchiver_mgmt.archiver.mgmt.OperationResult[source]

Pause PV in the archiver.

Parameters:

  • archiver (ArchiverMgmt) – The archiver to use.

  • pv (str) – The PV to pause.

Returns:

The result of the command.

Return type:

OperationResult

class epicsarchiver_mgmt.commands.basic_commands.ResumeCommand[source]

Bases: BasicCommand

Resume command to modify PVs in the archiver.

__call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) → epicsarchiver_mgmt.archiver.mgmt.OperationResult[source]

Resume PV in the archiver.

Parameters:

  • archiver (ArchiverMgmt) – The archiver to use.

  • pv (str) – The PV to resume.

Returns:

The result of the command.

Return type:

OperationResult

class epicsarchiver_mgmt.commands.basic_commands.DeleteCommand[source]

Bases: BasicCommand

Delete command to modify PVs in the archiver.

__call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) → epicsarchiver_mgmt.archiver.mgmt.OperationResult[source]

Delete PV in the archiver.

Parameters:

  • archiver (ArchiverMgmt) – The archiver to use.

  • pv (str) – The PV to delete.

Returns:

The result of the command.

Return type:

OperationResult

class epicsarchiver_mgmt.commands.basic_commands.AbortCommand[source]

Bases: BasicCommand

Abort command to modify PVs in the archiver.

__call__(archiver: epicsarchiver_mgmt.archiver.mgmt.ArchiverMgmt, pv: str) → epicsarchiver_mgmt.archiver.mgmt.OperationResult[source]

Abort archiving PV in the archiver.

Parameters:

  • archiver (ArchiverMgmt) – The archiver to use.

  • pv (str) – The PV to abort.

Returns:

The result of the command.

Return type:

OperationResult