Merge pull request #111 from csiro-coasts/bug/105-no-long-name

Fix error when plotting variables with no long_name

Author: mx-moth

docs/releases/development.rst

@@ -31,3 +31,5 @@ Next release (in development)
   This feature is considered experimental
   and may change significantly in future releases.
   (:pr:`110`).
+* Fix an issue with plotting variables with no ``long_name`` attribute.
+  (:issue:`105`, :pr:`111`).

src/emsarray/conventions/_base.py

@@ -938,7 +938,10 @@ def plot_on_figure(
             #
             # Users can supply their own titles
             # if this automatic behaviour is insufficient
-            kwargs['title'] = kwargs['scalar'].attrs.get('long_name')
+            title_bits: list[str] = []
+            long_name = kwargs['scalar'].attrs.get('long_name')
+            if long_name is not None:
+                title_bits.append(str(long_name))
             try:
                 time_coordinate = self.dataset.variables[self.get_time_name()]
             except KeyError:
@@ -949,8 +952,11 @@ def plot_on_figure(
                 # as long as the time coordinate is a proper coordinate with
                 # matching dimension name, not an auxiliary coordinate.
                 if time_coordinate.size == 1:
-                    time = time_coordinate.values
-                    kwargs['title'] = kwargs['title'] + '\n' + str(time)
+                    time = time_coordinate.values[0]
+                    title_bits.append(str(time))
+
+            if title_bits:
+                kwargs['title'] = '\n'.join(title_bits)
 
         plot_on_figure(figure, self, **kwargs)
 

tests/conftest.py

@@ -1,10 +1,13 @@
+import logging
 import pathlib
 from unittest import mock
 
 import pytest
 
 import emsarray
 
+logger = logging.getLogger(__name__)
+
 
 @pytest.fixture
 def datasets() -> pathlib.Path:
@@ -19,6 +22,7 @@ def pytest_runtest_setup(item):
 
 @pytest.fixture
 def matplotlib_backend(
+    request: pytest.FixtureRequest,
     monkeypatch: pytest.MonkeyPatch,
     backend: str = 'template',
 ):
@@ -28,6 +32,12 @@ def matplotlib_backend(
     import matplotlib
     import matplotlib.pyplot
 
+    node = request.node
+    mark = node.get_closest_marker('matplotlib')
+
+    if mark.kwargs.get('mock_coast', False):
+        monkeypatch.setattr(emsarray.plot, 'add_coast', lambda figure: None)
+
     show_mock = mock.Mock(spec=matplotlib.pyplot.show)
     monkeypatch.setattr(matplotlib.pyplot, 'show', show_mock)
 

tests/test_plot.py

@@ -1,11 +1,18 @@
+import logging
+import pathlib
+
 import cartopy.crs
 import matplotlib.figure
+import matplotlib.pyplot
 import numpy
 import pytest
 import shapely
 
+import emsarray
 from emsarray.plot import add_landmarks, polygons_to_collection
 
+logger = logging.getLogger(__name__)
+
 
 @pytest.mark.matplotlib
 def test_polygons_to_collection():
@@ -43,3 +50,52 @@ def test_add_landmarks():
     for landmark, text in zip(landmarks, axes.texts):
         assert text.get_text() == landmark[0]
         assert text.xy == landmark[1].coords.xy
+
+
+@pytest.mark.matplotlib(mock_coast=True)
+@pytest.mark.tutorial
+def test_plot(
+    datasets: pathlib.Path,
+    tmp_path: pathlib.Path,
+):
+    """
+    Test plotting a variable with no long_name attribute works.
+    Regression test for https://github.com/csiro-coasts/emsarray/issues/105
+    """
+    dataset = emsarray.tutorial.open_dataset('gbr4')
+    temp = dataset['temp'].copy()
+    temp = temp.isel(time=0, k=-1)
+
+    dataset.ems.plot(temp)
+
+    figure = matplotlib.pyplot.gcf()
+    axes = figure.axes[0]
+    assert axes.get_title() == 'Temperature\n2022-05-11T14:00:00.000000000'
+
+    matplotlib.pyplot.savefig(tmp_path / 'plot.png')
+    logger.info("Saved plot to %r", tmp_path / 'plot.png')
+
+
+@pytest.mark.matplotlib(mock_coast=True)
+@pytest.mark.tutorial
+def test_plot_no_long_name(
+    datasets: pathlib.Path,
+    tmp_path: pathlib.Path,
+):
+    """
+    Test plotting a variable with no long_name attribute works.
+    Regression test for https://github.com/csiro-coasts/emsarray/issues/105
+    """
+    dataset = emsarray.tutorial.open_dataset('gbr4')
+    temp = dataset['temp'].copy()
+    temp = temp.isel(time=0, k=-1)
+    del temp.attrs['long_name']
+
+    dataset.ems.plot(temp)
+
+    figure = matplotlib.pyplot.gcf()
+    axes = figure.axes[0]
+    assert axes.get_title() == '2022-05-11T14:00:00.000000000'
+
+    matplotlib.pyplot.savefig(tmp_path / 'plot.png')
+    logger.info("Saved plot to %r", tmp_path / 'plot.png')