exceptions.py

class BciPyCoreException(Exception):
    """BciPy Core Exception.

    Thrown when an error occurs specific to BciPy core concepts.
    """

    def __init__(self, message, errors=None):
        super().__init__(message)
        self.message = message
        self.errors = errors


class SignalException(BciPyCoreException):
    """
    Signal Exception.

    Thrown when signal module encounters an error.
    """

    def __init__(self, message, errors=None):
        super().__init__(message)
        self.errors = errors


class FieldException(BciPyCoreException):
    """Field Exception.

    Thrown when there is an exception relating to experimental fields.
    """
    ...


class ExperimentException(BciPyCoreException):
    """Experiment Exception.

    Thrown when there is an exception relating to experiments.
    """
    ...


class UnregisteredExperimentException(ExperimentException):
    """Unregistered Experiment.

    Thrown when experiment is not registered in the provided experiment path.
    """

    ...


class UnregisteredFieldException(FieldException):
    """Unregistered Field.

    Thrown when field is not registered in the provided field path.
    """

    ...


class InvalidExperimentException(ExperimentException):
    """Invalid Experiment Exception.

    Thrown when providing experiment data in the incorrect format.
    """

    ...


class InvalidFieldException(FieldException):
    """Invalid Field Exception.

    Thrown when providing field data in the incorrect format.
    """

    ...


class UnsupportedResponseType(BciPyCoreException):
    """Unsupported ResponseType

    Thrown when attempting to set the response type of a language model to an
    unsupported value."""
    ...


class TaskConfigurationException(BciPyCoreException):
    """Task Configuration Exception.

    Thrown when attempting to run a task with invalid configurations"""
    ...


class KenLMInstallationException(BciPyCoreException):
    """KenLM Installation Exception.

    Thrown when attempting to import kenlm without installing the module"""
    ...