Refactors plotting modules and updates test expectations

Author: AndrewSazonov

src/easydiffraction/summary/summary.py

@@ -42,7 +42,8 @@ def show_project_info(self) -> None:
 
         if self.project.info.description:
             log.paragraph('Description')
-            # log.print('\n'.join(wrap(self.project.info.description, width=80)))
+            # log.print('\n'.join(wrap(self.project.info.description,
+            # width=80)))
             # TODO: Fix the following lines
             # Ensure description wraps with explicit newlines for tests
             desc_lines = wrap(self.project.info.description, width=60)

tests/unit/easydiffraction/analysis/fit_helpers/test_reporting.py

@@ -56,5 +56,5 @@ def __init__(self, start, value, uncertainty, name='p', units='u'):
     assert 'Weighted R-factor (wR)' in out
     assert 'Bragg R-factor (BR)' in out
     assert 'Fitted parameters:' in out
-    # Table border from tabulate fancy_outline
-    assert '╒' in out or '+' in out
+    # Table border: accept common border glyphs from Rich/tabulate
+    assert any(ch in out for ch in ('╒', '┌', '+', '─'))

tests/unit/easydiffraction/plotting/plotters/test_plotter_ascii.py renamed to tests/unit/easydiffraction/display/plotters/test_ascii.py

@@ -5,15 +5,15 @@
 
 
 def test_module_import():
-    import easydiffraction.plotting.plotters.plotter_ascii as MUT
+    import easydiffraction.display.plotters.ascii as MUT
 
-    expected_module_name = 'easydiffraction.plotting.plotters.plotter_ascii'
+    expected_module_name = 'easydiffraction.display.plotters.ascii'
     actual_module_name = MUT.__name__
     assert expected_module_name == actual_module_name
 
 
 def test_ascii_plotter_plot_minimal(capsys):
-    from easydiffraction.plotting.plotters.plotter_ascii import AsciiPlotter
+    from easydiffraction.display.plotters.ascii import AsciiPlotter
 
     x = np.array([0.0, 1.0, 2.0])
     y = np.array([1.0, 2.0, 3.0])

tests/unit/easydiffraction/display/plotters/test_base.py

@@ -0,0 +1,39 @@
+# SPDX-FileCopyrightText: 2021-2025 EasyDiffraction contributors <https://github.com/easyscience/diffraction>
+# SPDX-License-Identifier: BSD-3-Clause
+
+import importlib
+import types
+import sys
+
+
+def test_module_import():
+    import easydiffraction.display.plotters.base as MUT
+
+    expected_module_name = 'easydiffraction.display.plotters.base'
+    actual_module_name = MUT.__name__
+    assert expected_module_name == actual_module_name
+
+
+def test_default_engine_switches_with_notebook(monkeypatch):
+    from easydiffraction.display.plotting import PlotterEngineEnum
+
+    # Simulate running in a Jupyter kernel
+    mod = types.ModuleType('IPython')
+    mod.get_ipython = lambda: types.SimpleNamespace(config={'IPKernelApp': True})
+    monkeypatch.setitem(sys.modules, 'IPython', mod)
+    assert PlotterEngineEnum.default().value == 'plotly'
+
+    # Now simulate non-notebook environment
+    mod2 = types.ModuleType('IPython')
+    mod2.get_ipython = lambda: None
+    monkeypatch.setitem(sys.modules, 'IPython', mod2)
+    assert PlotterEngineEnum.default().value == 'asciichartpy'
+
+
+def test_default_axes_labels_keys_present():
+    import easydiffraction.display.plotters.base as pb
+    from easydiffraction.experiments.experiment.enums import BeamModeEnum
+    from easydiffraction.experiments.experiment.enums import ScatteringTypeEnum
+
+    assert (ScatteringTypeEnum.BRAGG, BeamModeEnum.CONSTANT_WAVELENGTH) in pb.DEFAULT_AXES_LABELS
+    assert (ScatteringTypeEnum.BRAGG, BeamModeEnum.TIME_OF_FLIGHT) in pb.DEFAULT_AXES_LABELS

tests/unit/easydiffraction/plotting/plotters/test_plotter_plotly.py renamed to tests/unit/easydiffraction/display/plotters/test_plotly.py

@@ -2,15 +2,15 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 def test_module_import():
-    import easydiffraction.plotting.plotters.plotter_plotly as MUT
+    import easydiffraction.display.plotters.plotly as MUT
 
-    expected_module_name = 'easydiffraction.plotting.plotters.plotter_plotly'
+    expected_module_name = 'easydiffraction.display.plotters.plotly'
     actual_module_name = MUT.__name__
     assert expected_module_name == actual_module_name
 
 
 def test_get_trace_and_plot(monkeypatch):
-    import easydiffraction.plotting.plotters.plotter_plotly as pp
+    import easydiffraction.display.plotters.plotly as pp
 
     # Arrange: force non-PyCharm branch and stub fig.show/HTML/display so nothing opens
     monkeypatch.setattr(pp, 'is_pycharm', lambda: False)

tests/unit/easydiffraction/plotting/test_plotting.py renamed to tests/unit/easydiffraction/display/test_plotting.py

@@ -2,26 +2,27 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 def test_module_import():
-    import easydiffraction.plotting.plotting as MUT
+    import easydiffraction.display.plotting as MUT
 
-    expected_module_name = 'easydiffraction.plotting.plotting'
+    expected_module_name = 'easydiffraction.display.plotting'
     actual_module_name = MUT.__name__
     assert expected_module_name == actual_module_name
 
 
 def test_plotter_configuration_and_engine_switch(capsys):
-    from easydiffraction.plotting.plotting import Plotter
+    from easydiffraction.display.plotting import Plotter
 
     p = Plotter()
     # show config prints a table
     p.show_config()
     out1 = capsys.readouterr().out
     assert 'Current plotter configuration' in out1
 
-    # show supported engines prints a table
+    # show supported engines prints a table (now via base RendererBase title)
     p.show_supported_engines()
     out2 = capsys.readouterr().out
-    assert 'Supported plotter engines' in out2
+    # assert 'Supported plotter engines' in out2
+    assert 'Supported engines' in out2
 
     # Switch engine to its current value (no-op, but exercise setter)
     cur = p.engine
@@ -36,19 +37,25 @@ def test_plotter_configuration_and_engine_switch(capsys):
     assert 'asciichartpy' in out3 or 'plotly' in out3
 
 
-def test_plotter_factory_unsupported(capsys):
-    from easydiffraction.plotting.plotting import PlotterFactory
+def test_plotter_factory_supported_and_unsupported():
+    from easydiffraction.display.plotting import PlotterFactory
 
-    obj = PlotterFactory.create_plotter('nope')
-    assert obj is None
-    out = capsys.readouterr().out
-    assert 'Unsupported plotting engine' in out
+    # Supported engine creates a backend instance
+    obj = PlotterFactory.create('asciichartpy')
+    assert obj is not None
+
+    # Unsupported engine should raise ValueError (unified policy)
+    try:
+        PlotterFactory.create('nope')
+        assert False, 'Expected ValueError for unsupported engine name'
+    except ValueError:
+        pass
 
 
 def test_plotter_error_paths_and_filtering(capsys):
     from easydiffraction.experiments.experiment.enums import BeamModeEnum
     from easydiffraction.experiments.experiment.enums import ScatteringTypeEnum
-    from easydiffraction.plotting.plotting import Plotter
+    from easydiffraction.display.plotting import Plotter
 
     class Ptn:
         def __init__(self, x=None, meas=None, calc=None, d=None):
@@ -77,22 +84,29 @@ def __init__(self):
 
     p.plot_calc(Ptn(x=None, calc=None), 'E', ExptType())
     out = capsys.readouterr().out
-    # plot_calc also uses formatting.error(...) without printing for x is None
+    # error path should not print to stdout
     assert out == ''
 
     p.plot_calc(Ptn(x=[1], calc=None), 'E', ExptType())
     out = capsys.readouterr().out
-    assert 'No calculated data available' in out or 'No calculated data' in out
+    # assert 'No calculated data available' in out or 'No calculated data' in out
+    # error path should not print to stdout in new API
+    assert out == ''
 
     p.plot_meas_vs_calc(Ptn(x=None), 'E', ExptType())
     out = capsys.readouterr().out
-    assert 'No data available' in out
+    # assert 'No data available' in out
+    assert out == ''
     p.plot_meas_vs_calc(Ptn(x=[1], meas=None, calc=[1]), 'E', ExptType())
     out = capsys.readouterr().out
-    assert 'No measured data available' in out
+    # assert 'No measured data available' in out
+    assert out == ''
     p.plot_meas_vs_calc(Ptn(x=[1], meas=[1], calc=None), 'E', ExptType())
     out = capsys.readouterr().out
-    assert 'No calculated data available' in out
+    # assert 'No calculated data available' in out
+    assert out == ''
+    # TODO: Update assertions with new logging-based error handling
+    #  in the above line and elsewhere as needed.
 
     # Filtering
     import numpy as np
@@ -106,10 +120,10 @@ def __init__(self):
 def test_plotter_routes_to_ascii_plotter(monkeypatch):
     import numpy as np
 
-    import easydiffraction.plotting.plotters.plotter_ascii as ascii_mod
+    import easydiffraction.display.plotters.ascii as ascii_mod
     from easydiffraction.experiments.experiment.enums import BeamModeEnum
     from easydiffraction.experiments.experiment.enums import ScatteringTypeEnum
-    from easydiffraction.plotting.plotting import Plotter
+    from easydiffraction.display.plotting import Plotter
 
     called = {}
 

tests/unit/easydiffraction/experiments/experiment/test_base.py

@@ -1,8 +1,6 @@
 # SPDX-FileCopyrightText: 2021-2025 EasyDiffraction contributors <https://github.com/easyscience/diffraction>
 # SPDX-License-Identifier: BSD-3-Clause
 
-
-
 def test_module_import():
     import easydiffraction.experiments.experiment.base as MUT
 

tests/unit/easydiffraction/experiments/experiment/test_enums.py

@@ -1,8 +1,6 @@
 # SPDX-FileCopyrightText: 2021-2025 EasyDiffraction contributors <https://github.com/easyscience/diffraction>
 # SPDX-License-Identifier: BSD-3-Clause
 
-
-
 def test_module_import():
     import easydiffraction.experiments.experiment.enums as MUT
 

tests/unit/easydiffraction/experiments/experiment/test_instrument_mixin.py

@@ -1,8 +1,6 @@
 # SPDX-FileCopyrightText: 2021-2025 EasyDiffraction contributors <https://github.com/easyscience/diffraction>
 # SPDX-License-Identifier: BSD-3-Clause
 
-
-
 def test_module_import():
     import easydiffraction.experiments.experiment.instrument_mixin as MUT