moddef.errors module¶

Typed errors (spec §26.3/§26.4, §32), mirroring the TS error classes.

exception moddef.errors.AmbiguousMeasurandError(query: object, matches: list[str])[source]¶

More than one point matches the measurand query (spec §26.4).

exception moddef.errors.CommandNotFoundError(command_id: str)[source]¶

A command id does not exist in the device profile (spec §11.7).

exception moddef.errors.DecodeError(point_id: str, message: str)[source]¶: Bases: ModDefError

exception moddef.errors.DeviceNotFoundError(device_id: str)[source]¶: Bases: ModDefError

exception moddef.errors.EncodeError(point_id: str, message: str)[source]¶: Bases: ModDefError

exception moddef.errors.MeasurandNotSupportedError(query: object)[source]¶: Bases: ModDefError

exception moddef.errors.ModDefError[source]¶

Bases: Exception

Base class for all moddef errors.

exception moddef.errors.ParseError[source]¶

Bases: ModDefError

Document failed to parse (bad format, unknown field, bad enum value).

exception moddef.errors.PointNotFoundError(point_id: str)[source]¶: Bases: ModDefError

exception moddef.errors.PollTimeoutError(point_id: str, timeout_ms: int)[source]¶

A poll step exceeded its timeout_ms (spec §11.7).

exception moddef.errors.RequiredParamMissingError(command_id: str, field: str)[source]¶

A required command param was not supplied to run_command (spec §11.7).

exception moddef.errors.StepReferenceError(ref: str, kind: str)[source]¶

A command step/result reference does not resolve (spec §11.7).

exception moddef.errors.UnsupportedMappingError(subject: str, message: str)[source]¶: Bases: ModDefError

exception moddef.errors.WriteAccessError(point_id: str, access: str)[source]¶: Bases: ModDefError

exception moddef.errors.WriteConstraintError(point_id: str, constraint: str, value: object, message: str)[source]¶

§11.4 constraint violation; constraint names the violated rule.