Source code for mindmeld.exceptions

# -*- coding: utf-8 -*-
#
# Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
# 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.

"""This module contains exceptions used by the mindmeld package."""


class MindMeldVersionWarning(UserWarning):
    pass


class MindMeldError(Exception):
    def __init__(self, *args):
        super().__init__(*args)
        self.message = args[0] if len(args) > 0 else None


class BadMindMeldRequestError(MindMeldError):
    status_code = 400

    def __init__(self, message, status_code=None, payload=None):
        super().__init__(message)
        self.message = message
        if status_code is not None:
            self.status_code = status_code
        self.payload = payload

    def to_dict(self):
        obj = dict(self.payload or ())
        obj["error"] = self.message
        return obj


class EmbeddingDownloadError(MindMeldError):
    pass


class AllowedNlpClassesKeyError(MindMeldError):
    pass


class UnconstrainedMaskError(MindMeldError):
    pass


class InvalidMaskError(MindMeldError):
    pass


class ClassifierLoadError(MindMeldError):
    pass


class ProcessorError(MindMeldError):
    """An exception which indicates an error with a processor."""

    pass


class ParserTimeout(MindMeldError):
    """An exception for when parsing takes an unexpected length of time"""

    pass


class MarkupError(MindMeldError):
    pass


class SystemEntityMarkupError(MarkupError):
    pass


class SystemEntityResolutionError(MindMeldError):
    """An exception representing an error resolving a system entity"""

    pass


class KnowledgeBaseError(MindMeldError):
    """An exception for unexpected error from knowledge base."""

    pass


class ElasticsearchVersionError(MindMeldError):
    """An exception for when the user would like to use funtionality not
    available with their version of ElasticSearch."""

    pass


class ElasticsearchKnowledgeBaseConnectionError(KnowledgeBaseError):
    """An exception for problem connecting to knowledge base."""

    def __init__(self, es_host):

        self.es_host = es_host
        if (not es_host) or (not es_host[0]):
            self.message = (
                "Unable to connect to Elasticsearch for knowledge base. Please"
                " verify your connection to localhost."
            )
        else:
            es_host = [host["host"] for host in es_host]
            self.message = (
                "Unable to connect to knowledge base. Please verify"
                " your connection to: {hosts}.".format(hosts=", ".join(es_host))
            )
        super().__init__(self.message)


class EntityResolverError(MindMeldError):
    """An exception for unexpected error from entity resolver."""

    pass


class ElasticsearchConnectionError(EntityResolverError):
    """An exception for connection error to Elasticsearch for entity resolver"""

    def __init__(self, es_host):
        self.es_host = es_host
        if (not es_host) or (not es_host[0]):
            self.message = (
                "Unable to connect to Elasticsearch for entity resolution. "
                "Please verify your connection to localhost."
            )
        else:
            es_host = [host["host"] for host in es_host]
            self.message = (
                "Unable to connect to Elasticsearch for entity resolution. "
                "Please verify your connection to: {hosts}.".format(
                    hosts=", ".join(es_host)
                )
            )


class AuthNotFoundError(MindMeldError):
    pass


class MindMeldVersionError(MindMeldError):
    pass


class MindMeldImportError(MindMeldError):
    pass