# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.
#
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you 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.
from typing import Any, Dict, Type, Union
__all__ = [
"ImproperlyConfigured",
"OpenSearchException",
"SerializationError",
"TransportError",
"NotFoundError",
"ConflictError",
"RequestError",
"ConnectionError",
"SSLError",
"ConnectionTimeout",
"AuthenticationException",
"AuthorizationException",
"OpenSearchDslException",
"UnknownDslObject",
"ValidationException",
"IllegalOperation",
"OpenSearchWarning",
"OpenSearchDeprecationWarning",
]
[docs]class OpenSearchException(Exception):
"""
Base class for all exceptions raised by this package's operations (doesn't
apply to :class:`~opensearchpy.ImproperlyConfigured`).
"""
[docs]class SerializationError(OpenSearchException):
"""
Data passed in failed to serialize properly in the ``Serializer`` being
used.
"""
[docs]class TransportError(OpenSearchException):
"""
Exception raised when OpenSearch returns a non-OK (>=400) HTTP status code. Or when
an actual connection error happens; in that case the ``status_code`` will
be set to ``'N/A'``.
"""
@property
def status_code(self) -> Union[str, int]:
"""
The HTTP status code of the response that precipitated the error or
``'N/A'`` if not applicable.
"""
return self.args[0] # type: ignore
@property
def error(self) -> str:
"""A string error message."""
return self.args[1] # type: ignore
@property
def info(self) -> Union[Dict[str, Any], Exception, Any]:
"""
Dict of returned error info from OpenSearch, where available, underlying
exception when not.
"""
return self.args[2]
[docs] def __str__(self) -> str:
cause = ""
try:
if self.info and isinstance(self.info, dict) and "error" in self.info:
error = self.info["error"]
if isinstance(error, dict):
root_cause = error["root_cause"][0]
cause = ", ".join(
filter(
None,
[
repr(root_cause["reason"]),
root_cause.get("resource.id"),
root_cause.get("resource.type"),
],
)
)
else:
cause = repr(self.info["error"])
except LookupError:
pass
msg = ", ".join(filter(None, [str(self.status_code), repr(self.error), cause]))
return "%s(%s)" % (self.__class__.__name__, msg)
[docs]class ConnectionError(TransportError):
"""
Error raised when there was an exception while talking to OpenSearch. Original
exception from the underlying :class:`~opensearchpy.Connection`
implementation is available as ``.info``.
"""
[docs] def __str__(self) -> str:
return "ConnectionError(%s) caused by: %s(%s)" % (
self.error,
self.info.__class__.__name__,
self.info,
)
[docs]class SSLError(ConnectionError):
"""Error raised when encountering SSL errors."""
[docs]class ConnectionTimeout(ConnectionError):
"""A network timeout. Doesn't cause a node retry by default."""
[docs] def __str__(self) -> str:
return "ConnectionTimeout caused by - %s(%s)" % (
self.info.__class__.__name__,
self.info,
)
[docs]class NotFoundError(TransportError):
"""Exception representing a 404 status code."""
[docs]class ConflictError(TransportError):
"""Exception representing a 409 status code."""
[docs]class RequestError(TransportError):
"""Exception representing a 400 status code."""
[docs]class AuthenticationException(TransportError):
"""Exception representing a 401 status code."""
[docs]class AuthorizationException(TransportError):
"""Exception representing a 403 status code."""
[docs]class OpenSearchDslException(Exception):
"""Base class for all OpenSearchDsl exceptions"""
[docs]class UnknownDslObject(OpenSearchDslException):
"""Exception representing UnknownDSLObject"""
[docs]class ValidationException(ValueError, OpenSearchDslException):
"""Exception representing Validation Error"""
[docs]class IllegalOperation(OpenSearchDslException):
"""Exception representing IllegalOperation"""
[docs]class OpenSearchWarning(Warning):
"""Warning that is raised when a deprecated option
or incorrect usage is flagged via the 'Warning' HTTP header.
"""
# Alias of 'OpenSearchWarning' for backwards compatibility.
# Additional functionality was added to the 'Warning' HTTP header
# not related to deprecations.
OpenSearchDeprecationWarning = OpenSearchWarning
# more generic mappings from status_code to python exceptions
HTTP_EXCEPTIONS: Dict[int, Type[OpenSearchException]] = {
400: RequestError,
401: AuthenticationException,
403: AuthorizationException,
404: NotFoundError,
409: ConflictError,
}