add support of pathlib.Path in mask, execute_batch, download_results

Author: soxofaan

openeo/rest/imagecollectionclient.py

@@ -1,4 +1,5 @@
 import datetime
+import pathlib
 import time
 import typing
 from typing import List, Dict, Union, Tuple
@@ -762,6 +763,7 @@ def mask(self, polygon: Union[Polygon, MultiPolygon,str]=None, srs="EPSG:4326",
         No data values will be left untouched by the masking operation.
 
         # TODO: just provide a single `mask` argument and detect the type: polygon or process graph
+        # TODO: also see `mask` vs `mask_polygon` processes in https://github.com/Open-EO/openeo-processes/pull/110
 
         :param polygon: A polygon, provided as a :class:`shapely.geometry.Polygon` or :class:`shapely.geometry.MultiPolygon`, or a filename pointing to a valid vector file
         :param srs: The reference system of the provided polygon, by default this is Lat Lon (EPSG:4326).
@@ -773,9 +775,11 @@ def mask(self, polygon: Union[Polygon, MultiPolygon,str]=None, srs="EPSG:4326",
         mask = None
         new_collection = None
         if polygon is not None:
-            if isinstance(polygon, str):
+            if isinstance(polygon, (str, pathlib.Path)):
+                # TODO: default to loading file client side?
+                # TODO: change read_vector to load_uploaded_files https://github.com/Open-EO/openeo-processes/pull/106
                 new_collection = self.graph_add_process('read_vector', args={
-                    'filename': polygon
+                    'filename': str(polygon)
                 })
 
                 mask = {
@@ -966,7 +970,7 @@ def tiled_viewing_service(self,**kwargs) -> Dict:
 
     def execute_batch(
             self,
-            outputfile: str, out_format: str = None,
+            outputfile: Union[str, pathlib.Path], out_format: str = None,
             print=print, max_poll_interval=60, connection_retry_interval=30,
             job_options=None, **format_options):
         """

openeo/rest/job.py

@@ -1,13 +1,14 @@
+import datetime
 import logging
+import pathlib
+import time
 import typing
 import urllib.request
-from typing import List
-import datetime
-import time
-from requests import ConnectionError
+from typing import List, Union
 
 from openeo.job import Job, JobResult
 from openeo.rest import OpenEoClientException
+from requests import ConnectionError
 
 if hasattr(typing, 'TYPE_CHECKING') and typing.TYPE_CHECKING:
     # Only import this for type hinting purposes. Runtime import causes circular dependency issues.
@@ -78,7 +79,7 @@ def list_results(self, type=None):
         # GET /jobs/{job_id}/results
         pass
 
-    def download_results(self, target):
+    def download_results(self, target: Union[str, pathlib.Path]) -> pathlib.Path:
         """ Download job results."""
         results_url = "/jobs/{}/results".format(self.job_id)
         r = self.connection.get(results_url, expected_status=200)
@@ -88,7 +89,8 @@ def download_results(self, target):
             raise OpenEoClientException("Expected 1 result file to download, but got {c}".format(c=len(links)))
         file_url = links[0]["href"]
 
-        with open(target, 'wb') as handle:
+        target = pathlib.Path(target)
+        with target.open('wb') as handle:
             response = self.connection.get(file_url, stream=True)
             for block in response.iter_content(1024):
                 if not block:
@@ -117,7 +119,8 @@ def results(self) -> List[RESTJobResult]:
         return [RESTJobResult(link['href']) for link in self.connection.job_results(self.job_id)['links']]
 
     @classmethod
-    def run_synchronous(cls, job, outputfile: str, print=print, max_poll_interval=60, connection_retry_interval=30):
+    def run_synchronous(cls, job, outputfile: Union[str, pathlib.Path],
+                        print=print, max_poll_interval=60, connection_retry_interval=30):
         job.start_job()
 
         job_id = job.job_id