Source code for pygeoapi.process.base

# =================================================================
#
# Authors: Tom Kralidis <tomkralidis@gmail.com>
#
# Copyright (c) 2022 Tom Kralidis
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================

import logging
from typing import Any, Tuple

LOGGER = logging.getLogger(__name__)


[docs]class BaseProcessor: """generic Processor ABC. Processes are inherited from this class"""
[docs] def __init__(self, processor_def: dict, process_metadata: dict): """ Initialize object :param processor_def: processor definition :param process_metadata: process metadata `dict` :returns: pygeoapi.processor.base.BaseProvider """ self.name = processor_def['name'] self.metadata = process_metadata
[docs] def execute(self, data: dict) -> Tuple[str, Any]: """ execute the process :param data: Dict with the input data that the process needs in order to execute :returns: tuple of MIME type and process response """ raise NotImplementedError()
[docs] def __repr__(self): return f'<BaseProcessor> {self.name}'
[docs]class ProcessorGenericError(Exception): """processor generic error""" pass
[docs]class ProcessorExecuteError(ProcessorGenericError): """query / backend error""" pass