Skip to content

Exceptions🔗

The earthdaily.earthone.exceptions module defines a hierarchy of exceptions for handling EarthOne API errors.

exceptions 🔗

Exceptions raised by HTTP clients.

ClientError 🔗

Bases: Exception

Base class for all client exceptions.

Source code in earthdaily/earthone/exceptions.py 
19
20
21
22
class ClientError(Exception):
    """Base class for all client exceptions."""

    pass

AuthError 🔗

Bases: ClientError

Authentication error, improperly supplied credentials.

Source code in earthdaily/earthone/exceptions.py 
25
26
27
28
class AuthError(ClientError):
    """Authentication error, improperly supplied credentials."""

    pass

OauthError 🔗

Bases: AuthError

Authentication error, failure from OAuth authentication service.

Source code in earthdaily/earthone/exceptions.py 
31
32
33
34
class OauthError(AuthError):
    """Authentication error, failure from OAuth authentication service."""

    pass

ConfigError 🔗

Bases: Exception

Configuration error during initial configuration of the library.

Source code in earthdaily/earthone/exceptions.py 
37
38
39
40
class ConfigError(Exception):
    """Configuration error during initial configuration of the library."""

    pass

ServerError 🔗

Bases: Exception

Server or service failure.

Source code in earthdaily/earthone/exceptions.py 
43
44
45
46
class ServerError(Exception):
    """Server or service failure."""

    status = 500

BadRequestError 🔗

Bases: ClientError

Client request with incorrect parameters.

Source code in earthdaily/earthone/exceptions.py 
49
50
51
52
class BadRequestError(ClientError):
    """Client request with incorrect parameters."""

    status = 400

UnauthorizedError 🔗

Bases: ClientError

Client request lacking authentication.

Source code in earthdaily/earthone/exceptions.py 
55
56
57
58
class UnauthorizedError(ClientError):
    """Client request lacking authentication."""

    status = 401

ForbiddenError 🔗

Bases: ClientError

Client request lacks necessary permissions.

Source code in earthdaily/earthone/exceptions.py 
61
62
63
64
class ForbiddenError(ClientError):
    """Client request lacks necessary permissions."""

    status = 403

NotFoundError 🔗

Bases: ClientError

Resource not found.

Source code in earthdaily/earthone/exceptions.py 
67
68
69
70
class NotFoundError(ClientError):
    """Resource not found."""

    status = 404

MethodNotAllowedError 🔗

Bases: ClientError

Requested nethod not supported by the resource.

Source code in earthdaily/earthone/exceptions.py 
73
74
75
76
class MethodNotAllowedError(ClientError):
    """Requested nethod not supported by the resource."""

    status = 405

ProxyAuthenticationRequiredError 🔗

Bases: ClientError

Client request needs proxy authentication.

Attributes🔗

status : int The status code of the error response. proxy_authenticate : Optional[str] A ProxyAuthenticate <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Proxy-Authenticate>_ header if found in the response.

Source code in earthdaily/earthone/exceptions.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
class ProxyAuthenticationRequiredError(ClientError):
    """Client request needs proxy authentication.

    Attributes
    ==========
    status : int
        The status code of the error response.
    proxy_authenticate : Optional[str]
        A `ProxyAuthenticate <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Proxy-Authenticate>`_
        header if found in the response.
    """

    status = 407

    def __init__(self, message, proxy_authenticate=None) -> None:
        super(ProxyAuthenticationRequiredError, self).__init__(message)

        self.proxy_authenticate = proxy_authenticate

ConflictError 🔗

Bases: ClientError

Client request conflicts with existing state.

Source code in earthdaily/earthone/exceptions.py 
 99
100
101
102
class ConflictError(ClientError):
    """Client request conflicts with existing state."""

    status = 409

GoneError 🔗

Bases: ClientError

Client request to a URL which has been permanently removed.

Source code in earthdaily/earthone/exceptions.py 
105
106
107
108
class GoneError(ClientError):
    """Client request to a URL which has been permanently removed."""

    status = 410

ValidationError 🔗

Bases: BadRequestError

Client request with invalid parameters.

Source code in earthdaily/earthone/exceptions.py 
111
112
113
114
class ValidationError(BadRequestError):
    """Client request with invalid parameters."""

    status = 422

RateLimitError 🔗

Bases: ClientError

Client request exceeds rate limits.

The retry_after member will contain any time limit returned in the response.

Source code in earthdaily/earthone/exceptions.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
class RateLimitError(ClientError):
    """
    Client request exceeds rate limits.

    The retry_after member will contain any time limit returned
    in the response.
    """

    status = 429

    def __init__(self, message, retry_after=None):
        """
        Construct a new instance.

        :param str message: The error message.
        :type retry_after: str or None
        :param retry_after: An indication of a
            ``retry-after`` timeout specified by the error response.
        """
        super(RateLimitError, self).__init__(message)
        self.retry_after = retry_after

__init__ 🔗

__init__(message, retry_after=None)

Construct a new instance.

:param str message: The error message. :type retry_after: str or None :param retry_after: An indication of a retry-after timeout specified by the error response.

Source code in earthdaily/earthone/exceptions.py 
127
128
129
130
131
132
133
134
135
136
137
def __init__(self, message, retry_after=None):
    """
    Construct a new instance.

    :param str message: The error message.
    :type retry_after: str or None
    :param retry_after: An indication of a
        ``retry-after`` timeout specified by the error response.
    """
    super(RateLimitError, self).__init__(message)
    self.retry_after = retry_after

RetryWithError 🔗

Bases: ClientError

Vector service query request timed out.

Source code in earthdaily/earthone/exceptions.py 
140
141
142
143
class RetryWithError(ClientError):
    """Vector service query request timed out."""

    status = 449

GatewayTimeoutError 🔗

Bases: ServerError

Timeout from the gateway after failing to route request to destination service.

Source code in earthdaily/earthone/exceptions.py 
146
147
148
149
class GatewayTimeoutError(ServerError):
    """Timeout from the gateway after failing to route request to destination service."""

    status = 504

RequestCancellationError 🔗

Bases: ClientError

Client cancelled the request and no status or response was received.

Source code in earthdaily/earthone/exceptions.py 
152
153
class RequestCancellationError(ClientError):
    """Client cancelled the request and no status or response was received."""