fixup! Issue #412 synchronize create_job in DataCube/VectorCube/MlModel

Open-EO · Apr 6, 2023 · b1a59ec · b1a59ec
1 parent f216477
commit b1a59ec
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,7 +29,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   moved accordingly to the `VectorCube` class.
 - Improved documentation on `openeo.processes` and `ProcessBuilder`
   ([#390](https://github.com/Open-EO/openeo-python-client/issues/390)).
-- `DataCube.create_job()` now requires keyword arguments for all but the `out_format` argument.
+- `DataCube.create_job()` and `Connection.create_job()` now require
+  keyword arguments for all but the first argument for clarity.
   ([#412](https://github.com/Open-EO/openeo-python-client/issues/412)).
 
 ### Removed

diff --git a/openeo/rest/connection.py b/openeo/rest/connection.py
@@ -1164,10 +1164,14 @@ def execute(self, process_graph: Union[dict, str, Path]):
         return self.post(path="/result", json=req, expected_status=200).json()
 
     def create_job(
-            self, process_graph: Union[dict, str, Path],
-            title: Optional[str] = None, description: Optional[str] = None,
-            plan: Optional[str] = None, budget: Optional[float] = None,
-            additional: Optional[dict] = None
+        self,
+        process_graph: Union[dict, str, Path],
+        *,
+        title: Optional[str] = None,
+        description: Optional[str] = None,
+        plan: Optional[str] = None,
+        budget: Optional[float] = None,
+        additional: Optional[dict] = None,
     ) -> BatchJob:
         """
         Posts a job to the back end.

diff --git a/openeo/rest/mlmodel.py b/openeo/rest/mlmodel.py
@@ -81,7 +81,6 @@ def execute_batch(
 
     def create_job(
         self,
-        out_format=None,
         *,
         title: Optional[str] = None,
         description: Optional[str] = None,
@@ -92,7 +91,6 @@ def create_job(
         """
         Sends a job to the backend and returns a ClientJob instance.
 
-        :param out_format: String Format of the job result.
         :param title: job title
         :param description: job description
         :param plan: billing plan

diff --git a/openeo/rest/vectorcube.py b/openeo/rest/vectorcube.py
@@ -134,7 +134,7 @@ def execute_batch(
 
     def create_job(
         self,
-        out_format=None,
+        out_format: Optional[str] = None,
         *,
         title: Optional[str] = None,
         description: Optional[str] = None,