Plugins Framework Errors¶
consortium.framework._core.framework_exceptions.plugins_framework_exceptions
¶
PluginsFrameworkError(message=None, detail=None, **kwargs)
¶
Bases: ComponentsFrameworkError
Base exception for all errors that occur within the plugins framework.
code = 'PLUGINS_FRAMEWORK_ERROR'
class-attribute
instance-attribute
¶
PluginConfigurationError(message=None, detail=None, **kwargs)
¶
Bases: ComponentConfigurationError, PluginsFrameworkError
Base exception for all errors that occur during the configuration of a particular plugin.
code = 'PLUGIN_CONFIGURATION_ERROR'
class-attribute
instance-attribute
¶
InvalidPluginConfigurationParameterTypeError(component_str, parameter_name, parameter_type)
¶
Bases: InvalidComponentConfigurationParameterTypeError, PluginConfigurationError
Raised when a plugin's configuration parameter is not of the expected type during plugin configuration.
code = 'INVALID_PLUGIN_CONFIGURATION_PARAMETER_TYPE_ERROR'
class-attribute
instance-attribute
¶
MissingPluginConfigurationParameterError(component_str, parameter_name)
¶
Bases: MissingComponentConfigurationParameterError, PluginConfigurationError
Raised when a required parameter is not declared in a plugin's definition during plugin configuration.
code = 'MISSING_PLUGIN_CONFIGURATION_PARAMETER_ERROR'
class-attribute
instance-attribute
¶
EmptyPluginLabelError(component_filepath)
¶
Bases: EmptyComponentLabelError, PluginConfigurationError
Raised when an empty label is provided in a plugin's definition during plugin configuration.
code = 'EMPTY_PLUGIN_LABEL_ERROR'
class-attribute
instance-attribute
¶
InvalidPluginVersionError(component_str, version)
¶
Bases: InvalidComponentVersionError, PluginConfigurationError
Raised when the plugin version string provided in the plugin's definition is not a valid version string according to PEP 440 during plugin configuration.
code = 'INVALID_PLUGIN_VERSION_ERROR'
class-attribute
instance-attribute
¶
InvalidFrameworkVersionSpecifierError(component_str, framework_version_specifier)
¶
Bases: InvalidFrameworkVersionSpecifierError, PluginConfigurationError
Raised when the framework version specifier string provided in the plugin's definition is not a valid version specifier string as defined in PEP 440 during plugin configuration.
code = 'INVALID_FRAMEWORK_VERSION_SPECIFIER_ERROR'
class-attribute
instance-attribute
¶
InvalidPluginDependencyVersionSpecifierError(component_str, invalid_dependency_entry)
¶
Bases: InvalidComponentDependencyVersionSpecifierError, PluginConfigurationError
Raised when a plugin dependency version specifier string provided in the plugin's definition is not a valid version specifier string as defined in PEP 440 during plugin configuration.
code = 'INVALID_PLUGIN_DEPENDENCY_VERSION_SPECIFIER_ERROR'
class-attribute
instance-attribute
¶
PluginOperationError(message=None, detail=None, **kwargs)
¶
Bases: ComponentOperationError, PluginsFrameworkError
Base exception for all errors that occur during the operation of a particular plugin.
code = 'PLUGIN_OPERATION_ERROR'
class-attribute
instance-attribute
¶
PluginStartError(component_str, error_message, detail)
¶
Bases: ComponentStartError, PluginOperationError
Raised when a plugin fails to start during plugin operation.
code = 'PLUGIN_START_ERROR'
class-attribute
instance-attribute
¶
PluginRuntimeError(component_str, error_message, detail)
¶
Bases: ComponentRuntimeError, PluginOperationError
Raised when a plugin encounters an unhandled error at runtime during plugin operation.
code = 'PLUGIN_RUNTIME_ERROR'
class-attribute
instance-attribute
¶
PluginStopError(component_str, error_message, detail)
¶
Bases: ComponentStopError, PluginOperationError
Raised when a plugin fails to stop during plugin operation.
code = 'PLUGIN_STOP_ERROR'
class-attribute
instance-attribute
¶
PluginFatalError(component_str, operation, phase, underlying_exception)
¶
Bases: ComponentFatalError, PluginOperationError
Raised when an unhandled exception escapes one of a plugin's life cycle hooks, terminating the plugin fatally during plugin operation.
PluginStateError(message=None, detail=None, **kwargs)
¶
Bases: ComponentStateError, PluginsFrameworkError
Base exception for all errors that occur due to invalid plugin status during plugin operation.
code = 'PLUGIN_STATE_ERROR'
class-attribute
instance-attribute
¶
PluginNotRunningError(component_str)
¶
Bases: ComponentNotRunningError, PluginStateError
Raised when an operation is attempted on a plugin that requires the plugin to already be running but the plugin is not running.
code = 'PLUGIN_NOT_RUNNING_ERROR'
class-attribute
instance-attribute
¶
PluginAlreadyRunningError(component_str)
¶
Bases: ComponentAlreadyRunningError, PluginStateError
Raised when an operation is attempted on a plugin that requires the plugin to not already be started or running but the plugin is already started or running.