Source code for dramatiq.errors

# This file is a part of Dramatiq.
# Copyright (C) 2017,2018 CLEARTYPE SRL <[email protected]>
# Dramatiq is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# Dramatiq is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <>.

[docs] class DramatiqError(Exception): # pragma: no cover """Base class for all dramatiq errors. """ def __init__(self, message): self.message = message def __str__(self): return str(self.message) or repr(self.message)
[docs] class DecodeError(DramatiqError): """Raised when a message fails to decode. """ def __init__(self, message, data, error): super().__init__(message) = data self.error = error
[docs] class BrokerError(DramatiqError): """Base class for broker-related errors. """
[docs] class ActorNotFound(BrokerError): """Raised when a message is sent to an actor that hasn't been declared. """
[docs] class QueueNotFound(BrokerError): """Raised when a message is sent to an queue that hasn't been declared. """
class QueueJoinTimeout(DramatiqError): """Raised by brokers that support joining on queues when the join operation times out. """
[docs] class ConnectionError(BrokerError): """Base class for broker connection-related errors. """
[docs] class ConnectionFailed(ConnectionError): """Raised when a broker connection could not be opened. """
[docs] class ConnectionClosed(ConnectionError): """Raised when a broker connection is suddenly closed. """
[docs] class RateLimitExceeded(DramatiqError): """Raised when a rate limit has been exceeded. """
[docs] class Retry(DramatiqError): """Actors may raise this error when they should be retried. This behaves just like any other exception from the perspective of the :class:`Retries<dramatiq.middleware.Retries>` middleware, the only difference is it doesn't get logged as an error. If the ``delay`` argument is provided, then the message will be retried after at least that amount of time (in milliseconds). """ def __init__(self, message="", delay=None): super().__init__(message) self.delay = delay