schema_salad.exceptions

Shared Exception classes.

Exceptions

`SchemaSaladException`	Base class for all schema-salad exceptions.
`SchemaException`	Indicates error with the provided schema definition.
`ValidationException`	Indicates error with document against the provided schema.
`ClassValidationException`	Indicates error with document against the provided schema.

Functions

to_one_line_messages(exc)

Module Contents

exception schema_salad.exceptions.SchemaSaladException(msg, sl=None, children=None, bullet_for_children='', detailed_message=None)

Bases: Exception

Inheritance diagram of schema_salad.exceptions.SchemaSaladException

Base class for all schema-salad exceptions.

Parameters:

msg (str)
sl (schema_salad.sourceline.SourceLine | None)
children (collections.abc.Sequence[SchemaSaladException] | None)
bullet_for_children (str)
detailed_message (str | None)

message: Final

detailed_message: Final = None

file: str | None = None

start: tuple[int, int] | None = None

end: tuple[int, int] | None = None

is_warning: bool = False

bullet: str = ''

propagate_sourceline()

Return type:: None

as_warning()

Return type:: SchemaSaladException

with_sourceline(sl)

Use the provided SourceLine to set the causal location.

Parameters:: sl (schema_salad.sourceline.SourceLine | None)
Return type:: SchemaSaladException

leaves()

Return the list of all the exceptions at the tips of the tree.

Return type:: list[SchemaSaladException]

prefix()

Return type:: str

summary(level=0, with_bullet=False)

Parameters:

level (int)
with_bullet (bool)

Return type:

str

__str__()

Convert to a string using pretty_str().

Return type:: str

pretty_str(level=0)

Parameters:: level (int)
Return type:: str

exception schema_salad.exceptions.SchemaException(msg, sl=None, children=None, bullet_for_children='', detailed_message=None)

Bases: SchemaSaladException

Inheritance diagram of schema_salad.exceptions.SchemaException

Indicates error with the provided schema definition.

Parameters:

msg (str)
sl (schema_salad.sourceline.SourceLine | None)
children (collections.abc.Sequence[SchemaSaladException] | None)
bullet_for_children (str)
detailed_message (str | None)

exception schema_salad.exceptions.ValidationException(msg, sl=None, children=None, bullet_for_children='', detailed_message=None)

Bases: SchemaSaladException

Inheritance diagram of schema_salad.exceptions.ValidationException

Indicates error with document against the provided schema.

Parameters:

msg (str)
sl (schema_salad.sourceline.SourceLine | None)
children (collections.abc.Sequence[SchemaSaladException] | None)
bullet_for_children (str)
detailed_message (str | None)

exception schema_salad.exceptions.ClassValidationException(msg, sl=None, children=None, bullet_for_children='', detailed_message=None)

Bases: ValidationException

Inheritance diagram of schema_salad.exceptions.ClassValidationException

Indicates error with document against the provided schema.

Parameters:

msg (str)
sl (schema_salad.sourceline.SourceLine | None)
children (collections.abc.Sequence[SchemaSaladException] | None)
bullet_for_children (str)
detailed_message (str | None)

schema_salad.exceptions.to_one_line_messages(exc)

Parameters:: exc (SchemaSaladException)
Return type:: str