pumpwood_communication.exceptions

  1"""
  2Define PumpWood exceptions to be treated as API errors.
  3
  4Define especific errors for PumpWood plataform. These errors will be treated
  5and will not result in default 500 errors
  6"""
  7
  8
  9class PumpWoodException(Exception): # NOQA
 10    """Special exception used in Pumpowod Systems.
 11
 12    It permits treatment of raises on applications serializing response
 13    using to_dict function and return status code as `status_code`
 14    attribute value.
 15    """
 16
 17    status_code: int = 400
 18    """PumpWoodException will return status 400 on Pumpwood backend."""
 19
 20    message: str
 21    """Message associated with raise."""
 22
 23    payload: dict
 24    """
 25    Dictionary payload that will be returned by to_dict funcion and format
 26    message string.
 27    """
 28
 29    def __repr__(self):
 30        """@private."""
 31        message_fmt = self.format_message()
 32        template = "{class_name}[status_code={status_code}]: " + \
 33            "{message_fmt}\nerror payload={payload}"
 34        return template.format(
 35            class_name=self.__class__.__name__,
 36            status_code=self.status_code,
 37            message_fmt=message_fmt,
 38            payload=self.payload)
 39
 40    def __str__(self):
 41        """@private."""
 42        message_fmt = self.format_message()
 43        template = "{class_name}[status_code={status_code}]: " + \
 44            "{message_fmt}\nerror payload={payload}"
 45        return template.format(
 46            class_name=self.__class__.__name__,
 47            status_code=self.status_code,
 48            message_fmt=message_fmt,
 49            payload=self.payload)
 50
 51    def __init__(self, message: str, payload: dict = {}, status_code=None):
 52        """__init__.
 53
 54        Args:
 55            message:
 56                Message that will be formated using payload
 57                information using `{key}` to replace information.
 58            payload:
 59                Payload data passed as a dictionary, it will be returned
 60                in payload at `to_dict` funcion and used to format message.
 61            status_code:
 62                Change the default status code of the exception.
 63        """
 64        Exception.__init__(self)
 65        self.message = message
 66        if status_code is not None:
 67            self.status_code = status_code
 68        self.payload = payload
 69
 70    def format_message(self) -> str:
 71        """Format exception message using payload data.
 72
 73        Substitute placeholders at exception message with payload.
 74
 75        Returns:
 76            Return a string of message with placeholders substituted with
 77            payload data.
 78        """
 79        try:
 80            return self.message.format(**self.payload)
 81        except Exception:
 82            return self.message + "\n** format error **"
 83
 84    def to_dict(self) -> dict:
 85        """Serialize Exception object to return as reponse.
 86
 87        Returns:
 88            Return a dictionary with keys:
 89            - **payload [dict]:** Payload associated with raise.
 90            - **type [str]:** Return name of the class of the Exception.
 91            - **message_not_fmt [str]:** Return msg without replacemnt of the
 92                msg with payload information.
 93            - **message [str]:** Return msg formated with payload information.
 94        """
 95        message_fmt = self.format_message()
 96        rv = {
 97            "payload": self.payload,
 98            "type": self.__class__.__name__,
 99            "message_not_fmt": self.message,
100            "message": message_fmt}
101        return rv
102
103
104class PumpWoodDataLoadingException(PumpWoodException):
105    """Problem when loading data at dataloaders and to_load models."""
106
107    pass
108
109
110class PumpWoodDatabaseError(PumpWoodException):
111    """Errors raised by Postgres and not treated by other handlers."""
112
113    pass
114
115
116class PumpWoodUniqueDatabaseError(PumpWoodException):
117    """Unique errors raised by Postgres."""
118
119    pass
120
121
122class PumpWoodDataTransformationException(PumpWoodException):
123    """Problem when transforming model data."""
124
125    pass
126
127
128class PumpWoodWrongParameters(PumpWoodException):
129    """Raise for errors in object deserialization."""
130
131    pass
132
133
134class PumpWoodObjectSavingException(PumpWoodException):
135    """Raise for errors in object deserialization."""
136
137    pass
138
139
140class PumpWoodObjectDeleteException(PumpWoodException):
141    """Raise for errors in object deserialization."""
142
143    pass
144
145
146class PumpWoodActionArgsException(PumpWoodException):
147    """Missing arguments to perform action."""
148
149    pass
150
151
152class PumpWoodUnauthorized(PumpWoodException):
153    """User Unauthorized to perform action."""
154
155    status_code = 401
156
157
158class PumpWoodForbidden(PumpWoodException):
159    """Action not permited."""
160
161    status_code = 403
162
163
164class PumpWoodObjectDoesNotExist(PumpWoodException):
165    """Object not found in database."""
166
167    status_code = 404
168
169
170class PumpWoodQueryException(PumpWoodException):
171    """Problem when querying data, like wrong fields or operators."""
172
173    pass
174
175
176class PumpWoodIntegrityError(PumpWoodException):
177    """Problem when saving data due to IntegrityError."""
178
179    pass
180
181
182class PumpWoodNotImplementedError(PumpWoodException):
183    """Problem when saving data due to NotImplementedError."""
184
185    pass
186
187
188class PumpWoodMicroserviceUnavailableError(PumpWoodException):
189    """Problem when trying to use a microservice that was not deployied."""
190
191    pass
192
193
194class PumpWoodMFAError(PumpWoodException):
195    """Problem when using MFA."""
196
197    pass
198
199
200class PumpWoodJSONLoadError(PumpWoodException):
201    """Problem loading json data from request."""
202
203    pass
204
205
206class PumpWoodOtherException(PumpWoodException):
207    """Other untreated error on server."""
208
209    status_code = 500
210
211    def __repr__(self):
212        """__repr__."""
213        template = "{class_name}[status_code={status_code}]: " + \
214            "{message}\nerror payload={payload}"
215        return template.format(
216            class_name=self.__class__.__name__,
217            status_code=self.status_code, message=self.message,
218            payload=self.payload,)
219
220    def __str__(self):
221        """__str__."""
222        template = "{class_name}[status_code={status_code}]: " + \
223            "{message}\nerror payload={payload}"
224        return template.format(
225            class_name=self.__class__.__name__,
226            status_code=self.status_code, message=self.message,
227            payload=self.payload,)
228
229    def __init__(self, message: str, payload: dict = {}, status_code=None):
230        """__init__."""
231        Exception.__init__(self)
232        # Limit size of the error
233        self.message = message[:1000]
234        if status_code is not None:
235            self.status_code = status_code
236        self.payload = payload
237
238    def to_dict(self):
239        """Serialize exception to dictionary."""
240        rv = {
241            "payload": self.payload,
242            "type": self.__class__.__name__,
243            "message": self.message}
244        return rv
245
246
247class AirflowMicroServiceException(PumpWoodException):
248    """Raises from AirflowMicroService."""
249
250    pass
251
252
253exceptions_dict = {
254    "PumpWoodException": PumpWoodException,
255    "PumpWoodDataLoadingException": PumpWoodDataLoadingException,
256    "PumpWoodDatabaseError": PumpWoodDatabaseError,
257    "PumpWoodDataTransformationException": PumpWoodDataTransformationException,
258    "PumpWoodWrongParameters": PumpWoodWrongParameters,
259    "PumpWoodObjectSavingException": PumpWoodObjectSavingException,
260    "PumpWoodObjectDeleteException": PumpWoodObjectDeleteException,
261    "PumpWoodActionArgsException": PumpWoodActionArgsException,
262    "PumpWoodUnauthorized": PumpWoodUnauthorized,
263    "PumpWoodForbidden": PumpWoodForbidden,
264    "PumpWoodObjectDoesNotExist": PumpWoodObjectDoesNotExist,
265    "PumpWoodQueryException": PumpWoodQueryException,
266    "PumpWoodIntegrityError": PumpWoodIntegrityError,
267    "PumpWoodNotImplementedError": PumpWoodNotImplementedError,
268    "PumpWoodMicroserviceUnavailableError":
269        PumpWoodMicroserviceUnavailableError,
270    "PumpWoodMFAError": PumpWoodMFAError,
271    "PumpWoodOtherException": PumpWoodOtherException,
272    "AirflowMicroServiceException": AirflowMicroServiceException,
273    "PumpWoodUniqueDatabaseError": PumpWoodUniqueDatabaseError
274}
275"""
276Dictionary used by backends/microservice to treat Pumpwood exceptions and
277re-raise them exception.
278"""