minor finetuning

issue #499

Author: VictorVerhaert

openeo/rest/connection.py

@@ -1577,7 +1577,7 @@ def execute(
         timeout: Optional[int] = None,
         validate: Optional[bool] = None,
         auto_decode: bool = True,
-    ):
+    ) -> Union[dict, requests.Response]:
         """
         Execute a process graph synchronously and return the result. If the result is a JSON object, it will be parsed.
 
@@ -1587,7 +1587,7 @@ def execute(
             (overruling the connection's ``auto_validate`` setting).
         :param auto_decode: Boolean flag to enable/disable automatic JSON decoding of the response. Defaults to True.
 
-        :return: if possible parsed JSON response, otherwise raw response
+        :return: parsed JSON response as a dict if auto_decode is True, otherwise response object
         """
         pg_with_metadata = self._build_request_with_process_graph(process_graph=process_graph)
         self._preflight_validation(pg_with_metadata=pg_with_metadata, validate=validate)

openeo/rest/datacube.py

@@ -18,6 +18,7 @@
 from typing import Any, Dict, Iterable, List, Optional, Sequence, Tuple, Union, Callable
 
 import numpy as np
+import requests
 import shapely.geometry
 import shapely.geometry.base
 from shapely.geometry import MultiPolygon, Polygon, mapping
@@ -2306,15 +2307,15 @@ def save_user_defined_process(
             returns=returns, categories=categories, examples=examples, links=links,
         )
 
-    def execute(self, *, validate: Optional[bool] = None, auto_decode: bool = True) -> dict:
+    def execute(self, *, validate: Optional[bool] = None, auto_decode: bool = True) -> Union[dict, requests.Response]:
         """
         Execute a process graph synchronously and return the result. If the result is a JSON object, it will be parsed.
 
         :param validate: Optional toggle to enable/prevent validation of the process graphs before execution
             (overruling the connection's ``auto_validate`` setting).
         :param auto_decode: Boolean flag to enable/disable automatic JSON decoding of the response. Defaults to True.
 
-        :return: if possible parsed JSON response, otherwise raw response
+        :return: parsed JSON response as a dict if auto_decode is True, otherwise response object
         """
         return self._connection.execute(self.flat_graph(), validate=validate, auto_decode=auto_decode)
 

tests/rest/datacube/test_datacube.py

@@ -573,6 +573,7 @@ def test_execute_tiff_raw(connection, requests_mock):
     requests_mock.get(API_URL + "/collections/S2", json={})
     requests_mock.post(API_URL + "/result", content=b"tiffdata")
     result = connection.load_collection("S2").execute(auto_decode=False)
+    assert isinstance(result, requests.Response)
     assert result.content == b"tiffdata"
 
 @pytest.mark.parametrize(["filename", "expected_format"], [