Drop unused (optional) dependency on matplotlib #472

Author: soxofaan

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+- Remove unused/outdated `XarrayDataCube.plot()` and its related matplotlib dependency ([#472](https://github.com/Open-EO/openeo-python-client/issues/472))
+
 ### Fixed
 
 

openeo/udf/xarraydatacube.py

@@ -18,10 +18,6 @@
 from openeo.udf import OpenEoUdfException
 from openeo.util import deep_get, dict_no_none
 
-if typing.TYPE_CHECKING:
-    # Imports for type checking only (circular import issue at runtime).
-    import matplotlib.colors
-
 
 class XarrayDataCube:
     """
@@ -157,126 +153,6 @@ def save_to_file(self, path: Union[str, Path], fmt=None, **kwargs):
         else:
             raise ValueError(fmt)
 
-    def plot(
-            self,
-            title: str = None,
-            limits=None,
-            show_bandnames: bool = True,
-            show_dates: bool = True,
-            show_axeslabels: bool = False,
-            fontsize: float = 10.,
-            oversample: float = 1,
-            cmap: Union[str, 'matplotlib.colors.Colormap'] = 'RdYlBu_r',
-            cbartext: str = None,
-            to_file: str = None,
-            to_show: bool = True
-    ):
-        """
-        Visualize a :py:class:`XarrayDataCube` with matplotlib
-
-        :param datacube: data to plot
-        :param title: title text drawn in the top left corner (default: nothing)
-        :param limits: range of the contour plot as a tuple(min,max) (default: None, in which case the min/max is computed from the data)
-        :param show_bandnames: whether to plot the column names (default: True)
-        :param show_dates: whether to show the dates for each row (default: True)
-        :param show_axeslabels: whether to show the labels on the axes (default: False)
-        :param fontsize: font size in pixels (default: 10)
-        :param oversample: one value is plotted into oversample x oversample number of pixels (default: 1 which means each value is plotted as a single pixel)
-        :param cmap: built-in matplotlib color map name or ColorMap object (default: RdYlBu_r which is a blue-yellow-red rainbow)
-        :param cbartext: text on top of the legend (default: nothing)
-        :param to_file: filename to save the image to (default: None, which means no file is generated)
-        :param to_show: whether to show the image in a matplotlib window (default: True)
-
-        :return: None
-        """
-        from matplotlib import pyplot
-
-        data = self.get_array()
-        if limits is None:
-            vmin = data.min()
-            vmax = data.max()
-        else:
-            vmin = limits[0]
-            vmax = limits[1]
-
-        # fill bands and t if missing
-        if 'bands' not in data.dims:
-            data = data.expand_dims(dim={'bands': ['band0']})
-        if 't' not in data.dims:
-            data = data.expand_dims(dim={'t': [numpy.datetime64('today')]})
-        if 'bands' not in data.coords:
-            data['bands'] = ['band0']
-        if 't' not in data.coords:
-            data['t'] = [numpy.datetime64('today')]
-
-        # align with plot
-        data = data.transpose('t', 'bands', 'y', 'x')
-        dpi = 100
-        xres = len(data.x) / dpi
-        yres = len(data.y) / dpi
-        fs = fontsize / oversample
-        frame = 0.33
-
-        nrow = data.shape[0]
-        ncol = data.shape[1]
-
-        fig = pyplot.figure(figsize=((ncol + frame) * xres * 1.1, (nrow + frame) * yres), dpi=int(dpi * oversample))
-        gs = pyplot.GridSpec(nrow, ncol, wspace=0., hspace=0., top=nrow / (nrow + frame), bottom=0.,
-                             left=frame / (ncol + frame), right=1.)
-
-        xmin = data.x.min()
-        xmax = data.x.max()
-        ymin = data.y.min()
-        ymax = data.y.max()
-
-        # flip around if incorrect, this is in harmony with origin='lower'
-        if (data.x[0] > data.x[-1]):
-            data = data.reindex(x=list(reversed(data.x)))
-        if (data.y[0] > data.y[-1]):
-            data = data.reindex(y=list(reversed(data.y)))
-
-        extent = (data.x[0], data.x[-1], data.y[0], data.y[-1])
-
-        for i in range(nrow):
-            for j in range(ncol):
-                im = data[i, j]
-                ax = pyplot.subplot(gs[i, j])
-                ax.set_xlim(xmin, xmax)
-                ax.set_ylim(ymin, ymax)
-                img = ax.imshow(im, vmin=vmin, vmax=vmax, cmap=cmap, origin='lower', extent=extent)
-                ax.xaxis.set_tick_params(labelsize=fs)
-                ax.yaxis.set_tick_params(labelsize=fs)
-                if not show_axeslabels:
-                    ax.set_axis_off()
-                    ax.set_xticklabels([])
-                    ax.set_yticklabels([])
-                if show_bandnames:
-                    if i == 0: ax.text(0.5, 1.08, data.bands.values[j] + " (" + str(data.dtype) + ")", size=fs,
-                                       va="center",
-                                       ha="center", transform=ax.transAxes)
-                if show_dates:
-                    if j == 0: ax.text(-0.08, 0.5, data.t.dt.strftime("%Y-%m-%d").values[i], size=fs, va="center",
-                                       ha="center", rotation=90, transform=ax.transAxes)
-
-        if title is not None:
-            fig.text(0., 1., title.split('/')[-1], size=fs, va="top", ha="left", weight='bold')
-
-        cbar_ax = fig.add_axes([0.01, 0.1, 0.04, 0.5])
-        if cbartext is not None:
-            fig.text(0.06, 0.62, cbartext, size=fs, va="bottom", ha="center")
-        cbar = fig.colorbar(img, cax=cbar_ax)
-        cbar.ax.tick_params(labelsize=fs)
-        cbar.outline.set_visible(False)
-        cbar.ax.tick_params(size=0)
-        cbar.ax.yaxis.set_tick_params(pad=0)
-
-        if to_file is not None:
-            pyplot.savefig(str(to_file))
-        if to_show:
-            pyplot.show()
-
-        pyplot.close()
-
 
 class XarrayIO:
     """

setup.py

@@ -23,7 +23,6 @@
     "httpretty>=1.1.4",
     "urllib3<2.3.0",  # httpretty doesn't work properly with urllib3>=2.3.0. See #700 and https://github.com/gabrielfalcao/HTTPretty/issues/484
     "netCDF4>=1.7.0",
-    "matplotlib",  # TODO: eliminate matplotlib as test dependency
     # TODO #717 Simplify geopandas constraints when Python 3.8 support is dropped
     "geopandas>=0.14; python_version>='3.9'",
     "geopandas",  # Best-effort geopandas dependency for Python 3.8

tests/udf/test_xarraydatacube.py

@@ -304,23 +304,6 @@ def test_save_load_dtype_float64(roundtrip, tmp_path):
     assert result.array.dtype == numpy.float64
 
 
-@pytest.mark.slow
-def test_datacube_plot(tmp_path):
-    import matplotlib.pyplot as plt  # TODO: mandatory dev dependency or optional?
-
-    ts = [numpy.datetime64('2020-08-01'), numpy.datetime64('2020-08-11'), numpy.datetime64('2020-08-21')]
-    xdc = _build_xdc(ts=ts, bands=["a", "b"], xs=100, ys=100)
-    path = tmp_path / "test.png"
-    xdc.plot("title", oversample=1.2, cbartext="some\nvalue", to_file=path, to_show=False)
-
-    png_data = plt.imread(str(path))
-    # Just check basic file properties to make sure the file isn't empty.
-    assert len(png_data.shape) == 3
-    assert png_data.shape[0] > 100
-    assert png_data.shape[1] > 100
-    assert png_data.shape[2] == 4
-
-
 class TestXarrayIO:
 
     def test_from_netcdf_file_simple(self, tmp_path):