atef.config

Contains “Configuration” dataclasses for organizing Comparisons. Also contains “Prepared” variants of Comparison and Configuration classes, which link Comparisons to specific identifiers and hold Result objects.

Functions

get_result_from_comparison(item)

Get a Result, if available, from the provided arguments.

run_passive_step(config)

Runs a given check and returns the result.

Classes

Configuration([name, description, tags])

Configuration base class for shared settings between all configurations.

ConfigurationFile(version, root)

A configuration file comprised of a number of devices/PV configurations.

ConfigurationGroup(name, description, tags, ...)

Configuration group.

DeviceConfiguration(name, description, tags, ...)

A configuration that is built to check one or more devices.

FailedConfiguration(parent, config, result)

A Configuration that failed to be prepared for running.

PVConfiguration(name, description, tags, ...)

A configuration that is built to check live EPICS PVs.

PreparedComparison(cache, identifier, ...)

A unified representation of comparisons for device signals and standalone PVs.

PreparedConfiguration(cache, parent, ...)

Base class for a Configuration that has been prepared to run.

PreparedDeviceConfiguration(cache, parent, ...)

PreparedFile(cache, file, client, root)

PreparedGroup(cache, parent, comparisons, ...)

PreparedPVConfiguration(cache, parent, ...)

PreparedSignalComparison(cache, identifier, ...)

A unified representation of comparisons for device signals and standalone PVs.

PreparedTemplateConfiguration(cache, parent, ...)

PreparedToolComparison(cache, identifier, ...)

A unified representation of comparisons for device signals and standalone PVs.

PreparedToolConfiguration(cache, parent, ...)

TemplateConfiguration(name, description, ...)

A Configuration for applying changes to a template file.

ToolConfiguration(name, description, tags, ...)

A configuration unrelated to PVs or Devices which verifies status via some tool.