function for checking responses for errors

Author: ChristianBeilschmidt

geoengine/__init__.py

@@ -3,7 +3,7 @@
 from .auth import Session, get_session, initialize, reset
 from .error import GeoEngineException, InputException, UninitializedException, TypeException, \
     MethodNotCalledOnPlotException, MethodNotCalledOnRasterException, MethodNotCalledOnVectorException, \
-    SpatialReferenceMismatchException
+    SpatialReferenceMismatchException, check_response_for_error
 from .types import QueryRectangle
 from .workflow import WorkflowId, Workflow, workflow_by_id, register_workflow
 from .datasets import upload_dataframe, StoredDataset

geoengine/error.py

@@ -4,6 +4,8 @@
 
 from typing import Dict
 
+from requests import Response, HTTPError
+
 
 class GeoEngineException(Exception):
     '''
@@ -107,3 +109,28 @@ def __init__(self, spatial_reference_a: str, spatial_reference_b: str) -> None:
 
     def __str__(self) -> str:
         return f"Spatial reference mismatch {self.__spatial_reference_a} != {self.__spatial_reference_b}"
+
+
+def check_response_for_error(response: Response):
+    '''
+    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()
+        if 'error' in response_json:
+            # override exception with `GeoEngineException`
+            exception = GeoEngineException(response_json)
+    except Exception:  # pylint: disable=broad-except
+        pass  # ignore errors, it seemed not to be JSON
+
+    # either raise the `GeoEngineException` or any other `HTTPError`
+    raise exception

geoengine/workflow.py

@@ -26,7 +26,7 @@
 from geoengine.types import InternalDatasetId, ProvenanceOutput, QueryRectangle, ResultDescriptor
 from geoengine.auth import get_session
 from geoengine.error import GeoEngineException, MethodNotCalledOnPlotException, MethodNotCalledOnRasterException, \
-    MethodNotCalledOnVectorException, SpatialReferenceMismatchException
+    MethodNotCalledOnVectorException, SpatialReferenceMismatchException, check_response_for_error
 from geoengine.datasets import StoredDataset, UploadId
 
 
@@ -164,10 +164,10 @@ def get_dataframe(self, bbox: QueryRectangle) -> gpd.GeoDataFrame:
         wfs_url = self.__get_wfs_url(bbox)
 
         data_response = req.get(wfs_url, headers=session.auth_header)
-        data = data_response.json()
 
-        if 'error' in data:
-            raise GeoEngineException(data)
+        check_response_for_error(data_response)
+
+        data = data_response.json()
 
         def geo_json_with_time_to_geopandas(geo_json):
             '''
@@ -249,23 +249,9 @@ def wms_get_map_as_image(self, bbox: QueryRectangle, colorizer_min_max: Tuple[fl
         wms_request = self.__wms_get_map_request(bbox, colorizer_min_max)
         response = req.Session().send(wms_request)
 
-        try:
-            image = Image.open(BytesIO(response.content))
-            return image
-        except Exception as pil_exception:  # pylint: disable=broad-except
-            exception = pil_exception
+        check_response_for_error(response)
 
-        # try to parse it as a Geo Engine error
-        try:
-            response_json = response.json()
-            if 'error' in response_json:
-                # override exception with `GeoEngineException`
-                exception = GeoEngineException(response_json)
-        except Exception:  # pylint: disable=broad-except
-            pass  # ignore errors, it seemed not to be JSON
-
-        # we either raise the Geo Engine exception or the PIL exception
-        raise exception
+        return Image.open(BytesIO(response.content))
 
     def __wms_get_map_request(self,
                               bbox: QueryRectangle,
@@ -342,10 +328,11 @@ def plot_chart(self, bbox: QueryRectangle) -> VegaLite:
 
         plot_url = f'{session.server_url}/plot/{self}?bbox={spatial_bounds}&time={time}&spatialResolution={resolution}'
 
-        response = req.get(plot_url, headers=session.auth_header).json()
+        response = req.get(plot_url, headers=session.auth_header)
 
-        if 'error' in response:
-            raise GeoEngineException(response)
+        check_response_for_error(response)
+
+        response = response.json()
 
         vega_spec = json.loads(response['data']['vegaString'])
 
@@ -430,10 +417,11 @@ def save_as_dataset(self, bbox: QueryRectangle, name: str, description: str = ''
             url=f'{session.server_url}/datasetFromWorkflow/{self.__workflow_id}',
             json=request_body,
             headers=session.auth_header,
-        ).json()
+        )
 
-        if 'error' in response:
-            raise GeoEngineException(response)
+        check_response_for_error(response)
+
+        response = response.json()
 
         return StoredDataset(
             dataset_id=InternalDatasetId.from_response(response['dataset']),

tests/test_wfs.py

@@ -439,7 +439,7 @@ def test_wfs_error(self):
                   },
                   request_headers={'Authorization': 'Bearer e327d9c3-a4f3-4bd7-a5e1-30b26cae8064'})
 
-            m.get('http://mock-instance/wfs',
+            m.get('http://mock-instance/wfs/956d3656-2d14-5951-96a0-f962b92371cd',
                   json={
                       "error": "Operator",
                       "message": 'Operator: Could not open gdal dataset for file path '

tests/test_wms.py

@@ -213,7 +213,7 @@ def test_image_error(self):
             # Unfortunately, we need a separate library to catch the request from the WMS call
             m.get(
                 # pylint: disable=line-too-long
-                'http://mock-instance/wms?service=WMS&version=1.3.0&request=GetMap&layers=5b9508a8-bd34-5a1c-acd6-75bb832d2d38&time=2004-04-01T12%3A00%3A00.000%2B00%3A00&crs=EPSG%3A4326&bbox=-90.0%2C-180.0%2C90.0%2C180.0&width=200&height=100&format=image%2Fpng&styles=custom%3A%7B%22type%22%3A+%22linearGradient%22%2C+%22breakpoints%22%3A+%5B%7B%22value%22%3A+0%2C+%22color%22%3A+%5B0%2C+0%2C+0%2C+255%5D%7D%2C+%7B%22value%22%3A+255%2C+%22color%22%3A+%5B255%2C+255%2C+255%2C+255%5D%7D%5D%2C+%22noDataColor%22%3A+%5B0%2C+0%2C+0%2C+0%5D%2C+%22defaultColor%22%3A+%5B0%2C+0%2C+0%2C+0%5D%7D',
+                'http://mock-instance/wms/5b9508a8-bd34-5a1c-acd6-75bb832d2d38?service=WMS&version=1.3.0&request=GetMap&layers=5b9508a8-bd34-5a1c-acd6-75bb832d2d38&time=2004-04-01T12%3A00%3A00.000%2B00%3A00&crs=EPSG%3A4326&bbox=-90.0%2C-180.0%2C90.0%2C180.0&width=200&height=100&format=image%2Fpng&styles=custom%3A%7B%22type%22%3A+%22linearGradient%22%2C+%22breakpoints%22%3A+%5B%7B%22value%22%3A+0%2C+%22color%22%3A+%5B0%2C+0%2C+0%2C+255%5D%7D%2C+%7B%22value%22%3A+255%2C+%22color%22%3A+%5B255%2C+255%2C+255%2C+255%5D%7D%5D%2C+%22noDataColor%22%3A+%5B0%2C+0%2C+0%2C+0%5D%2C+%22defaultColor%22%3A+%5B0%2C+0%2C+0%2C+0%5D%7D',
                 json={
                     "error": "Operator",
                     "message": 'Operator: Could not open gdal dataset for file path '