api Package

api Package

const Module

exceptions Module

exception silf.backend.commons.api.exceptions.ConfigurationException

Bases: silf.backend.commons.api.exceptions.SilfException

exception silf.backend.commons.api.exceptions.DeviceException(message, fixable_by_user=False, **kwargs)

Bases: silf.backend.commons.api.exceptions.SilfException

Exception raised by the device.

fixable_by_user = None

bool. True if this erroc can be fixed by user.

exception silf.backend.commons.api.exceptions.DeviceRuntimeException

Bases: silf.backend.commons.api.exceptions.SilfException

Wrapper for any exception raised by the device.

exception silf.backend.commons.api.exceptions.DiagnosticsException

Bases: silf.backend.commons.api.exceptions.DeviceRuntimeException

Thrown if intialization of this device encounters an error.

exception silf.backend.commons.api.exceptions.ExperimentBackendUnresponsive

Bases: silf.backend.commons.api.exceptions.SILFProtocolError

exception silf.backend.commons.api.exceptions.ExperimentCreationError

Bases: silf.backend.commons.api.exceptions.ConfigurationException

Raised when we can’t create an experiment

exception silf.backend.commons.api.exceptions.InvalidModeException

Bases: silf.backend.commons.api.exceptions.SilfException

Raised when experiment or device wrapper is in invalid mode.

exception silf.backend.commons.api.exceptions.InvalidStateException(message, fixable_by_user=False, **kwargs)

Bases: silf.backend.commons.api.exceptions.DeviceException

Raised when device is in invalid state

exception silf.backend.commons.api.exceptions.MissingRequiredControlException(errors)

Bases: silf.backend.commons.api.exceptions.ValidationError

exception silf.backend.commons.api.exceptions.SILFProtocolError(errors)

Bases: silf.backend.commons.api.exceptions.SilfException

Exception that should be propagated to the enduser, it should be caught by the experiment class and trensformed to error stanza.

classmethod from_args(severity, error_type, message, field=None, **kwargs)
>>> raise SILFProtocolError.from_args("error", "system", "Test error") 
Traceback (most recent call last):
exceptions.SILFProtocolError: Test error

Constructs SILFProtocolError from Error constructed from args and kwargs. :rtype: SILFProtocolError

classmethod join(*args)

Constructs SILFProtocolError from other SILFProtocolError newly created exception will contain all errors from exception it was created from. :param args: Iterable of SILFProtocolError :rtype: SILFProtocolError

exception silf.backend.commons.api.exceptions.SerializationException

Bases: silf.backend.commons.api.exceptions.SilfException

Exception raised during serialization to or from json. It normally signifies programming error.

exception silf.backend.commons.api.exceptions.SettingNonLiveControlException(errors)

Bases: silf.backend.commons.api.exceptions.ValidationError

exception silf.backend.commons.api.exceptions.SilfException

Bases: Exception

exception silf.backend.commons.api.exceptions.ValidationError(errors)

Bases: silf.backend.commons.api.exceptions.SILFProtocolError