galaxy.exceptions package
This module defines Galaxy’s custom exceptions.
A Galaxy exception is an exception that extends MessageException
which
defines an HTTP status code (represented by the status_code attribute) and a
default error message.
New exceptions should be defined by adding an entry to error_codes.json in this directory to define a default error message and a Galaxy “error code”. A concrete Python class should be added in this file defining an HTTP status code (as status_code) and error code (error_code) object loaded dynamically from error_codes.json.
Reflecting Galaxy’s origins as a web application, these exceptions tend to be a bit web-oriented. However this module is a dependency of modules and tools that have nothing to do with the web - keep this in mind when defining exception names and messages.
- exception galaxy.exceptions.MessageException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
Exception
Most generic Galaxy exception - indicates merely that some exceptional condition happened.
- exception galaxy.exceptions.ItemDeletionException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ObjectInvalid[source]
Bases:
Exception
Accessed object store ID is invalid
- exception galaxy.exceptions.AcceptedRetryLater(msg: str | None = None, retry_after=60)[source]
Bases:
MessageException
- exception galaxy.exceptions.NoContentException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ActionInputError(err_msg, type='error')[source]
Bases:
MessageException
- exception galaxy.exceptions.DuplicatedSlugException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.DuplicatedIdentifierException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ObjectAttributeInvalidException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ObjectAttributeMissingException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.MalformedId(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.UserInvalidRunAsException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.MalformedContents(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.UnknownContentsType(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.RequestParameterMissingException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ToolMetaParameterException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ToolMissingException(err_msg: str | None = None, type='info', tool_id=None, **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.RequestParameterInvalidException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ToolInputsNotReadyException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- error_code = ErrorCode[code=400015,message=Tool inputs not yet ready, try again later.]
- exception galaxy.exceptions.ToolInputsNotOKException(err_msg: str | None = None, type='info', *, src: str, id: int, **extra_error_info)[source]
Bases:
MessageException
- __init__(err_msg: str | None = None, type='info', *, src: str, id: int, **extra_error_info)[source]
- error_code = ErrorCode[code=400017,message=Tool inputs not in required OK state.]
- exception galaxy.exceptions.RealUserRequiredException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- error_code = ErrorCode[code=400016,message=Only real users can make this request.]
- exception galaxy.exceptions.AuthenticationFailed(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.AuthenticationRequired(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ItemAccessibilityException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ItemOwnershipException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ItemImmutableException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ConfigDoesNotAllowException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.InsufficientPermissionsException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.UserCannotRunAsException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.UserRequiredException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.AdminRequiredException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.UserActivationRequiredException(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ObjectNotFound(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
Accessed object was not found
- exception galaxy.exceptions.Conflict(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.DeprecatedMethod(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
Method (or a particular form/arg signature) has been removed and won’t be available later
- exception galaxy.exceptions.ConfigurationError[source]
Bases:
Exception
- status_code = 500
- err_code = ErrorCode[code=500003,message=Error in a configuration file.]
- exception galaxy.exceptions.InconsistentDatabase(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.InternalServerError(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ToolExecutionError(err_msg, type='error', job=None)[source]
Bases:
MessageException
- exception galaxy.exceptions.NotImplemented(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.InvalidFileFormatError(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ReferenceDataError(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.ServerNotConfiguredForRequest(err_msg: str | None = None, type='info', **extra_error_info)[source]
Bases:
MessageException
- exception galaxy.exceptions.HandlerAssignmentError(msg=None, obj=None, **kwargs)[source]
Bases:
Exception
Submodules
galaxy.exceptions.error_codes module
Defines the ErrorCode
class and instantiates concrete objects from JSON.
See the file error_codes.json for actual error code descriptions.