Draft support for the federation extension in Jupyter visual outputs #668

Author: m-mohr

openeo/rest/connection.py

@@ -713,7 +713,7 @@ def list_collections(self) -> CollectionListingResponse:
         # TODO: add caching #383, but reset cache on auth change #254
         # TODO #677 add pagination support?
         data = self.get("/collections", expected_status=200).json()
-        return CollectionListingResponse(response_data=data)
+        return CollectionListingResponse(response_data=data, connection=self)
 
     def list_collection_ids(self) -> List[str]:
         """
@@ -870,7 +870,7 @@ def list_processes(self, namespace: Optional[str] = None) -> ProcessListingRespo
             )
         else:
             response = self.get("/processes/" + namespace, expected_status=200).json()
-        return ProcessListingResponse(response_data=response)
+        return ProcessListingResponse(response_data=response, connection=self)
 
     def describe_process(self, id: str, namespace: Optional[str] = None) -> dict:
         """
@@ -912,7 +912,7 @@ def list_jobs(self, limit: Union[int, None] = 100) -> JobListingResponse:
         # TODO: Parse the result so that Job classes returned?
         # TODO: when pagination is enabled: how to expose link to next page?
         resp = self.get("/jobs", params={"limit": limit}, expected_status=200).json()
-        return JobListingResponse(response_data=resp)
+        return JobListingResponse(response_data=resp, connection=self)
 
     def assert_user_defined_process_support(self):
         """

openeo/rest/models/general.py

@@ -43,23 +43,33 @@ class CollectionListingResponse(list):
         but now also provides methods/properties to access additional response data.
 
     :param response_data: response data from a ``GET /collections`` request
+    :param connection: optional connection object to use for federation extension
 
     .. seealso:: :py:meth:`openeo.rest.connection.Connection.list_collections()`
 
     .. versionadded:: 0.38.0
     """
 
-    __slots__ = ["_data"]
+    __slots__ = ["_data", "_connection"]
 
-    def __init__(self, response_data: dict):
+    def __init__(self, response_data: dict, connection = None):
         self._data = response_data
+        self._connection = connection
         # Mimic original list of collection metadata dictionaries
         super().__init__(response_data["collections"])
 
         self.ext_federation_missing(auto_warn=True)
 
     def _repr_html_(self):
-        return render_component(component="collections", data=self)
+        federation = self._connection.capabilities().ext_federation_backend_details() if self._connection else None
+        return render_component(
+            component="collections",
+            data=self,
+            parameters={
+                "missing": self.ext_federation_missing(),
+                "federation": federation,
+            }
+        )
 
     @property
     def links(self) -> List[Link]:
@@ -94,24 +104,34 @@ class ProcessListingResponse(list):
         but now also provides methods/properties to access additional response data.
 
     :param response_data: response data from a ``GET /processes`` request
+    :param connection: optional connection object to use for federation extension
 
     .. seealso:: :py:meth:`openeo.rest.connection.Connection.list_processes()`
 
     .. versionadded:: 0.38.0
     """
 
-    __slots__ = ["_data"]
+    __slots__ = ["_data", "_connection"]
 
-    def __init__(self, response_data: dict):
+    def __init__(self, response_data: dict, connection = None):
         self._data = response_data
+        self._connection = connection
         # Mimic original list of process metadata dictionaries
         super().__init__(response_data["processes"])
 
         self.ext_federation_missing(auto_warn=True)
 
     def _repr_html_(self):
+        federation = self._connection.capabilities().ext_federation_backend_details() if self._connection else None
         return render_component(
-            component="processes", data=self, parameters={"show-graph": True, "provide-download": False}
+            component="processes",
+            data=self,
+            parameters={
+                "show-graph": True,
+                "provide-download": False,
+                "missing": self.ext_federation_missing(),
+                "federation": federation,
+            }
         )
 
     @property
@@ -148,23 +168,34 @@ class JobListingResponse(list):
         but now also provides methods/properties to access additional response data.
 
     :param response_data: response data from a ``GET /jobs`` request
+    :param connection: optional connection object to use for federation extension
 
     .. seealso:: :py:meth:`openeo.rest.connection.Connection.list_jobs()`
 
     .. versionadded:: 0.38.0
     """
 
-    __slots__ = ["_data"]
+    __slots__ = ["_data", "_connection"]
 
-    def __init__(self, response_data: dict):
+    def __init__(self, response_data: dict, connection = None):
         self._data = response_data
+        self._connection = connection
         # Mimic original list of process metadata dictionaries
         super().__init__(response_data["jobs"])
 
         self.ext_federation_missing(auto_warn=True)
 
     def _repr_html_(self):
-        return render_component(component="data-table", data=self, parameters={"columns": "jobs"})
+        federation = self._connection.capabilities().ext_federation_backend_details() if self._connection else None
+        return render_component(
+            component="data-table",
+            data=self,
+            parameters={
+                "columns": "jobs",
+                "missing": self.ext_federation_missing(),
+                "federation": federation,
+            }
+        )
 
     @property
     def links(self) -> List[Link]: