Module geoengine.error

Package errors and backend mapped error types

'''
Package errors and backend mapped error types
'''

from typing import Dict, Union
from typing_extensions import TypedDict
from requests import Response, HTTPError


class GeoEngineExceptionResponse(TypedDict):
    '''
    The error response from the Geo Engine
    '''

    error: str
    message: str


class GeoEngineException(Exception):
    '''
    Base class for exceptions from the backend
    '''

    error: str
    message: str

    def __init__(self, response: Union[GeoEngineExceptionResponse, Dict[str, str]]) -> None:
        super().__init__()

        self.error = response['error'] if 'error' in response else '?'
        self.message = response['message'] if 'message' in response else '?'

    def __str__(self) -> str:
        return f"{self.error}: {self.message}"


class InputException(Exception):
    '''
    Exception that is thrown on wrong inputs
    '''

    __message: str

    def __init__(self, message: str) -> None:
        super().__init__()

        self.__message = message

    def __str__(self) -> str:
        return f"{self.__message}"


class UninitializedException(Exception):
    '''
    Exception that is thrown when there is no connection to the backend but methods on the backend are called
    '''

    def __str__(self) -> str:
        return "You have to call `initialize` before using other functionality"


class NoAdminSessionException(Exception):
    '''
    Exception that is thrown when there is no admin session token supplied
    '''

    def __str__(self) -> str:
        return "You need to specify an admin token when initializing the session"


class TypeException(Exception):
    '''
    Exception on wrong types of input
    '''

    __message: str

    def __init__(self, message: str) -> None:
        super().__init__()

        self.__message = message

    def __str__(self) -> str:
        return f"{self.__message}"


class ModificationNotOnLayerDbException(Exception):
    '''
    Exception that is when trying to modify layers that are not part of the layerdb
    '''

    __message: str

    def __init__(self, message: str) -> None:
        super().__init__()

        self.__message = message

    def __str__(self) -> str:
        return f"{self.__message}"

# TODO: remove methods and forbid calling methods in the first place


class MethodNotCalledOnRasterException(Exception):
    '''
    Exception for calling a raster method on a, e.g., vector layer
    '''

    def __str__(self) -> str:
        return "Only allowed to call method on raster result"


# TODO: remove methods and forbid calling methods in the first place
class MethodNotCalledOnVectorException(Exception):
    '''
    Exception for calling a vector method on a, e.g., raster layer
    '''

    def __str__(self) -> str:
        return "Only allowed to call method on vector result"


# TODO: remove methods and forbid calling methods in the first place
class MethodNotCalledOnPlotException(Exception):
    '''
    Exception for calling a plot method on a, e.g., vector layer
    '''

    def __str__(self) -> str:
        return "Only allowed to call method on plot result"


class SpatialReferenceMismatchException(Exception):
    '''
    Exception for calling a method on a workflow with a query rectangle that has a different spatial reference
    '''

    def __init__(self, spatial_reference_a: str, spatial_reference_b: str) -> None:
        super().__init__()

        self.__spatial_reference_a = spatial_reference_a
        self.__spatial_reference_b = spatial_reference_b

    def __str__(self) -> str:
        return f"Spatial reference mismatch {self.__spatial_reference_a} != {self.__spatial_reference_b}"


def check_response_for_error(response: Response) -> None:
    '''
    Checks a `Response` for an error and raises it if there is one.
    '''

    try:
        response.raise_for_status()

        return  # no error
    except HTTPError as http_error:
        exception = http_error

    # try to parse it as a Geo Engine error
    try:
        response_json = response.json()
    except Exception:  # pylint: disable=broad-except
        pass  # ignore errors, it seemed not to be JSON
    else:
        # if parsing was successful, raise the appropriate exception
        if 'error' in response_json:
            raise GeoEngineException(response_json)

    # raise `HTTPError` if `GeoEngineException` or any other was not thrown
    raise exception

Functions

def check_response_for_error(response: requests.models.Response) ‑> None

Checks a Response for an error and raises it if there is one.

Expand source code

def check_response_for_error(response: Response) -> None:
    '''
    Checks a `Response` for an error and raises it if there is one.
    '''

    try:
        response.raise_for_status()

        return  # no error
    except HTTPError as http_error:
        exception = http_error

    # try to parse it as a Geo Engine error
    try:
        response_json = response.json()
    except Exception:  # pylint: disable=broad-except
        pass  # ignore errors, it seemed not to be JSON
    else:
        # if parsing was successful, raise the appropriate exception
        if 'error' in response_json:
            raise GeoEngineException(response_json)

    # raise `HTTPError` if `GeoEngineException` or any other was not thrown
    raise exception

Classes

class GeoEngineException (response: Union[GeoEngineExceptionResponse, Dict[str, str]])

Base class for exceptions from the backend

Expand source code

class GeoEngineException(Exception):
    '''
    Base class for exceptions from the backend
    '''

    error: str
    message: str

    def __init__(self, response: Union[GeoEngineExceptionResponse, Dict[str, str]]) -> None:
        super().__init__()

        self.error = response['error'] if 'error' in response else '?'
        self.message = response['message'] if 'message' in response else '?'

    def __str__(self) -> str:
        return f"{self.error}: {self.message}"

Ancestors

• builtins.Exception
• builtins.BaseException

Class variables

var error : str

var message : str

class GeoEngineExceptionResponse (*args, **kwargs)

The error response from the Geo Engine

Expand source code

class GeoEngineExceptionResponse(TypedDict):
    '''
    The error response from the Geo Engine
    '''

    error: str
    message: str

Ancestors

• builtins.dict

Class variables

var error : str

var message : str

class InputException (message: str)

Exception that is thrown on wrong inputs

Expand source code

class InputException(Exception):
    '''
    Exception that is thrown on wrong inputs
    '''

    __message: str

    def __init__(self, message: str) -> None:
        super().__init__()

        self.__message = message

    def __str__(self) -> str:
        return f"{self.__message}"

Ancestors

• builtins.Exception
• builtins.BaseException

class MethodNotCalledOnPlotException (*args, **kwargs)

Exception for calling a plot method on a, e.g., vector layer

Expand source code

class MethodNotCalledOnPlotException(Exception):
    '''
    Exception for calling a plot method on a, e.g., vector layer
    '''

    def __str__(self) -> str:
        return "Only allowed to call method on plot result"

Ancestors

• builtins.Exception
• builtins.BaseException

class MethodNotCalledOnRasterException (*args, **kwargs)

Exception for calling a raster method on a, e.g., vector layer

Expand source code

class MethodNotCalledOnRasterException(Exception):
    '''
    Exception for calling a raster method on a, e.g., vector layer
    '''

    def __str__(self) -> str:
        return "Only allowed to call method on raster result"

Ancestors

• builtins.Exception
• builtins.BaseException

class MethodNotCalledOnVectorException (*args, **kwargs)

Exception for calling a vector method on a, e.g., raster layer

Expand source code

class MethodNotCalledOnVectorException(Exception):
    '''
    Exception for calling a vector method on a, e.g., raster layer
    '''

    def __str__(self) -> str:
        return "Only allowed to call method on vector result"

Ancestors

• builtins.Exception
• builtins.BaseException

class ModificationNotOnLayerDbException (message: str)

Exception that is when trying to modify layers that are not part of the layerdb

Expand source code

class ModificationNotOnLayerDbException(Exception):
    '''
    Exception that is when trying to modify layers that are not part of the layerdb
    '''

    __message: str

    def __init__(self, message: str) -> None:
        super().__init__()

        self.__message = message

    def __str__(self) -> str:
        return f"{self.__message}"

Ancestors

• builtins.Exception
• builtins.BaseException

class NoAdminSessionException (*args, **kwargs)

Exception that is thrown when there is no admin session token supplied

Expand source code

class NoAdminSessionException(Exception):
    '''
    Exception that is thrown when there is no admin session token supplied
    '''

    def __str__(self) -> str:
        return "You need to specify an admin token when initializing the session"

Ancestors

• builtins.Exception
• builtins.BaseException

class SpatialReferenceMismatchException (spatial_reference_a: str, spatial_reference_b: str)

Exception for calling a method on a workflow with a query rectangle that has a different spatial reference

Expand source code

class SpatialReferenceMismatchException(Exception):
    '''
    Exception for calling a method on a workflow with a query rectangle that has a different spatial reference
    '''

    def __init__(self, spatial_reference_a: str, spatial_reference_b: str) -> None:
        super().__init__()

        self.__spatial_reference_a = spatial_reference_a
        self.__spatial_reference_b = spatial_reference_b

    def __str__(self) -> str:
        return f"Spatial reference mismatch {self.__spatial_reference_a} != {self.__spatial_reference_b}"

Ancestors

• builtins.Exception
• builtins.BaseException

class TypeException (message: str)

Exception on wrong types of input

Expand source code

class TypeException(Exception):
    '''
    Exception on wrong types of input
    '''

    __message: str

    def __init__(self, message: str) -> None:
        super().__init__()

        self.__message = message

    def __str__(self) -> str:
        return f"{self.__message}"

Ancestors

• builtins.Exception
• builtins.BaseException

class UninitializedException (*args, **kwargs)

Exception that is thrown when there is no connection to the backend but methods on the backend are called

Expand source code

class UninitializedException(Exception):
    '''
    Exception that is thrown when there is no connection to the backend but methods on the backend are called
    '''

    def __str__(self) -> str:
        return "You have to call `initialize` before using other functionality"

Ancestors

• builtins.Exception
• builtins.BaseException