Remove legacy DataCube.flatten() #155 #209 #324

Author: soxofaan

CHANGELOG.md

@@ -25,7 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-- Remove legacy `DataCube.graph` property to prevent usage patterns that cause interoperability issues
+- Remove legacy `DataCube.graph` and `DataCube.flatten()` to prevent usage patterns that cause interoperability issues
   ([#155](https://github.com/Open-EO/openeo-python-client/issues/155), [#209](https://github.com/Open-EO/openeo-python-client/issues/209), [#324](https://github.com/Open-EO/openeo-python-client/issues/324))
 
 ### Fixed

examples/notebooks/ProcessAsAService.ipynb

@@ -263,7 +263,7 @@
     "\n",
     "#for visualizing the process graph in Jupyter notebook\n",
     "from IPython.display import JSON\n",
-    "JSON(ndvi.flatten())"
+    "JSON(ndvi.flat_graph())"
    ]
   },
   {
@@ -480,7 +480,7 @@
     "        schema={\"type\": \"string\", \"subtype\": \"date-time\"}\n",
     "    )\n",
     "\n",
-    "graph_with_parameters = ndvi.flatten()\n",
+    "graph_with_parameters = ndvi.flat_graph()\n",
     "graph_with_parameters['filtertemporal1']['arguments']['extent'][0]={'from_parameter':'date'}\n",
     "graph_with_parameters['filtertemporal1']['arguments']['extent'][1]={'from_parameter':'date'}\n",
     "\n",

openeo/internal/graph_building.py

@@ -117,8 +117,6 @@ def flat_graph(self) -> dict:
         """Get the process graph in internal flat dict representation."""
         return GraphFlattener().flatten(node=self)
 
-    flatten = legacy_alias(flat_graph, name="flatten")
-
     @staticmethod
     def to_process_graph_argument(value: Union['PGNode', str, dict]) -> dict:
         """

openeo/rest/_datacube.py

@@ -45,8 +45,6 @@ def flat_graph(self) -> dict:
         # TODO: wrap in {"process_graph":...} by default/optionally?
         return self._pg.flat_graph()
 
-    flatten = legacy_alias(flat_graph, name="flatten")
-
     def to_json(self, *, indent: Union[int, None] = 2, separators: Optional[Tuple[str, str]] = None) -> str:
         """
         Get interoperable JSON representation of the process graph.

tests/rest/datacube/test_datacube100.py

@@ -74,16 +74,6 @@ def test_datacube_flat_graph(con100):
     }}
 
 
-def test_datacube_legacy_flatten(con100):
-    s2cube = con100.load_collection("S2")
-    with pytest.warns(DeprecationWarning, match="Call to deprecated method `flatten`, use `flat_graph` instead."):
-        assert s2cube.flatten() == {'loadcollection1': {
-            'process_id': 'load_collection',
-            'arguments': {'id': 'S2', 'spatial_extent': None, 'temporal_extent': None},
-            'result': True
-        }}
-
-
 @pytest.mark.parametrize(["kwargs", "expected"], [
     ({"west": 3, "south": 51, "east": 4, "north": 52}, {"west": 3, "south": 51, "east": 4, "north": 52}),
     (