Close figures on teardown (#254)

* add pytest fixture to close plots

* also deal with reader, samples and weighted pandas

* instead use TestPlotBase

* nearly linted

* finish linting

* Revert "finish linting"

This reverts commit dd1ed76.

* Revert "nearly linted"

This reverts commit b0aa9b9.

* Revert "instead use TestPlotBase"

This reverts commit 38ca3d1.

* place fixture in test_plot.py instead

* realised what autouse=True does lol

* hist->hist_1d as consequence of #246

* code repetitionionionionion

* removed yield which I copied from the previous attempt

* added check to CI, should fail due to matplotlib.agg.py

* remember to import pytest

* message tweak

* add ls

* add >>

* remove second grep

* only check test*.py

* use variables properly

* extra set of

* make test_gui.py fail again

* not sure what was going on with those wildcards

* echo missing

* too many brackets

* remove echo missing

* unfail test_gui.py

* Revert "unfail test_gui.py"

This reverts commit b45feb6.

* list files in message

* put everything in the if

* bash if statement is more appropriate, as test should always show as run

* fail test_weighted_pandas.py

* remove pandas testing import

* Revert "remove pandas testing import"

This reverts commit d0999e4.

* Revert "fail test_weighted_pandas.py"

This reverts commit 336e69b.

* Revert "Revert "unfail test_gui.py""

This reverts commit 3a7ab81.

* capital C

* Removed erroneous fixture

Co-authored-by: Will Handley <[email protected]>

.github/workflows/CI.yml

@@ -26,6 +26,14 @@ jobs:
  run: python -m flake8 anesthetic tests
  - name: pydocstyle documentation style checks
  run: python -m pydocstyle --convention=numpy anesthetic
+ - name: Count missing test fixtures
+ run: |
+ if [ $( grep -L 'close_figures_on_teardown' $(grep -l 'matplotlib' tests/test*.py) | wc -w ) -ne 0 ]
+ then
+ missing_tests=$( grep -L 'close_figures_on_teardown' $(grep -l 'matplotlib' tests/test*.py) )
+ echo "$missing_tests are missing the close_figures_on_teardown fixture."
+ exit 1
+ fi
 
  pip:
  runs-on: ${{ matrix.os }}

tests/test_gui.py

@@ -1,5 +1,12 @@
 import anesthetic.examples._matplotlib_agg # noqa: F401
 from anesthetic import read_chains
+import pytest
+import pandas._testing as tm
+
+
+@pytest.fixture(autouse=True)
+def close_figures_on_teardown():
+ tm.close()
 
 
 def test_gui():

tests/test_plot.py

@@ -10,6 +10,7 @@
  scatter_plot_2d, quantile_plot_interval,
  basic_cmap, AxesSeries, AxesDataFrame)
 from numpy.testing import assert_array_equal
+import pandas._testing as tm
 
 from matplotlib.axes._subplots import SubplotBase
 from matplotlib.contour import ContourSet
@@ -21,6 +22,11 @@
 from scipy.interpolate import interp1d
 
 
+@pytest.fixture(autouse=True)
+def close_figures_on_teardown():
+ tm.close()
+
+
 def test_AxesObjects():
  paramnames = ['a', 'b', 'c']
 

tests/test_reader.py

@@ -11,12 +11,18 @@
 from anesthetic.read.getdist import read_getdist
 from anesthetic.read.cobaya import read_cobaya
 from anesthetic.read.multinest import read_multinest
+import pandas._testing as tm
 try:
  import getdist
 except ImportError:
  pass
 
 
+@pytest.fixture(autouse=True)
+def close_figures_on_teardown():
+ tm.close()
+
+
 def test_read_getdist():
  np.random.seed(3)
  mcmc = read_getdist('./tests/example_data/gd')

tests/test_samples.py

@@ -18,10 +18,16 @@
 from numpy.testing import (assert_array_equal, assert_array_almost_equal,
  assert_array_less, assert_allclose)
 from pandas.testing import assert_frame_equal
+import pandas._testing as tm
 from matplotlib.colors import to_hex
 from scipy.stats import ks_2samp, kstest, norm
 
 
+@pytest.fixture(autouse=True)
+def close_figures_on_teardown():
+ tm.close()
+
+
 def test_build_samples():
  np.random.seed(3)
  nsamps = 1000
@@ -186,9 +192,9 @@ def test_plot_2d_kinds_multiple_calls():
  axes = ns.plot_2d(params, kind={'diagonal': 'kde_1d',
  'lower': 'kde_2d',
  'upper': 'scatter_2d'})
- ns.plot_2d(axes, kind={'diagonal': 'hist'})
+ ns.plot_2d(axes, kind={'diagonal': 'hist_1d'})
 
- axes = ns.plot_2d(params, kind={'diagonal': 'hist'})
+ axes = ns.plot_2d(params, kind={'diagonal': 'hist_1d'})
  ns.plot_2d(axes, kind={'diagonal': 'kde_1d',
  'lower': 'kde_2d',
  'upper': 'scatter_2d'})

tests/test_weighted_pandas.py

@@ -10,6 +10,12 @@
 from pandas.plotting._matplotlib.misc import (
  scatter_matrix as orig_scatter_matrix
 )
+import pandas._testing as tm
+
+
+@pytest.fixture(autouse=True)
+def close_figures_on_teardown():
+ tm.close()
 
 
 @pytest.fixture