Issue #706 Show warning on GeometryCollection usage

preparation for fully dropping support in a future release

Author: soxofaan

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Raise exception when providing empty bands array to `load_collection`/`load_stac` ([#424](https://github.com/Open-EO/openeo-python-client/issues/424), [Open-EO/openeo-processes#372](https://github.com/Open-EO/openeo-processes/issues/372))
+- Start showing deprecation warnings on usage of GeoJSON "GeometryCollection" (in `filter_spatial`, `aggregate_spatial`, `chunk_polygon`, `mask_polygon`). Use a GeoJSON FeatureCollection instead. ([#706](https://github.com/Open-EO/openeo-python-client/issues/706), [Open-EO/openeo-processes#389](https://github.com/Open-EO/openeo-processes/issues/389))
 
 ### Removed
 

openeo/rest/datacube.py

@@ -676,7 +676,7 @@ def filter_spatial(
             "MultiLineString",
             "Polygon",
             "MultiPolygon",
-            "GeometryCollection",
+            "GeometryCollection",  # TODO #706 stop allowing GeometryCollection
             "FeatureCollection",
         ]
         geometries = _get_geometry_argument(geometries, valid_geojson_types=valid_geojson_types, connection=self.connection, crs=None)
@@ -1174,8 +1174,15 @@ def aggregate_spatial(
             (which will be loaded client-side to get the geometries as GeoJSON construct).
         """
         valid_geojson_types = [
-            "Point", "MultiPoint", "LineString", "MultiLineString",
-            "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection"
+            "Point",
+            "MultiPoint",
+            "LineString",
+            "MultiLineString",
+            "Polygon",
+            "MultiPolygon",
+            "GeometryCollection",  # TODO #706 stop allowing GeometryCollection
+            "Feature",
+            "FeatureCollection",
         ]
         geometries = _get_geometry_argument(geometries, valid_geojson_types=valid_geojson_types, connection= self.connection, crs=crs)
         reducer = build_child_callback(reducer, parent_parameters=["data"])
@@ -1453,7 +1460,7 @@ def chunk_polygon(
         valid_geojson_types = [
             "Polygon",
             "MultiPolygon",
-            "GeometryCollection",
+            "GeometryCollection",  # TODO #706 stop allowing GeometryCollection
             "Feature",
             "FeatureCollection",
         ]
@@ -2034,8 +2041,16 @@ def mask_polygon(
             Instead, it's possible to provide a client-side path to a GeoJSON file
             (which will be loaded client-side to get the geometries as GeoJSON construct).
         """
-        valid_geojson_types = ["Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection"]
-        mask = _get_geometry_argument(mask, valid_geojson_types=valid_geojson_types, connection=self.connection, crs=srs)
+        valid_geojson_types = [
+            "Polygon",
+            "MultiPolygon",
+            "GeometryCollection",  # TODO #706 stop allowing GeometryCollection
+            "Feature",
+            "FeatureCollection",
+        ]
+        mask = _get_geometry_argument(
+            mask, valid_geojson_types=valid_geojson_types, connection=self.connection, crs=srs
+        )
         return self.process(
             process_id="mask_polygon",
             arguments=dict_no_none(
@@ -2971,6 +2986,12 @@ def _get_geometry_argument(
         raise OpenEoClientException("Invalid geometry type {t!r}, must be one of {s}".format(
             t=geometry.get("type"), s=valid_geojson_types
         ))
+    if geometry.get("type") == "GeometryCollection":
+        # TODO #706 Fully drop GeometryCollection support
+        warnings.warn(
+            "Usage of GeoJSON type 'GeometryCollection' is deprecated/invalid. Support in openEO Python client will be dropped. Use a FeatureCollection instead.",
+            category=DeprecationWarning,
+        )
     if crs:
         # TODO: don't warn when the crs is Lon-Lat like EPSG:4326?
         warnings.warn(f"Geometry with non-Lon-Lat CRS {crs!r} is only supported by specific back-ends.")

tests/rest/datacube/test_datacube100.py

@@ -48,6 +48,7 @@
         {"type": "MultiPolygon", "coordinates": [[[[1.0, 0.0], [1.0, 1.0], [0.0, 1.0], [0.0, 0.0], [1.0, 0.0]]]]},
     ),
     (
+        # TODO #706 Stop allowing GeometryCollection
         shapely.geometry.GeometryCollection([shapely.geometry.box(0, 0, 1, 1)]),
         {
             "type": "GeometryCollection",
@@ -450,8 +451,9 @@ def test_aggregate_spatial_basic(con100: Connection):
     (
             shapely.geometry.MultiPolygon([shapely.geometry.box(0, 0, 1, 1)]),
             {"type": "MultiPolygon", "coordinates": [(((1.0, 0.0), (1.0, 1.0), (0.0, 1.0), (0.0, 0.0), (1.0, 0.0)),)]},
-    ),
-    (
+        ),
+        (
+            # TODO #706 Stop allowing GeometryCollection
             shapely.geometry.GeometryCollection([shapely.geometry.box(0, 0, 1, 1)]),
             {"type": "GeometryCollection", "geometries": [
                 {"type": "Polygon", "coordinates": (((1.0, 0.0), (1.0, 1.0), (0.0, 1.0), (0.0, 0.0), (1.0, 0.0)),)}