Exceptions

class encord.exceptions.ExceptionContext(timestamp=<factory>)

@dataclass
class ExceptionContext:
    timestamp: str = field(default_factory=lambda: datetime.now(tz=timezone.utc).isoformat())

    def __str__(self):
        return " ".join(
            f"{object_field.name}={getattr(self, object_field.name)!r}"
            for object_field in fields(self)
            if getattr(self, object_field.name) is not None
        )

exception encord.exceptions.EncordException(message, context=None)

class EncordException(Exception):
    """Base class for all exceptions."""

    def __init__(self, message: str, context: Optional[ExceptionContext] = None):
        super().__init__(message)
        self.message = message
        self.context = context if context is not None else ExceptionContext()

    def __str__(self):
        return f"{self.message} {self.context}"

encord.exceptions.CordException

exception encord.exceptions.InitialisationError(message, context=None)

class InitialisationError(EncordException):
    """Exception thrown when API key fails to initialise."""

    pass

exception encord.exceptions.AuthenticationError(message, context=None)

class AuthenticationError(EncordException):
    """Exception thrown when API key fails authentication."""

    pass

exception encord.exceptions.AuthorisationError(message, context=None)

class AuthorisationError(EncordException):
    """
    Exception thrown when access is unauthorised.
    (E.g. access to a data asset or method).
    """

    pass

exception encord.exceptions.ResourceNotFoundError(message, context=None)

class ResourceNotFoundError(EncordException):
    """
    Exception thrown when a requested resource is not found.
    (E.g. label, data asset).
    """

    pass

exception encord.exceptions.TimeOutError(message, context=None)

class TimeOutError(EncordException):
    """Exception thrown when a request times out."""

    pass

exception encord.exceptions.RequestException(message, context=None)

class RequestException(EncordException):
    """Ambiguous exception while handling request."""

    pass

exception encord.exceptions.UnknownException(message, context=None)

class UnknownException(EncordException):
    """Unknown error."""

    pass

exception encord.exceptions.InvalidDateFormatError(message, context=None)

class InvalidDateFormatError(EncordException):
    """Invalid date format error"""

    pass

exception encord.exceptions.MethodNotAllowedError(message, context=None)

class MethodNotAllowedError(EncordException):
    """Exception thrown when HTTP method is not allowed."""

    pass

exception encord.exceptions.OperationNotAllowed(message, context=None)

class OperationNotAllowed(EncordException):
    """
    Exception thrown when a read/write operation is not allowed.
    The API key blocks the operation.
    """

    pass

exception encord.exceptions.AnswerDictionaryError(message, context=None)

class AnswerDictionaryError(EncordException):
    """
    Exception thrown when answer dictionaries are incomplete.
    Occurs when an object or classification is missing.
    """

    pass

exception encord.exceptions.CorruptedLabelError(message, context=None)

class CorruptedLabelError(EncordException):
    """
    Exception thrown when a label is corrupted.
    (E.g. the frame labels have more frames than the video).
    """

    pass

exception encord.exceptions.FileTypeNotSupportedError(message, context=None)

class FileTypeNotSupportedError(EncordException):
    """
    Exception thrown when a file type is not supported.
    Supported file types are: image/jpeg, image/png, video/webm, video/mp4.
    """

    pass

exception encord.exceptions.FileSizeNotSupportedError(message, context=None)

class FileSizeNotSupportedError(EncordException):
    """
    Exception thrown when the combined size of the input files is larger than the supported limit.
    """

    pass

class FeatureDoesNotExistError(EncordException):

class FeatureDoesNotExistError(EncordException):
    """
    If a feature uid does not exist in a given project ontology.
    """

    pass

exception encord.exceptions.ModelWeightsInconsistentError(message, context=None)

class ModelWeightsInconsistentError(EncordException):
    """
    Exception thrown when an attempted model training iteration has a different
    type of weights than what is recorded (i.e. if type of model_hash (uid) is faster_rcnn,
    but is attempted trained with different model weights).
    """

    pass

exception encord.exceptions.ModelFeaturesInconsistentError(message, context=None)

class ModelFeaturesInconsistentError(EncordException):
    """
    If a feature type is different than what is supported by the model (e.g. if
    creating a classification model using a bounding box).
    """

    pass

class UploadOperationNotSupportedError(EncordException):

class UploadOperationNotSupportedError(EncordException):
    """Exception thrown when trying to upload a video/image group to non-Encord storage dataset"""

    pass

exception encord.exceptions.DetectionRangeInvalidError(message, context=None)

class DetectionRangeInvalidError(EncordException):
    """
    Exception thrown when a detection range is invalid.
    (E.g. negative or higher than num frames in video).
    """

    pass

exception encord.exceptions.InvalidAlgorithmError(message, context=None)

class InvalidAlgorithmError(EncordException):
    """Exception thrown when invalid labeling algorithm name is sent."""

    pass

exception encord.exceptions.ResourceExistsError(message, context=None)

class ResourceExistsError(EncordException):
    """
    Exception thrown when trying to re-create a resource.
    Avoids overriding existing work.
    """

    pass

exception encord.exceptions.DuplicateSshKeyError(message, context=None)

class DuplicateSshKeyError(EncordException):
    """
    Exception thrown when using an SSH key that was added twice to the platform.
    """

    pass

exception encord.exceptions.SshKeyNotFound(message, context=None)

class SshKeyNotFound(EncordException):
    """
    Exception thrown when using an SSH key that was not added to the platform.
    """

exception encord.exceptions.InvalidArgumentsError(message, context=None)

class InvalidArgumentsError(EncordException):
    """Exception thrown when the arguments are invalid."""

    pass

exception encord.exceptions.GenericServerError(message, context=None)

class GenericServerError(EncordException):
    """
    The server has reported an error which is not recognised by this SDK version. Try upgrading the SDK version to
    see the precise error that is reported.
    """

    pass

exception encord.exceptions.CloudUploadError(message, context=None)

class CloudUploadError(EncordException):
    """
    The upload to the cloud was not successful
    """

    pass

exception encord.exceptions.MultiLabelLimitError(message, maximum_labels_allowed, context=None)

class MultiLabelLimitError(EncordException):
    """
    Too many labels were requested
    """

    def __init__(self, message, maximum_labels_allowed: int, context: Optional[ExceptionContext] = None):
        super().__init__(message=message, context=context)
        self.maximum_labels_allowed = maximum_labels_allowed

exception encord.exceptions.LabelRowError(message, context=None)

class LabelRowError(EncordException):
    """An error thrown when the construction of a LabelRow class is invalid."""

    pass

exception encord.exceptions.OntologyError(message, context=None)

class OntologyError(EncordException):
    """An error thrown when using the ontology class with an error."""

    pass

exception encord.exceptions.WrongProjectTypeError(message, context=None)

class WrongProjectTypeError(CordException):
    """
    An error thrown when project type does not match the operation
    E.g. when TMS2 specific operations are attempted on non-TMS2 project
    """