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
 47class AnnotationException(FourcatException):
 48    """
 49    Raise for exceptions with setting/getting annotations.
 50    """
 51    pass
 52
 53class MapItemException(ProcessorException):
 54    """
 55    Raise if processor throws an exception
 56    """
 57    pass
 58
 59
 60class MappedItemIncompleteException(MapItemException):
 61    """
 62    Raise if processor encounters a mapped item and map_missing = 'abort'
 63    """
 64    pass
 65
 66
 67class DataSetException(FourcatException):
 68    """
 69    Raise if dataset throws an exception
 70    """
 71    pass
 72
 73
 74class DataSetNotFoundException(DataSetException):
 75    """
 76    Raise if dataset does not exist
 77    """
 78    pass
 79
 80
 81class CsvDialectException(FourcatException):
 82    """
 83    Raised when there is a problem with the configuration settings.
 84    """
 85    pass
 86
 87
 88class JobClaimedException(QueueException):
 89    """
 90    Raise if job is claimed, but is already marked as such
 91    """
 92    pass
 93
 94
 95class JobAlreadyExistsException(QueueException):
 96    """
 97    Raise if a job is created, but a job with the same type/remote_id combination already exists
 98    """
 99    pass
100
101
102class JobNotFoundException(QueueException):
103    """
104    Raise if trying to instantiate a job with an ID that is not valid
105    """
106    pass
107
108
109class QueryException(FourcatException):
110    """
111    Raise if there is an issue with form input while creating a dataset
112    """
113    pass
114
115
116class QueryParametersException(QueryException):
117    """
118    Raise if a dataset query has invalid parameters
119    """
120    pass
121
122
123class QueryNeedsExplicitConfirmationException(QueryException):
124    """
125    Raise if a dataset query needs confirmation
126    """
127    pass
128
129
130class QueryNeedsFurtherInputException(QueryException):
131    """
132    Raise if a dataset requires further user input
133    """
134
135    def __init__(self, config):
136        super(QueryNeedsFurtherInputException, self).__init__()
137        self.config = config
138
139
140class WorkerInterruptedException(FourcatException):
141    """
142    Raise when killing a worker before it's done with its job
143    """
144    pass
145
146
147class ProcessorInterruptedException(WorkerInterruptedException):
148    """
149    Raise when killing a processor before it's done with its job
150    """
151    pass
152
153
154class DatabaseQueryInterruptedException(WorkerInterruptedException):
155    """
156    Raise when interrupting a DB query before it has finished
157    """
158    pass