Synchronize max_poll_interval/connection_retry_interval arguments

Author: soxofaan

openeo/rest/__init__.py

@@ -6,6 +6,10 @@
 DEFAULT_DOWNLOAD_CHUNK_SIZE = 10_000_000  # 10MB
 
 
+DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX = 60
+DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL = 30
+DEFAULT_JOB_STATUS_POLL_SOFT_ERROR_MAX = 10
+
 class OpenEoClientException(BaseOpenEoException):
     """Base class for OpenEO client exceptions"""
     pass

openeo/rest/datacube.py

@@ -46,7 +46,13 @@
     metadata_from_stac,
 )
 from openeo.processes import ProcessBuilder
-from openeo.rest import BandMathException, OpenEoClientException, OperatorException
+from openeo.rest import (
+    DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
+    DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+    BandMathException,
+    OpenEoClientException,
+    OperatorException,
+)
 from openeo.rest._datacube import (
     THIS,
     UDF,
@@ -2497,8 +2503,8 @@ def execute_batch(
         plan: Optional[str] = None,
         budget: Optional[float] = None,
         print: typing.Callable[[str], None] = print,
-        max_poll_interval: float = 60,
-        connection_retry_interval: float = 30,
+        max_poll_interval: float = DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+        connection_retry_interval: float = DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
         additional: Optional[dict] = None,
         job_options: Optional[dict] = None,
         validate: Optional[bool] = None,
@@ -2525,6 +2531,8 @@ def execute_batch(
         :param show_error_logs: whether to automatically print error logs when the batch job failed.
         :param log_level: Optional minimum severity level for log entries that the back-end should keep track of.
             One of "error" (highest severity), "warning", "info", and "debug" (lowest severity).
+        :param max_poll_interval: maximum number of seconds to sleep between job status polls
+        :param connection_retry_interval: how long to wait when status poll failed due to connection issue
 
         .. versionchanged:: 0.32.0
             Added ``auto_add_save_result`` option

openeo/rest/job.py

@@ -20,6 +20,9 @@
 from openeo.internal.warnings import deprecated, legacy_alias
 from openeo.rest import (
     DEFAULT_DOWNLOAD_CHUNK_SIZE,
+    DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
+    DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+    DEFAULT_JOB_STATUS_POLL_SOFT_ERROR_MAX,
     JobFailedException,
     OpenEoApiError,
     OpenEoApiPlainError,
@@ -223,16 +226,16 @@ def run_synchronous(
         self,
         outputfile: Union[str, Path, None] = None,
         print=print,
-        max_poll_interval=60,
-        connection_retry_interval=30,
+        max_poll_interval: float = DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+        connection_retry_interval: float = DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
         show_error_logs: bool = True,
     ) -> BatchJob:
         """
         Start the job, wait for it to finish and download result
 
         :param outputfile: The path of a file to which a result can be written
         :param print: print/logging function to show progress/status
-        :param max_poll_interval: maximum number of seconds to sleep between status polls
+        :param max_poll_interval: maximum number of seconds to sleep between job status polls
         :param connection_retry_interval: how long to wait when status poll failed due to connection issue
         :param show_error_logs: whether to automatically print error logs when the batch job failed.
 
@@ -253,16 +256,16 @@ def run_synchronous(
     def start_and_wait(
         self,
         print=print,
-        max_poll_interval: int = 60,
-        connection_retry_interval: int = 30,
-        soft_error_max=10,
+        max_poll_interval: float = DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+        connection_retry_interval: float = DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
+        soft_error_max: int = DEFAULT_JOB_STATUS_POLL_SOFT_ERROR_MAX,
         show_error_logs: bool = True,
     ) -> BatchJob:
         """
         Start the batch job, poll its status and wait till it finishes (or fails)
 
         :param print: print/logging function to show progress/status
-        :param max_poll_interval: maximum number of seconds to sleep between status polls
+        :param max_poll_interval: maximum number of seconds to sleep between job status polls
         :param connection_retry_interval: how long to wait when status poll failed due to connection issue
         :param soft_error_max: maximum number of soft errors (e.g. temporary connection glitches) to allow
         :param show_error_logs: whether to automatically print error logs when the batch job failed.

openeo/rest/mlmodel.py

@@ -7,6 +7,10 @@
 
 from openeo.internal.documentation import openeo_process
 from openeo.internal.graph_building import PGNode
+from openeo.rest import (
+    DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
+    DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+)
 from openeo.rest._datacube import _ProcessGraphAbstraction
 from openeo.rest.job import BatchJob
 
@@ -67,8 +71,8 @@ def execute_batch(
         plan: Optional[str] = None,
         budget: Optional[float] = None,
         print=print,
-        max_poll_interval=60,
-        connection_retry_interval=30,
+        max_poll_interval: float = DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+        connection_retry_interval: float = DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
         additional: Optional[dict] = None,
         job_options: Optional[dict] = None,
         show_error_logs: bool = True,
@@ -90,6 +94,8 @@ def execute_batch(
         :param show_error_logs: whether to automatically print error logs when the batch job failed.
         :param log_level: Optional minimum severity level for log entries that the back-end should keep track of.
             One of "error" (highest severity), "warning", "info", and "debug" (lowest severity).
+        :param max_poll_interval: maximum number of seconds to sleep between job status polls
+        :param connection_retry_interval: how long to wait when status poll failed due to connection issue
 
         .. versionchanged:: 0.36.0
             Added argument ``additional``.

openeo/rest/stac_resource.py

@@ -6,6 +6,10 @@
 
 from openeo.internal.documentation import openeo_process
 from openeo.internal.graph_building import PGNode
+from openeo.rest import (
+    DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
+    DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+)
 from openeo.rest._datacube import _ProcessGraphAbstraction
 from openeo.rest.job import BatchJob
 
@@ -98,15 +102,15 @@ def execute_batch(
         plan: Optional[str] = None,
         budget: Optional[float] = None,
         print: typing.Callable[[str], None] = print,
-        max_poll_interval: float = 60,
-        connection_retry_interval: float = 30,
+        max_poll_interval: float = DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+        connection_retry_interval: float = DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
         additional: Optional[dict] = None,
         job_options: Optional[dict] = None,
         validate: Optional[bool] = None,
         auto_add_save_result: bool = True,
         show_error_logs: bool = True,
         log_level: Optional[str] = None,
-    ):
+    ) -> BatchJob:
         """TODO"""
         job = self.create_job(
             title=title,

openeo/rest/vectorcube.py

@@ -13,6 +13,10 @@
 from openeo.internal.graph_building import PGNode
 from openeo.internal.warnings import legacy_alias
 from openeo.metadata import CollectionMetadata, CubeMetadata, Dimension
+from openeo.rest import (
+    DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
+    DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+)
 from openeo.rest._datacube import (
     THIS,
     UDF,
@@ -258,8 +262,8 @@ def execute_batch(
         plan: Optional[str] = None,
         budget: Optional[float] = None,
         print=print,
-        max_poll_interval: float = 60,
-        connection_retry_interval: float = 30,
+        max_poll_interval: float = DEFAULT_JOB_STATUS_POLL_INTERVAL_MAX,
+        connection_retry_interval: float = DEFAULT_JOB_STATUS_POLL_CONNECTION_RETRY_INTERVAL,
         additional: Optional[dict] = None,
         job_options: Optional[dict] = None,
         validate: Optional[bool] = None,
@@ -287,6 +291,8 @@ def execute_batch(
         :param show_error_logs: whether to automatically print error logs when the batch job failed.
         :param log_level: Optional minimum severity level for log entries that the back-end should keep track of.
             One of "error" (highest severity), "warning", "info", and "debug" (lowest severity).
+        :param max_poll_interval: maximum number of seconds to sleep between job status polls
+        :param connection_retry_interval: how long to wait when status poll failed due to connection issue
 
         .. versionchanged:: 0.21.0
             When not specified explicitly, output format is guessed from output file extension.