Source code for google.auth.exceptions
# Copyright 2016 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Exceptions used in the google.auth package."""
[docs]
class GoogleAuthError(Exception):
"""Base class for all google.auth errors."""
def __init__(self, *args, **kwargs):
super(GoogleAuthError, self).__init__(*args)
retryable = kwargs.get("retryable", False)
self._retryable = retryable
@property
def retryable(self):
return self._retryable
[docs]
class TransportError(GoogleAuthError):
"""Used to indicate an error occurred during an HTTP request."""
[docs]
class RefreshError(GoogleAuthError):
"""Used to indicate that an refreshing the credentials' access token
failed."""
[docs]
class UserAccessTokenError(GoogleAuthError):
"""Used to indicate ``gcloud auth print-access-token`` command failed."""
[docs]
class DefaultCredentialsError(GoogleAuthError):
"""Used to indicate that acquiring default credentials failed."""
[docs]
class MutualTLSChannelError(GoogleAuthError):
"""Used to indicate that mutual TLS channel creation is failed, or mutual
TLS channel credentials is missing or invalid."""
[docs]
class ClientCertError(GoogleAuthError):
"""Used to indicate that client certificate is missing or invalid."""
@property
def retryable(self):
return False
[docs]
class OAuthError(GoogleAuthError):
"""Used to indicate an error occurred during an OAuth related HTTP
request."""
[docs]
class ReauthFailError(RefreshError):
"""An exception for when reauth failed."""
def __init__(self, message=None, **kwargs):
super(ReauthFailError, self).__init__(
"Reauthentication failed. {0}".format(message), **kwargs
)
[docs]
class ReauthSamlChallengeFailError(ReauthFailError):
"""An exception for SAML reauth challenge failures."""
[docs]
class InvalidResource(DefaultCredentialsError, ValueError):
"""An exception for URL error."""
[docs]
class InvalidOperation(DefaultCredentialsError, ValueError):
"""An exception for invalid operation."""
[docs]
class InvalidValue(DefaultCredentialsError, ValueError):
"""Used to wrap general ValueError of python."""
[docs]
class InvalidType(DefaultCredentialsError, TypeError):
"""Used to wrap general TypeError of python."""
[docs]
class OSError(DefaultCredentialsError, EnvironmentError):
"""Used to wrap EnvironmentError(OSError after python3.3)."""
