Skip to content

exceptions

Provides exceptions for Plugboard.

ChannelClosedError

Bases: ChannelError

Raised when a closed channel is accessed.

ChannelError

Bases: Exception

Raised for channel related errors.

ChannelNotConnectedError

Bases: ChannelError

Raised when using a channel that is not connected.

ChannelSetupError

Bases: ChannelError

Raised when a channel is setup incorrectly.

ConstraintError

ConstraintError(
    *args: object, objective_value: float | None = None
)

Bases: Exception

Raised when a constraint is violated.

Parameters:

Name Type Description Default
*args object

Standard exception arguments.

()
objective_value float | None

Optional; A custom value to assign to the objective when this constraint is violated. If not provided, the tuner will assign plus or minus infinity depending on the optimisation direction.

None

EventError

Bases: Exception

Raised for event related errors.

EventStreamClosedError

Bases: Exception

Raised when there are no more event producers running.

IOControllerError

Bases: Exception

Raised for IO controller related errors.

IOSetupError

Bases: IOControllerError

Raised when an IO controller is setup incorrectly.

IOStreamClosedError

Bases: IOControllerError

IOStreamClosedError is raised when an IO stream is closed.

NoMoreDataException

Bases: Exception

Raised when there is no more data to fetch.

NotFoundError

Bases: StateBackendError

Raised when a resource is not found.

NotInitialisedError

Bases: Exception

Raised attempting to step or run a Process or Component that has not been initialised.

ProcessStatusError

Bases: Exception

Raised when a Process is in an invalid state for the requested operation.

RegistryError

Bases: Exception

Raised when an unknown class is requested from the ClassRegistry.

StateBackendError

Bases: Exception

Raised for StateBackend related errors.

UnrecognisedEventError

Bases: EventError

Raised when an unrecognised event is encountered.

ValidationError

Bases: Exception

Raised when an invalid Process or Component is encountered.