test: cleanup matplotlib rc params before and after each test (#576)

* test: cleanup matplotlib rc params before and after each test

* chore: update ruff version to v0.12.1 and clean up imports in multiple files

Author: jonas-eschle

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.12.0
+  rev: v0.12.1
   hooks:
     # Run the linter.
     - id: ruff

src/mplhep/__init__.py

@@ -67,37 +67,37 @@
 
 # Log submodules
 __all__ = [
-    "cms",
-    "atlas",
-    "lhcb",
+    "EnhancedPlottableHistogram",
+    "_check_counting_histogram",
     "alice",
-    "plot",
-    "style",
-    "label",
-    "savelabels",
+    "append_axes",
+    "atlas",
+    "box_aspect",
+    "cms",
+    "get_asymmetry",
+    "get_comparison",
+    "get_difference",
+    "get_efficiency",
+    "get_plottables",
+    "get_pull",
+    "get_ratio",
+    "hist2dplot",
     # Log plot functions
     "histplot",
-    "hist2dplot",
-    "mpl_magic",
-    "yscale_legend",
-    "yscale_anchored_text",
-    "ylow",
-    "rescale_to_axessize",
-    "box_aspect",
+    "label",
+    "lhcb",
+    "make_plottable_histogram",
     "make_square_add_cbar",
     "merge_legend_handles_labels",
-    "append_axes",
-    "sort_legend",
+    "mpl_magic",
+    "plot",
+    "rescale_to_axessize",
     "save_variations",
+    "savelabels",
     "set_style",
-    "get_plottables",
-    "EnhancedPlottableHistogram",
-    "make_plottable_histogram",
-    "_check_counting_histogram",
-    "get_comparison",
-    "get_difference",
-    "get_ratio",
-    "get_pull",
-    "get_asymmetry",
-    "get_efficiency",
+    "sort_legend",
+    "style",
+    "ylow",
+    "yscale_anchored_text",
+    "yscale_legend",
 ]

src/mplhep/error_estimation.py

@@ -50,5 +50,5 @@ def poisson_interval(sumw, sumw2, coverage=_coverage1sd):
     lo = scale * scipy.stats.chi2.ppf((1 - coverage) / 2, 2 * counts) / 2.0
     hi = scale * scipy.stats.chi2.ppf((1 + coverage) / 2, 2 * (counts + 1)) / 2.0
     interval = np.array([lo, hi])
-    interval[interval == np.nan] = 0.0  # chi2.ppf produces nan for counts=0
+    interval[np.isnan(interval)] = 0.0  # chi2.ppf produces nan for counts=0
     return interval

src/mplhep/label.py

@@ -555,7 +555,7 @@ def save_variations(fig, name, text_list=None, exp=None):
     if text_list is None:
         text_list = ["Preliminary", ""]
 
-    from mplhep.label import ExpSuffix, ExpText
+    from mplhep.label import ExpSuffix, ExpText  # noqa: PLC0415
 
     for text in text_list:
         for ax in fig.get_axes():

src/mplhep/plot.py

@@ -9,7 +9,10 @@
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 import numpy as np
+from matplotlib.lines import Line2D
 from matplotlib.offsetbox import AnchoredText
+from matplotlib.patches import Patch, Rectangle
+from matplotlib.text import Text
 from matplotlib.transforms import Bbox
 from mpl_toolkits.axes_grid1 import axes_size, make_axes_locatable
 
@@ -1031,9 +1034,6 @@ def overlap(ax, bbox, get_vertices=False):
     """
     Find overlap of bbox for drawn elements an axes.
     """
-    from matplotlib.lines import Line2D
-    from matplotlib.patches import Patch, Rectangle
-    from matplotlib.text import Text
 
     # From
     # https://github.com/matplotlib/matplotlib/blob/08008d5cb4d1f27692e9aead9a76396adc8f0b19/lib/matplotlib/legend.py#L845
@@ -1371,13 +1371,13 @@ def extend_ratio(ax, yhax):
                 fig.get_size_inches()[1],
             )
         elif position in ["left"]:
-            divider.set_horizontal(xsizes[::-1] + [axes_size.Fixed(width)])
+            divider.set_horizontal([*xsizes[::-1], axes_size.Fixed(width)])
             fig.set_size_inches(
                 fig.get_size_inches()[0] * extend_ratio(ax, yhax)[0],
                 fig.get_size_inches()[1],
             )
         elif position in ["top"]:
-            divider.set_vertical([axes_size.Fixed(height)] + xsizes[::-1])
+            divider.set_vertical([axes_size.Fixed(height), *xsizes[::-1]])
             fig.set_size_inches(
                 fig.get_size_inches()[0],
                 fig.get_size_inches()[1] * extend_ratio(ax, yhax)[1],
@@ -1397,8 +1397,6 @@ def extend_ratio(ax, yhax):
 ####################
 # Legend Helpers
 def hist_legend(ax=None, **kwargs):
-    from matplotlib.lines import Line2D
-
     if ax is None:
         ax = plt.gca()
 

src/mplhep/utils.py

@@ -31,7 +31,7 @@ def isLight(rgb):
 def get_plottable_protocol_bins(
     axis: PlottableAxis,
 ) -> tuple[np.ndarray, np.ndarray | None]:
-    out = np.arange(len(axis) + 1).astype(float)
+    out: np.ndarray = np.arange(len(axis) + 1).astype(float)
     if isinstance(axis[0], tuple):  # Regular axis
         out[0] = axis[0][0]
         out[1:] = [axis[i][1] for i in range(len(axis))]  # type: ignore[index]
@@ -451,7 +451,7 @@ def norm_stack_plottables(plottables, bins, stack=False, density=False, binwnorm
 
     # Stack
     if stack and len(plottables) > 1:
-        from .utils import stack as stack_fun
+        from .utils import stack as stack_fun  # noqa: PLC0415
 
         plottables = stack_fun(*plottables)
 
@@ -504,6 +504,7 @@ def __init__(
                 np.zeros_like(self.values()),
                 np.zeros_like(self.values()),
             )
+        self._hash = None
 
     def __eq__(self, other):
         """Check equality between two EnhancedPlottableHistogram instances based on values(), variances(), and edges."""
@@ -515,6 +516,22 @@ def __eq__(self, other):
             ]
         )
 
+    def __hash__(self):
+        """Return a hash of the EnhancedPlottableHistogram object based on its values, variances, and edges."""
+        if self._hash is None:
+            self._hash = hash(
+                (
+                    tuple(self.values().flatten()),
+                    tuple(
+                        self.variances().flatten()
+                        if self.variances() is not None
+                        else []
+                    ),
+                    tuple(self.edges_1d().flatten()),
+                )
+            )
+        return self._hash
+
     def __repr__(self):
         """Return string representation of the EnhancedPlottableHistogram object."""
         return f"EnhancedPlottableHistogram(values={self.values()}, edges={self.axes[0].edges}, variances={self.variances()})"
@@ -640,7 +657,7 @@ def calculate_relative(method_fcn, variances):
             )
         elif method == "poisson":
             try:
-                from .error_estimation import poisson_interval
+                from .error_estimation import poisson_interval  # noqa: PLC0415
 
                 self.yerr_lo, self.yerr_hi = calculate_relative(
                     poisson_interval, self.variances()

tests/conftest.py

@@ -0,0 +1,11 @@
+import matplotlib.pyplot as plt
+import pytest
+
+
+@pytest.fixture(autouse=True)
+def clear_mplhep_rcparams():
+    """Clear matplotlib rcParams before and after each test."""
+
+    plt.rcParams.update(plt.rcParamsDefault)
+    yield
+    plt.rcParams.update(plt.rcParamsDefault)

tests/test_basic.py

@@ -8,6 +8,7 @@
 import matplotlib.pyplot as plt
 import numpy as np
 import pytest
+import uproot
 
 os.environ["RUNNING_PYTEST"] = "true"
 
@@ -94,8 +95,6 @@ def test_log():
 
 @pytest.mark.mpl_image_compare(style="default", remove_text=True)
 def test_onebin_hist():
-    import hist
-
     fig, axs = plt.subplots()
     h = hist.Hist(hist.axis.Regular(1, 0, 1))
     h.fill([-1, 0.5])
@@ -217,7 +216,6 @@ def test_histplot_uproot_flow():
     h2.fill(entries[entries < 15])
     h3.fill(entries[entries > 5])
     h4.fill(entries[(entries > 5) & (entries < 15)])
-    import uproot
 
     with uproot.recreate("flow_th1.root") as f:
         f["h"] = h

tests/test_inputs.py

@@ -9,6 +9,11 @@
 
 os.environ["RUNNING_PYTEST"] = "true"
 
+import boost_histogram as bh
+import uproot
+import uproot4
+from skhep_testdata import data_path
+
 import mplhep as hep
 
 """
@@ -39,9 +44,6 @@ def test_inputs_basic():
 
 @pytest.mark.mpl_image_compare(style="default", remove_text=True)
 def test_inputs_uproot():
-    import uproot4
-    from skhep_testdata import data_path
-
     fname = data_path("uproot-hepdata-example.root")
     f = uproot4.open(fname)
 
@@ -55,10 +57,6 @@ def test_inputs_uproot():
 
 @check_figures_equal(extensions=("png", "pdf"))
 def test_uproot_versions(fig_test, fig_ref):
-    import uproot
-    import uproot4
-    from skhep_testdata import data_path
-
     fname = data_path("uproot-hepdata-example.root")
     f4 = uproot4.open(fname)
     f3 = uproot.open(fname)
@@ -80,7 +78,6 @@ def test_uproot_versions(fig_test, fig_ref):
 @pytest.mark.mpl_image_compare(style="default", remove_text=True)
 def test_inputs_bh():
     np.random.seed(0)
-    import boost_histogram as bh
 
     hist2d = bh.Histogram(bh.axis.Regular(10, 0.0, 1.0), bh.axis.Regular(10, 0, 1))
     hist2d.fill(np.random.normal(0.5, 0.2, 1000), np.random.normal(0.5, 0.2, 1000))
@@ -95,7 +92,6 @@ def test_inputs_bh():
 @pytest.mark.mpl_image_compare(style="default", remove_text=True)
 def test_inputs_bh_cat():
     np.random.seed(0)
-    import boost_histogram as bh
 
     hist2d = bh.Histogram(
         bh.axis.IntCategory(range(10)), bh.axis.StrCategory("", growth=True)

tests/test_styles.py

@@ -26,8 +26,6 @@
 @pytest.mark.skipif(sys.platform != "linux", reason="Linux only")
 @pytest.mark.mpl_image_compare(style="default", remove_text=False)
 def test_style_atlas():
-    plt.rcParams.update(plt.rcParamsDefault)
-
     # Test suite does not have Helvetica
     plt.style.use([hep.style.ATLAS, {"font.sans-serif": ["Tex Gyre Heros"]}])
     fig, ax = plt.subplots()
@@ -39,8 +37,6 @@ def test_style_atlas():
 @pytest.mark.skipif(sys.platform != "linux", reason="Linux only")
 @pytest.mark.mpl_image_compare(style="default", remove_text=False)
 def test_style_cms():
-    plt.rcParams.update(plt.rcParamsDefault)
-
     plt.style.use(hep.style.CMS)
     fig, ax = plt.subplots()
     hep.cms.label("Preliminary")
@@ -51,8 +47,6 @@ def test_style_cms():
 @pytest.mark.skipif(sys.platform != "linux", reason="Linux only")
 @pytest.mark.mpl_image_compare(style="default", remove_text=False)
 def test_style_alice():
-    plt.rcParams.update(plt.rcParamsDefault)
-
     plt.style.use(hep.style.ALICE)
     fig, ax = plt.subplots()
     hep.alice.label("Preliminary")
@@ -63,8 +57,6 @@ def test_style_alice():
 @pytest.mark.skipif(sys.platform != "linux", reason="Linux only")
 @pytest.mark.mpl_image_compare(style="default", remove_text=False)
 def test_style_lhcb():
-    plt.rcParams.update(plt.rcParamsDefault)
-
     plt.style.use([hep.style.LHCb1, {"figure.autolayout": False}])
     fig, ax = plt.subplots()
     hep.lhcb.label("Preliminary")
@@ -74,8 +66,6 @@ def test_style_lhcb():
 @pytest.mark.skipif(sys.platform != "linux", reason="Linux only")
 @pytest.mark.mpl_image_compare(style="default", remove_text=False)
 def test_style_lhcb2():
-    plt.rcParams.update(plt.rcParamsDefault)
-
     plt.style.use([hep.style.LHCb2, {"figure.autolayout": False}])
     fig, ax = plt.subplots()
     hep.lhcb.label("Preliminary")
@@ -85,7 +75,6 @@ def test_style_lhcb2():
 @pytest.mark.skipif(sys.platform != "linux", reason="Linux only")
 @pytest.mark.mpl_image_compare(style="default", remove_text=False)
 def test_style_plothist():
-    plt.rcParams.update(plt.rcParamsDefault)
     plt.style.use(hep.style.PLOTHIST)
     fig, ax = plt.subplots()
     return fig
@@ -106,8 +95,6 @@ def test_style_plothist():
     ids=["ALICE", "ATLAS", "CMS", "LHCb1", "LHCb2", "ROOT"],
 )
 def test_use_style(fig_test, fig_ref, mplhep_style):
-    plt.rcParams.update(plt.rcParamsDefault)
-
     hep.rcParams.clear()
     plt.style.use(mplhep_style)
     fig_ref.subplots()
@@ -120,8 +107,6 @@ def test_use_style(fig_test, fig_ref, mplhep_style):
 @pytest.mark.skipif(sys.platform != "linux", reason="Linux only")
 @check_figures_equal(extensions=["pdf"])
 def test_use_style_LHCb_dep(fig_test, fig_ref):
-    plt.rcParams.update(plt.rcParamsDefault)
-
     hep.rcParams.clear()
     with pytest.warns(FutureWarning):
         plt.style.use(hep.style.LHCb)
@@ -148,8 +133,6 @@ def test_use_style_LHCb_dep(fig_test, fig_ref):
     ids=["ALICE", "ATLAS", "CMS", "LHCb", "LHCb1", "LHCb2", "ROOT"],
 )
 def test_use_style_str_alias(fig_test, fig_ref, mplhep_style, str_alias):
-    plt.rcParams.update(plt.rcParamsDefault)
-
     hep.rcParams.clear()
     plt.style.use(mplhep_style)
     fig_ref.subplots()
@@ -175,8 +158,6 @@ def test_use_style_str_alias(fig_test, fig_ref, mplhep_style, str_alias):
     ids=["ALICE", "ATLAS", "CMS", "LHCb", "LHCb1", "LHCb2", "ROOT"],
 )
 def test_use_style_self_consistent(fig_test, fig_ref, mplhep_style, str_alias):
-    plt.rcParams.update(plt.rcParamsDefault)
-
     hep.rcParams.clear()
     hep.style.use(mplhep_style)
     fig_ref.subplots()
@@ -202,8 +183,6 @@ def test_use_style_self_consistent(fig_test, fig_ref, mplhep_style, str_alias):
     ids=["ALICE", "ATLAS", "CMS", "LHCb", "LHCb1", "LHCb2", "ROOT"],
 )
 def test_use_style_style_list(fig_test, fig_ref, mplhep_style, str_alias):
-    plt.rcParams.update(plt.rcParamsDefault)
-
     hep.rcParams.clear()
     plt.style.use([mplhep_style, {"font.sans-serif": "Comic Sans MS"}])
     fig_ref.subplots()