epicsarchiver.common.validation

Validation functions and exceptions for archiver retrieval.

Exceptions

ValidationError	Base class for all validation-related exceptions.
PVNameError	Exception raised for invalid PV names.
TimePeriodError	Exception raised for invalid time periods.
ProcessorBinSizeError	Exception raised for invalid processor bin size.

Functions

validate_pv(→ None)	Validate the PV name.
validate_start_end(→ None)	Validate the start and end datetime objects.
validate_processor(→ None)	Validate the processor.

Module Contents

exception epicsarchiver.common.validation.ValidationError

Bases: Exception

Base class for all validation-related exceptions.

exception epicsarchiver.common.validation.PVNameError

Bases: ValidationError

Exception raised for invalid PV names.

epicsarchiver.common.validation.validate_pv(pv: str) → None

Validate the PV name.

Parameters:

pv (str) – The process variable name to validate.

Raises:

PVNameError – If the PV name is empty or not a string.

exception epicsarchiver.common.validation.TimePeriodError(start: datetime.datetime, end: datetime.datetime)

Bases: ValidationError

Exception raised for invalid time periods.

epicsarchiver.common.validation.validate_start_end(start: datetime.datetime, end: datetime.datetime) → None

Validate the start and end datetime objects.

Parameters:

• start (datetime.datetime) – The start time of the period.

• end (datetime.datetime) – The end time of the period.

Raises:

TimePeriodError – If the start time is not before the end time.

exception epicsarchiver.common.validation.ProcessorBinSizeError(bin_size: int)

Bases: ValidationError

Exception raised for invalid processor bin size.

epicsarchiver.common.validation.validate_processor(processor: epicsarchiver.retrieval.archiver_retrieval.processor.Processor | None) → None

Validate the processor.

Parameters:

processor (Processor | None) – The processor to validate.

Raises:

ProcessorBinSizeError – If the processor’s bin size set to a value less than 1.