Components Framework Errors¶
consortium.framework._core.framework_exceptions.components_framework_exceptions
¶
ComponentsFrameworkError(message=None, detail=None, **kwargs)
¶
Bases: BaseFrameworkError
Base exception for all errors that occur within the components framework.
code = 'COMPONENTS_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
ComponentConfigurationError(message=None, detail=None, **kwargs)
¶
Bases: ComponentsFrameworkError
Base exception for all errors that occur during the configuration of a particular component.
code = 'COMPONENT_CONFIGURATION_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentConfigurationParameterTypeError(component_str, parameter_name, parameter_type)
¶
Bases: ComponentConfigurationError
Raised when a component's configuration parameter is not of the expected type during component configuration.
code = 'INVALID_COMPONENT_CONFIGURATION_PARAMETER_TYPE_ERROR'
class-attribute
instance-attribute
¶
MissingComponentConfigurationParameterError(component_str, parameter_name)
¶
Bases: ComponentConfigurationError
Raised when a required parameter is not declared in a component's definition during component configuration.
code = 'MISSING_COMPONENT_CONFIGURATION_PARAMETER_ERROR'
class-attribute
instance-attribute
¶
EmptyComponentLabelError(component_filepath)
¶
Bases: ComponentConfigurationError
Raised when an empty label is provided in a component's definition during component configuration.
code = 'EMPTY_COMPONENT_LABEL_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentVersionError(component_str, version)
¶
Bases: ComponentConfigurationError
Raised when the component version string provided in the component's definition is not a valid version string according to PEP 440 during component configuration.
code = 'INVALID_COMPONENT_VERSION_ERROR'
class-attribute
instance-attribute
¶
InvalidFrameworkVersionSpecifierError(component_str, framework_version_specifier)
¶
Bases: ComponentConfigurationError
Raised when the framework version specifier string provided in the component's definition is not a valid version specifier string as defined in PEP 440 during component configuration.
code = 'INVALID_FRAMEWORK_VERSION_SPECIFIER_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentDependencyVersionSpecifierError(component_str, invalid_dependency_entry)
¶
Bases: ComponentConfigurationError
Raised when a component dependency version specifier string provided in the component's definition is not a valid version specifier string as defined in PEP 440 during component configuration.
code = 'INVALID_COMPONENT_DEPENDENCY_VERSION_SPECIFIER_ERROR'
class-attribute
instance-attribute
¶
ComponentOperationError(message=None, detail=None, **kwargs)
¶
Bases: ComponentsFrameworkError
Base exception for all errors that occur during the operation of a particular component.
code = 'COMPONENT_OPERATION_ERROR'
class-attribute
instance-attribute
¶
ComponentStartError(component_str, error_message, detail)
¶
Bases: ComponentOperationError
Raised when a component fails to start during component operation.
code = 'COMPONENT_START_ERROR'
class-attribute
instance-attribute
¶
ComponentRuntimeError(component_str, error_message, detail)
¶
Bases: ComponentOperationError
Raised when a component encounters an unhandled error at runtime during component operation.
code = 'COMPONENT_RUNTIME_ERROR'
class-attribute
instance-attribute
¶
ComponentStopError(component_str, error_message, detail)
¶
Bases: ComponentOperationError
Raised when a component fails to stop during component operation.
code = 'COMPONENT_STOP_ERROR'
class-attribute
instance-attribute
¶
ComponentFatalError(component_str, operation, phase, underlying_exception)
¶
Bases: ComponentOperationError
Raised when an unhandled exception escapes one of a component's life cycle hooks, terminating the component fatally during component operation.
ComponentStateError(message=None, detail=None, **kwargs)
¶
Bases: ComponentsFrameworkError
Base exception for all errors that occur due to invalid component status during component operation.
code = 'COMPONENT_STATE_ERROR'
class-attribute
instance-attribute
¶
ComponentNotRunningError(component_str)
¶
Bases: ComponentStateError
Raised when an operation is attempted on a component that requires the component to already be running but the component is not running.
code = 'COMPONENT_NOT_RUNNING_ERROR'
class-attribute
instance-attribute
¶
ComponentAlreadyRunningError(component_str)
¶
Bases: ComponentStateError
Raised when an operation is attempted on a component that requires the component to not already be started or running but the component is already started or running.