exceptions

Module of all Merlin-specific exception types.

BackendNotSupportedError

Bases: Exception

Exception to signal that the provided backend is not supported by Merlin.

Source code in merlin/exceptions/__init__.py

class BackendNotSupportedError(Exception):
    """
    Exception to signal that the provided backend is not supported by Merlin.
    """

    def __init__(self, message):
        super().__init__(message)

EntityManagerNotSupportedError

Bases: Exception

Exception to signal that the provided entity manager is not supported by Merlin.

Source code in merlin/exceptions/__init__.py

class EntityManagerNotSupportedError(Exception):
    """
    Exception to signal that the provided entity manager is not supported by Merlin.
    """

EntityNotFoundError

Bases: Exception

Fallback error for entities that can't be found.

Source code in merlin/exceptions/__init__.py

class EntityNotFoundError(Exception):
    """
    Fallback error for entities that can't be found.
    """

HardFailException

Bases: Exception

Exception for fatal Merlin errors. Should cause workflow to terminate.

Source code in merlin/exceptions/__init__.py

class HardFailException(Exception):
    """
    Exception for fatal Merlin errors. Should cause
    workflow to terminate.
    """

    def __init__(self):
        super().__init__()

InvalidChainException

Bases: Exception

Exception for invalid Merlin step Directed Acyclic Graphs (DAGs).

Source code in merlin/exceptions/__init__.py

class InvalidChainException(Exception):
    """
    Exception for invalid Merlin step Directed Acyclic Graphs (DAGs).
    """

    def __init__(self):
        super().__init__()

MerlinInvalidStatusRendererError

Bases: Exception

Exception to signal that an invalid status renderer was provided.

Source code in merlin/exceptions/__init__.py

class MerlinInvalidStatusRendererError(Exception):
    """
    Exception to signal that an invalid status renderer was provided.
    """

    def __init__(self, message):
        super().__init__(message)

MerlinInvalidTaskServerError

Bases: Exception

Exception to signal that an invalid task server was provided.

Source code in merlin/exceptions/__init__.py

class MerlinInvalidTaskServerError(Exception):
    """
    Exception to signal that an invalid task server was provided.
    """

    def __init__(self, message):
        super().__init__(message)

MerlinWorkerFormatterNotSupportedError

Bases: Exception

Exception to signal that the provided worker formatter is not supported by Merlin.

Source code in merlin/exceptions/__init__.py

class MerlinWorkerFormatterNotSupportedError(Exception):
    """
    Exception to signal that the provided worker formatter is not supported by Merlin.
    """

MerlinWorkerHandlerNotSupportedError

Bases: Exception

Exception to signal that the provided worker handler is not supported by Merlin.

Source code in merlin/exceptions/__init__.py

class MerlinWorkerHandlerNotSupportedError(Exception):
    """
    Exception to signal that the provided worker handler is not supported by Merlin.
    """

MerlinWorkerLaunchError

Bases: Exception

Exception to signal that an there was a problem when launching workers.

Source code in merlin/exceptions/__init__.py

class MerlinWorkerLaunchError(Exception):
    """
    Exception to signal that an there was a problem when launching workers.
    """

MerlinWorkerNotSupportedError

Bases: Exception

Exception to signal that the provided worker is not supported by Merlin.

Source code in merlin/exceptions/__init__.py

class MerlinWorkerNotSupportedError(Exception):
    """
    Exception to signal that the provided worker is not supported by Merlin.
    """

NoWorkersException

Bases: Exception

Exception to signal that no workers were started to process a non-empty queue(s).

Source code in merlin/exceptions/__init__.py

class NoWorkersException(Exception):
    """
    Exception to signal that no workers were started
    to process a non-empty queue(s).
    """

    def __init__(self, message):
        super().__init__(message)

RestartException

Bases: Exception

Exception to signal that a step needs to call the restart command if present , else retry.

Source code in merlin/exceptions/__init__.py

class RestartException(Exception):
    """
    Exception to signal that a step needs to call
    the restart command if present , else retry.
    """

    def __init__(self, message):
        super().__init__(message)

RetryException

Bases: Exception

Exception to signal that a step needs to be retried.

Source code in merlin/exceptions/__init__.py

class RetryException(Exception):
    """
    Exception to signal that a step needs to be
    retried.
    """

    def __init__(self):
        super().__init__()

RunNotFoundError

Bases: EntityNotFoundError

Exception to signal that the run you were looking for cannot be found in Merlin's database.

Source code in merlin/exceptions/__init__.py

class RunNotFoundError(EntityNotFoundError):
    """
    Exception to signal that the run you were looking for cannot be found in
    Merlin's database.
    """

SoftFailException

Bases: Exception

Exception for non-fatal Merlin errors. Workflow should continue.

Source code in merlin/exceptions/__init__.py

class SoftFailException(Exception):
    """
    Exception for non-fatal Merlin errors. Workflow
    should continue.
    """

    def __init__(self):
        super().__init__()

StudyNotFoundError

Bases: EntityNotFoundError

Exception to signal that the study you were looking for cannot be found in Merlin's database.

Source code in merlin/exceptions/__init__.py

class StudyNotFoundError(EntityNotFoundError):
    """
    Exception to signal that the study you were looking for cannot be found in
    Merlin's database.
    """

UnsupportedDataModelError

Bases: Exception

Exception to signal that the data model you're trying to use is not supported.

Source code in merlin/exceptions/__init__.py

class UnsupportedDataModelError(Exception):
    """
    Exception to signal that the data model you're trying to use is not supported.
    """

WorkerNotFoundError

Bases: EntityNotFoundError

Exception to signal that the worker you were looking for cannot be found in Merlin's database.

Source code in merlin/exceptions/__init__.py

class WorkerNotFoundError(EntityNotFoundError):
    """
    Exception to signal that the worker you were looking for cannot be found in
    Merlin's database.
    """