Helpers

A collection of useful convenience methods.

class odin.helpers.ValidationErrorCollection

Helper collection for collecting validation error messages and generating or raising an exception.

Usage:

errors = ValidationErrorCollection()
... # Perform validation
errors.add_message("name", "Value is required")

if errors:
    raise errors.validation_error()

add_message(field: str | BaseField, *messages)

Append validation error message(s).

add_resource_message(*messages)

Append resource level validation error message(s).

property messages: Dict[str, List[str]]

Filtered messages that strips out empty messages.

raise_if_defined()

Raise an exception if any are defined.

validation_error() → ValidationError

Generate an exception based on the validation messages added.