mbdlyb.messages

Message classes for model validation and diagnostics.

Provides classes for representing validation issues, errors, and warnings during model creation and analysis.

Classes

`Error`	High-priority validation error message.
`ValidationMessage`	Base class for validation messages reported during model analysis.
`Warning`	Lower-priority validation warning message.

Module Contents

class mbdlyb.messages.Error(message: str, fix_label: str | None = None, object_to_fix: object | None = None)

Bases: ValidationMessage

High-priority validation error message.

Indicates a critical issue that must be resolved for the model to be valid.

COLOR = 'error'

PRIORITY = 2

class mbdlyb.messages.ValidationMessage(message: str, fix_label: str | None = None, object_to_fix: object | None = None)

Base class for validation messages reported during model analysis.

ValidationMessage represents an issue found during model validation with an optional suggestion for fixing it. Messages can be sorted by priority and include references to the model object that needs attention.

Variables:

PRIORITY (int) – Class-level priority for sorting (lower is more urgent).
COLOR (str) – Color code for UI representation (e.g., ‘error’, ‘warning’).
message (str) – The validation message text.
fix_label (Optional[str]) – Label describing the suggested fix.
object_to_fix (Optional[object]) – Reference to the model object needing attention.

COLOR: str

PRIORITY: int

property color: str

Get the color code for UI representation.

Returns:: Color identifier (e.g., ‘error’, ‘warning’).
Return type:: str

fix_label: str | None

property has_object_to_fix: bool

Check if this message includes a fixable object reference.

Returns:: True if both fix_label and object_to_fix are present.
Return type:: bool

message: str

object_to_fix: object | None

property priority: int

Get the priority level for this message.

Returns:: Lower values indicate higher priority (more urgent).
Return type:: int

class mbdlyb.messages.Warning(message: str, fix_label: str | None = None, object_to_fix: object | None = None)

Bases: ValidationMessage

Lower-priority validation warning message.

Indicates a potential issue that should be reviewed but may not prevent model usage.

COLOR = 'warning'

PRIORITY = 4