Skip to content

Base Framework Error

consortium.framework._core.framework_exceptions.base_framework_exception

BaseFrameworkError(message='', detail=None)

Bases: Exception

Base exception for all errors raised by the framework primitives.

Every framework level exception derives from this class so that framework errors can be caught, translated into API exceptions, and logged through a single common type.

Attributes:

Name Type Description
code str

A stable machine-readable string identifying the specific error. It lets the API layer correlate the exception with a matching API exception and HTTP status code without relying on the exception's class.

message str

A human-readable description of what went wrong and, where possible, how to resolve it.

detail dict[str, JsonValue] | None

Optional structured, machine-readable context about the error, or None when there is no such context.

code = 'BASE_FRAMEWORK_ERROR' class-attribute instance-attribute

message = message instance-attribute

detail = detail instance-attribute