Further finetuning of federation extension in Jupyter context #668/#771

Author: soxofaan

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - More extensive band detection for `load_stac` use cases, including the common `bands` metadata introduced with STAC 1.1 ([#699](https://github.com/Open-EO/openeo-python-client/issues/699), [#692](https://github.com/Open-EO/openeo-python-client/issues/692), [#586](https://github.com/Open-EO/openeo-python-client/issues/586)).
+- Improved support for Federation Extension in Jupyter notebook context ([#668](https://github.com/Open-EO/openeo-python-client/issues/668))
 
 ### Changed
 

openeo/metadata.py

@@ -519,14 +519,14 @@ class CollectionMetadata(CubeMetadata):
 
     """
 
-    def __init__(self, metadata: dict, dimensions: List[Dimension] = None, federation=None):
+    def __init__(self, metadata: dict, dimensions: List[Dimension] = None, _federation: Optional[dict] = None):
         self._orig_metadata = metadata
-        self._federation = federation
         if dimensions is None:
             dimensions = self._parse_dimensions(self._orig_metadata)
-
         super().__init__(dimensions=dimensions)
 
+        self._federation = _federation
+
     @classmethod
     def _parse_dimensions(cls, spec: dict, complain: Callable[[str], None] = warnings.warn) -> List[Dimension]:
         """

openeo/rest/connection.py

@@ -73,6 +73,7 @@
     JobListingResponse,
     ProcessListingResponse,
     ValidationResponse,
+    federation_extension,
 )
 from openeo.rest.result import SaveResult
 from openeo.rest.service import Service
@@ -776,11 +777,12 @@ def list_file_formats(self) -> dict:
             key="file_formats",
             load=lambda: self.get('/file_formats', expected_status=200).json()
         )
+        federation_missing = federation_extension.get_federation_missing(data=formats, resource_name="file_formats")
         federation = self.capabilities().ext_federation_backend_details()
         return VisualDict(
             "file-formats",
             data=formats,
-            parameters={"missing": formats.get("federation:missing", None), "federation": federation},
+            parameters={"missing": federation_missing, "federation": federation},
         )
 
     def list_service_types(self) -> dict:
@@ -808,23 +810,20 @@ def list_udf_runtimes(self) -> dict:
         federation = self.capabilities().ext_federation_backend_details()
         return VisualDict("udf-runtimes", data=runtimes, parameters={"federation": federation})
 
-    def list_services(self) -> dict:
+    def list_services(self) -> list:
         """
         Loads all available services of the authenticated user.
 
         :return: data_dict: Dict All available services
         """
         # TODO return parsed service objects
         services = self.get('/services', expected_status=200).json()["services"]
+        federation_missing = federation_extension.get_federation_missing(data=services, resource_name="services")
         federation = self.capabilities().ext_federation_backend_details()
         return VisualList(
             "data-table",
             data=services,
-            parameters={
-                "columns": "services",
-                "missing": services.get("federation:missing", None),
-                "federation": federation,
-            },
+            parameters={"columns": "services", "missing": federation_missing, "federation": federation},
         )
 
     def describe_collection(self, collection_id: str) -> dict:
@@ -896,7 +895,7 @@ def collection_items(
     def collection_metadata(self, name) -> CollectionMetadata:
         # TODO: duplication with `Connection.describe_collection`: deprecate one or the other?
         federation = self.capabilities().ext_federation_backend_details()
-        return CollectionMetadata(metadata=self.describe_collection(name), federation=federation)
+        return CollectionMetadata(metadata=self.describe_collection(name), _federation=federation)
 
     def list_processes(self, namespace: Optional[str] = None) -> ProcessListingResponse:
         """
@@ -1530,15 +1529,12 @@ def list_files(self) -> List[UserFile]:
         """
         data = self.get("/files", expected_status=200).json()
         files = [UserFile.from_metadata(metadata=f, connection=self) for f in data.get("files", [])]
+        federation_missing = federation_extension.get_federation_missing(data=data, resource_name="files")
         federation = self.capabilities().ext_federation_backend_details()
         return VisualList(
             "data-table",
             data=files,
-            parameters={
-                "columns": "files",
-                "missing": data.get("federation:missing", None),
-                "federation": federation,
-            },
+            parameters={"columns": "files", "missing": federation_missing, "federation": federation},
         )
 
     def get_file(

openeo/rest/models/general.py

@@ -2,12 +2,14 @@
 
 import functools
 from dataclasses import dataclass
-from typing import List, Optional, Union
+from typing import TYPE_CHECKING, List, Optional, Union
 
 from openeo.internal.jupyter import render_component
 from openeo.rest.models import federation_extension
 from openeo.rest.models.logs import LogEntry, normalize_log_level
 
+if TYPE_CHECKING:
+    from openeo.rest.connection import Connection
 
 @dataclass(frozen=True)
 class Link:
@@ -52,12 +54,12 @@ class CollectionListingResponse(list):
 
     __slots__ = ["_data", "_connection"]
 
-    def __init__(self, response_data: dict, connection=None):
+    def __init__(self, response_data: dict, connection: Optional[Connection] = None):
         self._data = response_data
-        self._connection = connection
         # Mimic original list of collection metadata dictionaries
         super().__init__(response_data["collections"])
 
+        self._connection = connection
         self.ext_federation_missing(auto_warn=True)
 
     def _repr_html_(self):
@@ -113,12 +115,12 @@ class ProcessListingResponse(list):
 
     __slots__ = ["_data", "_connection"]
 
-    def __init__(self, response_data: dict, connection=None):
+    def __init__(self, response_data: dict, connection: Optional[Connection] = None):
         self._data = response_data
-        self._connection = connection
         # Mimic original list of process metadata dictionaries
         super().__init__(response_data["processes"])
 
+        self._connection = connection
         self.ext_federation_missing(auto_warn=True)
 
     def _repr_html_(self):
@@ -177,12 +179,12 @@ class JobListingResponse(list):
 
     __slots__ = ["_data", "_connection"]
 
-    def __init__(self, response_data: dict, connection=None):
+    def __init__(self, response_data: dict, connection: Optional[Connection] = None):
         self._data = response_data
-        self._connection = connection
         # Mimic original list of process metadata dictionaries
         super().__init__(response_data["jobs"])
 
+        self._connection = connection
         self.ext_federation_missing(auto_warn=True)
 
     def _repr_html_(self):
@@ -243,9 +245,10 @@ class LogsResponse(list):
 
     __slots__ = ["_data", "_connection"]
 
-    def __init__(self, response_data: dict, *, log_level: Optional[str] = None, connection=None):
+    def __init__(
+        self, response_data: dict, *, log_level: Optional[str] = None, connection: Optional[Connection] = None
+    ):
         self._data = response_data
-        self._connection = connection
 
         logs = response_data.get("logs", [])
         # Extra client-side level filtering (in case the back-end does not support that)
@@ -267,6 +270,7 @@ def accept_level(level: str) -> bool:
         # Mimic original list of process metadata dictionaries
         super().__init__(logs)
 
+        self._connection = connection
         self.ext_federation_missing(auto_warn=True)
 
     def _repr_html_(self):