Issue #242/#248 bit of final fine-tuning

Author: soxofaan

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add `options` argument to `DataCube.atmospheric_correction` ([Open-EO/openeo-python-driver#91](https://github.com/Open-EO/openeo-python-driver/issues/91))
 - Add `atmospheric_correction_options` and `cloud_detection_options` arguments to `DataCube.ard_surface_reflectance` ([Open-EO/openeo-python-driver#91](https://github.com/Open-EO/openeo-python-driver/issues/91))
+- UDP storing: add support for "returns", "categories", "examples" and "links" properties ([#242](https://github.com/Open-EO/openeo-python-client/issues/242))
 
 
 ### Changed

openeo/rest/connection.py

@@ -719,9 +719,13 @@ def save_user_defined_process(
             self, user_defined_process_id: str,
             process_graph: Union[dict, ProcessBuilderBase],
             parameters: List[Union[dict, Parameter]] = None,
-            public: bool = False, summary: str = None, description: str = None,
-            returns: Optional[dict] = None, categories: Optional[List[str]] = None, 
-            examples: Optional[List[dict]] = None, links: Optional[List[dict]] = None
+            public: bool = False,
+            summary: Optional[str] = None,
+            description: Optional[str] = None,
+            returns: Optional[dict] = None,
+            categories: Optional[List[str]] = None,
+            examples: Optional[List[dict]] = None,
+            links: Optional[List[dict]] = None,
     ) -> RESTUserDefinedProcess:
         """
         Store a process graph and its metadata on the backend as a user-defined process for the authenticated user.
@@ -745,8 +749,10 @@ def save_user_defined_process(
             warnings.warn("Defining user-defined process {u!r} without parameters".format(u=user_defined_process_id))
         udp = RESTUserDefinedProcess(user_defined_process_id=user_defined_process_id, connection=self)
         udp.store(
-            process_graph=process_graph, parameters=parameters, public=public, summary=summary, description=description,
-            returns=returns, categories=categories, examples=examples, links=links)
+            process_graph=process_graph, parameters=parameters, public=public,
+            summary=summary, description=description,
+            returns=returns, categories=categories, examples=examples, links=links
+        )
         return udp
 
     def list_user_defined_processes(self) -> List[dict]:

openeo/rest/datacube.py

@@ -1563,9 +1563,16 @@ def send_job(
         )
 
     def save_user_defined_process(
-        self, user_defined_process_id: str, public: bool = False, summary: str=None, description: str=None,
-        returns: Optional[dict] = None, categories: Optional[List[str]] = None, examples: Optional[List[dict]] = None,
-        links: Optional[List[dict]] = None) -> RESTUserDefinedProcess:
+            self,
+            user_defined_process_id: str,
+            public: bool = False,
+            summary: Optional[str] = None,
+            description: Optional[str] = None,
+            returns: Optional[dict] = None,
+            categories: Optional[List[str]] = None,
+            examples: Optional[List[dict]] = None,
+            links: Optional[List[dict]] = None,
+    ) -> RESTUserDefinedProcess:
         """
         Saves this process graph in the backend as a user-defined process for the authenticated user.
 
@@ -1582,7 +1589,8 @@ def save_user_defined_process(
         return self._connection.save_user_defined_process(
             user_defined_process_id=user_defined_process_id,
             process_graph=self.flat_graph(), public=public, summary=summary, description=description,
-            returns=returns, categories=categories, examples=examples, links=links)
+            returns=returns, categories=categories, examples=examples, links=links,
+        )
 
     def execute(self) -> Dict:
         """Executes the process graph of the imagery. """

openeo/rest/udp.py

@@ -23,7 +23,7 @@ def build_process_dict(
         returns: Optional[dict] = None,
         categories: Optional[List[str]] = None,
         examples: Optional[List[dict]] = None,
-        links: Optional[List[dict]] = None
+        links: Optional[List[dict]] = None,
 ) -> dict:
     """
     Build a dictionary describing a process with metadaa (`process_graph`, `parameters`, `description`, ...)
@@ -70,15 +70,22 @@ def _repr_html_(self):
         return render_component('process', data=process, parameters = {'show-graph': True, 'provide-download': False})
 
     def store(
-            self, process_graph: Union[dict, ProcessBuilderBase], parameters: List[Union[Parameter, dict]] = None,
-            public: bool = False, summary: str = None, description: str = None, returns: Optional[dict] = None,
-            categories: Optional[List[str]] = None, examples: Optional[List[dict]] = None, links: Optional[List[dict]] = None
+            self,
+            process_graph: Union[dict, ProcessBuilderBase],
+            parameters: List[Union[Parameter, dict]] = None,
+            public: bool = False,
+            summary: Optional[str] = None,
+            description: Optional[str] = None,
+            returns: Optional[dict] = None,
+            categories: Optional[List[str]] = None,
+            examples: Optional[List[dict]] = None,
+            links: Optional[List[dict]] = None,
     ):
         """Store a process graph and its metadata on the backend as a user-defined process"""
         process = build_process_dict(
             process_graph=process_graph, parameters=parameters,
             summary=summary, description=description, returns=returns,
-            categories=categories, examples=examples, links=links
+            categories=categories, examples=examples, links=links,
         )
 
         # TODO: this "public" flag is not standardized yet EP-3609, https://github.com/Open-EO/openeo-api/issues/310

tests/rest/test_udp.py

@@ -69,20 +69,24 @@ def check_body(request):
             "public": False,
             "summary": "A summary",
             "description": "A description",
+            "returns": {"schema": {"type": ["number", "null"]}},
             "categories": ["math", "simple"],
+            "examples": [{"arguments": {"x": 5, "y": 2.5}, "returns": 7.5}, ],
             "links": [{"link1": "openeo.cloud", "link2": "openeo.vito.be"}],
-            "examples": [{"arguments":{"x": 5,"y": 2.5},"returns": 7.5},],
-            "returns": {"schema":{"type": ["number","null"]}}
         }
         return True
 
     adapter = requests_mock.put(API_URL + "/process_graphs/two", additional_matcher=check_body)
 
     udp = con100.save_user_defined_process(
-        "two", two, summary = "A summary", categories = ["math", "simple"], 
-        links = [{"link1": "openeo.cloud", "link2": "openeo.vito.be"}],
-        examples = [{"arguments":{"x": 5,"y": 2.5},"returns": 7.5},],
-        description = "A description", returns = {"schema":{"type": ["number","null"]}})
+        "two", two,
+        summary="A summary",
+        description="A description",
+        returns={"schema": {"type": ["number", "null"]}},
+        categories=["math", "simple"],
+        examples=[{"arguments": {"x": 5, "y": 2.5}, "returns": 7.5}, ],
+        links=[{"link1": "openeo.cloud", "link2": "openeo.vito.be"}],
+    )
     assert isinstance(udp, RESTUserDefinedProcess)
     assert adapter.called