Components Service Errors¶
consortium.server.exceptions.service_exceptions.components_service_exceptions
¶
Exception hierarchy:
BaseServiceErrorComponentsServiceErrorComponentLoadingErrorInvalidComponentManifestFileErrorInvalidComponentPyProjectFileErrorInvalidComponentPyProjectFileTOMLErrorInvalidComponentPyProjectFileDependencyErrorInvalidComponentDirectoryStructureErrorInvalidComponentImplementationErrorIncompatibleComponentFrameworkVersionErrorComponentAlreadyRegisteredErrorDuplicateComponentLabelError
ComponentDependencyErrorComponentNotFoundErrorComponentDiscoveryFileSystemError
ComponentsServiceError(**kwargs)
¶
Bases: BaseServiceError
Base exception for all errors that occur within the components service.
Attributes:
| Name | Type | Description |
|---|---|---|
code |
A stable machine-readable string identifying the specific error. |
|
message |
str
|
A human-readable description of what went wrong and, where possible, how to resolve it. |
detail |
dict[str, JsonValue] | None
|
Optional structured context about the error, or None when there is none. |
code = 'COMPONENTS_SERVICE_ERROR'
class-attribute
instance-attribute
¶
ComponentLoadingError(**kwargs)
¶
Bases: ComponentsServiceError
Base exception for all errors that occur during the loading of a component.
code = 'COMPONENT_LOADING_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentManifestFileError(**kwargs)
¶
Bases: ComponentLoadingError
Base exception for all errors that occur due to an invalid component manifest file during component loading.
code = 'INVALID_COMPONENT_MANIFEST_FILE_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentManifestFileJSONError(component_directory)
¶
Bases: InvalidComponentManifestFileError
Raised when the component manifest file is not valid JSON during component loading.
code = 'INVALID_COMPONENT_MANIFEST_FILE_JSON_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentManifestFileSchemaError(component_directory, json_schema_error_message)
¶
Bases: InvalidComponentManifestFileError
Raised when the component manifest file does not conform to the expected JSON schema during component loading.
code = 'INVALID_COMPONENT_MANIFEST_FILE_SCHEMA_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentPyProjectFileError(**kwargs)
¶
Bases: ComponentLoadingError
Base exception for all errors that occur due to an invalid pyproject.toml file
during component loading.
code = 'INVALID_COMPONENT_PYPROJECT_FILE_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentPyProjectFileTOMLError(component_directory)
¶
Bases: ComponentLoadingError
Raised when the pyproject.toml file is not a valid TOML file during component loading.
code = 'INVALID_COMPONENT_PYPROJECT_FILE_TOML_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentPyProjectFileDependencyError(component_directory, invalid_dependency_entry)
¶
Bases: ComponentLoadingError
Raised when the pyproject.toml file contains an invalid dependency entry during
component loading.
code = 'INVALID_COMPONENT_PYPROJECT_FILE_DEPENDENCY_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentDirectoryStructureError(**kwargs)
¶
Bases: ComponentLoadingError
Base exception for all errors that occur due to an invalid component directory structure during component loading.
code = 'INVALID_COMPONENT_DIRECTORY_STRUCTURE_ERROR'
class-attribute
instance-attribute
¶
ComponentManifestFileNotFoundError(component_directory)
¶
Bases: InvalidComponentDirectoryStructureError
Raised when the component manifest file is not found in the component directory during component loading.
code = 'COMPONENT_MANIFEST_FILE_NOT_FOUND_ERROR'
class-attribute
instance-attribute
¶
ComponentEntryPointModuleNotFoundError(component_directory, entry_point_module)
¶
Bases: InvalidComponentDirectoryStructureError
Raised when the component entry point module specified in the manifest file is not found in the component directory during component loading.
code = 'COMPONENT_ENTRY_POINT_MODULE_NOT_FOUND_ERROR'
class-attribute
instance-attribute
¶
InvalidComponentImplementationError(**kwargs)
¶
Bases: ComponentLoadingError
Base exception for all errors that occur due to the component not implementing the required interface during component loading.
code = 'INVALID_COMPONENT_IMPLEMENTATION_ERROR'
class-attribute
instance-attribute
¶
ComponentSymbolNotFoundError(component_directory, entry_point_symbol, entry_point_module)
¶
Bases: InvalidComponentImplementationError
Raised when the component symbol name specified in the manifest file is not found in the component entry point module during component loading.
code = 'COMPONENT_SYMBOL_NOT_FOUND_ERROR'
class-attribute
instance-attribute
¶
ComponentInterfaceError(component_directory, entry_point_symbol)
¶
Bases: InvalidComponentImplementationError
Raised when the component class does not implement the required interface during component loading.
code = 'COMPONENT_INTERFACE_ERROR'
class-attribute
instance-attribute
¶
InternalComponentError(component_directory, internal_error_message)
¶
Bases: InvalidComponentImplementationError
Raised when an unhandled exception from within the component is raised during component loading.
code = 'INTERNAL_COMPONENT_ERROR'
class-attribute
instance-attribute
¶
IncompatibleComponentFrameworkVersionError(component_str, required_version, current_version)
¶
Bases: ComponentLoadingError
Raised when a component's required framework version is incompatible with the current framework version during component loading.
code = 'INCOMPATIBLE_COMPONENT_FRAMEWORK_VERSION_ERROR'
class-attribute
instance-attribute
¶
ComponentAlreadyRegisteredError(component_str, component_id)
¶
Bases: ComponentLoadingError
Raised when a component with the same ID is already registered in the components service during component loading.
code = 'COMPONENT_ALREADY_REGISTERED_ERROR'
class-attribute
instance-attribute
¶
DuplicateComponentLabelError(component_str, label)
¶
Bases: ComponentLoadingError
Raised when the label provided in the component's definition is already in use by another component during component loading.
code = 'DUPLICATE_COMPONENT_LABEL_ERROR'
class-attribute
instance-attribute
¶
ComponentDependencyError(**kwargs)
¶
Bases: ComponentsServiceError
Base exception for all errors that occur during the resolution of component dependencies.
code = 'COMPONENT_DEPENDENCY_ERROR'
class-attribute
instance-attribute
¶
ThirdPartyDependencyNotFoundError(component_directory, third_party_dependency_name)
¶
Bases: ComponentDependencyError
Raised when a third-party dependency required by a component is not installed during component dependency resolution.
code = 'THIRD_PARTY_DEPENDENCY_NOT_FOUND_ERROR'
class-attribute
instance-attribute
¶
IncompatibleThirdPartyDependencyVersionError(component_directory, third_party_dependency_name, required_version, installed_version)
¶
Bases: ComponentDependencyError
Raised when a third-party dependency's installed version is incompatible with the version required by the component during component dependency resolution.
code = 'INCOMPATIBLE_THIRD_PARTY_DEPENDENCY_VERSION_ERROR'
class-attribute
instance-attribute
¶
ComponentDependencyNotFoundError(component_str, missing_dependency)
¶
Bases: ComponentDependencyError
Raised when a component dependency required by the component is not found in the components service during component dependency resolution.
code = 'COMPONENT_DEPENDENCY_NOT_FOUND_ERROR'
class-attribute
instance-attribute
¶
IncompatibleComponentDependencyVersionError(component_str, incompatible_dependency, required_version, installed_version)
¶
Bases: ComponentDependencyError
Raised when a component dependency's version is incompatible with the version required by the component during component dependency resolution.
code = 'INCOMPATIBLE_COMPONENT_DEPENDENCY_VERSION_ERROR'
class-attribute
instance-attribute
¶
ComponentDependsOnInvalidComponentDependencyError(component_str, invalid_dependency)
¶
Bases: ComponentDependencyError
Raised when a component depends on another component that itself has invalid dependencies during component dependency resolution.
code = 'COMPONENT_DEPENDS_ON_INVALID_COMPONENT_DEPENDENCY_ERROR'
class-attribute
instance-attribute
¶
ComponentDependencyNotRunningError(component_str, not_running_dependency)
¶
Bases: ComponentDependencyError
Raised when a component dependency required by the component is present but not currently running during component dependency resolution.
code = 'COMPONENT_DEPENDENCY_NOT_RUNNING_ERROR'
class-attribute
instance-attribute
¶
ComponentNotFoundError(component_id)
¶
Bases: ComponentsServiceError
Raised when the requested component with the provided component ID was not found in the components service.
code = 'COMPONENT_NOT_FOUND_ERROR'
class-attribute
instance-attribute
¶
ComponentDiscoveryFileSystemError(operation, path, underlying_error)
¶
Bases: ComponentsServiceError
Raised when a recursive filesystem scan for components fails at the filesystem level.
Covers the whole-directory scan performed while discovering components (for example, scanning a framework components directory to find every plugin, agent profile, event hook, or listener profile living under it), not the loading of an individual component that has already been found. A scan failure aborts discovery entirely, so it is never one of the per-component errors collected while a directory is being loaded.