common.lib.exceptions

  1import traceback
  2
  3
  4class FourcatException(Exception):
  5    """
  6    Base 4CAT exception class
  7    """
  8
  9    def __init__(self, message="", frame=None):
 10        """
 11        Exception constructor
 12
 13        Takes an optional extra argument, `frame`, the traceback frame of the
 14        offending code.
 15
 16        :param str message:  Exception message
 17        :param frame:  Traceback frame. If omitted, the frame is extrapolated
 18        from the context.
 19        """
 20        super().__init__(message)
 21        if not frame:
 22            frame = traceback.extract_stack()[-2]
 23
 24        self.frame = frame
 25
 26
 27class ConfigException(FourcatException):
 28    """
 29    Raised when there is a problem with the configuration settings.
 30    """
 31    pass
 32
 33
 34class QueueException(FourcatException):
 35    """
 36    General Queue Exception - only children are to be used
 37    """
 38    pass
 39
 40
 41class ProcessorException(FourcatException):
 42    """
 43    Raise if processor throws an exception
 44    """
 45    pass
 46
 47
 48class MapItemException(ProcessorException):
 49    """
 50    Raise if processor throws an exception
 51    """
 52    pass
 53
 54
 55class MappedItemIncompleteException(MapItemException):
 56    """
 57    Raise if processor encounters a mapped item and map_missing = 'abort'
 58    """
 59    pass
 60
 61
 62class DataSetException(FourcatException):
 63    """
 64    Raise if dataset throws an exception
 65    """
 66    pass
 67
 68
 69class DataSetNotFoundException(DataSetException):
 70    """
 71    Raise if dataset does not exist
 72    """
 73    pass
 74
 75
 76class CsvDialectException(FourcatException):
 77    """
 78    Raised when there is a problem with the configuration settings.
 79    """
 80    pass
 81
 82
 83class JobClaimedException(QueueException):
 84    """
 85    Raise if job is claimed, but is already marked as such
 86    """
 87    pass
 88
 89
 90class JobAlreadyExistsException(QueueException):
 91    """
 92    Raise if a job is created, but a job with the same type/remote_id combination already exists
 93    """
 94    pass
 95
 96
 97class JobNotFoundException(QueueException):
 98    """
 99    Raise if trying to instantiate a job with an ID that is not valid
100    """
101    pass
102
103
104class QueryException(FourcatException):
105    """
106    Raise if there is an issue with form input while creating a dataset
107    """
108    pass
109
110
111class QueryParametersException(QueryException):
112    """
113    Raise if a dataset query has invalid parameters
114    """
115    pass
116
117
118class QueryNeedsExplicitConfirmationException(QueryException):
119    """
120    Raise if a dataset query needs confirmation
121    """
122    pass
123
124
125class QueryNeedsFurtherInputException(QueryException):
126    """
127    Raise if a dataset requires further user input
128    """
129
130    def __init__(self, config):
131        super(QueryNeedsFurtherInputException, self).__init__()
132        self.config = config
133
134
135class WorkerInterruptedException(FourcatException):
136    """
137    Raise when killing a worker before it's done with its job
138    """
139    pass
140
141
142class ProcessorInterruptedException(WorkerInterruptedException):
143    """
144    Raise when killing a processor before it's done with its job
145    """
146    pass
147
148
149class DatabaseQueryInterruptedException(WorkerInterruptedException):
150    """
151    Raise when interrupting a DB query before it has finished
152    """
153    pass