_helpers: no longer depend on global conf

Author: amorison

stagpy/_helpers.py

@@ -7,8 +7,6 @@
 
 import matplotlib.pyplot as plt
 
-from . import conf
-
 if typing.TYPE_CHECKING:
     from typing import Any, Optional
 
@@ -31,7 +29,7 @@ def walk(sdat: StagyyData, conf: Config) -> _StepsView:
     return sdat.snaps[conf.core.snapshots]
 
 
-def out_name(stem: str, timestep: Optional[int] = None) -> str:
+def out_name(conf: Config, stem: str, timestep: Optional[int] = None) -> str:
     """Return StagPy out file name.
 
     Args:
@@ -40,9 +38,6 @@ def out_name(stem: str, timestep: Optional[int] = None) -> str:
 
     Returns:
         the output file name.
-
-    Other Parameters:
-        conf.core.outname: the generic name stem, defaults to ``'stagpy'``.
     """
     if conf.core.shortname:
         return conf.core.outname
@@ -69,6 +64,7 @@ def scilabel(value: float, precision: int = 2) -> str:
 
 
 def saveplot(
+    conf: Config,
     fig: Figure,
     stem: str,
     timestep: Optional[int] = None,
@@ -85,7 +81,7 @@ def saveplot(
         timestep: timestep if relevant.
         close: whether to close the figure.
     """
-    oname = out_name(stem, timestep)
+    oname = out_name(conf, stem, timestep)
     fig.savefig(
         f"{oname}.{conf.plot.format}", format=conf.plot.format, bbox_inches="tight"
     )

stagpy/field.py

@@ -399,4 +399,4 @@ def cmd() -> None:
                 )
             oname = "_".join(chain.from_iterable(vfig))
             plt.tight_layout(w_pad=3)
-            _helpers.saveplot(fig, oname, step.isnap)
+            _helpers.saveplot(conf, fig, oname, step.isnap)

stagpy/plates.py

@@ -262,7 +262,7 @@ def plot_at_surface(
                 axis.legend()
         axes[-1].set_xlabel(r"$\phi$")
         axes[-1].set_xlim(snap.geom.p_walls[[0, -1]])
-        saveplot(fig, fname, snap.isnap)
+        saveplot(conf, fig, fname, snap.isnap)
 
 
 def _write_trench_diagnostics(
@@ -367,7 +367,13 @@ def plot_scalar_field(
     # Put arrow where ridges and trenches are
     _plot_plate_limits_field(axis, snap, conf)
 
-    saveplot(fig, f"plates_{fieldname}", snap.isnap, close=conf.plates.zoom is None)
+    saveplot(
+        conf,
+        fig,
+        f"plates_{fieldname}",
+        snap.isnap,
+        close=conf.plates.zoom is None,
+    )
 
     # Zoom
     if conf.plates.zoom is not None:
@@ -385,7 +391,7 @@ def plot_scalar_field(
         yzoom = (snap.geom.rcmb + 1) * np.sin(np.radians(conf.plates.zoom))
         axis.set_xlim(xzoom - ladd, xzoom + radd)
         axis.set_ylim(yzoom - dadd, yzoom + uadd)
-        saveplot(fig, f"plates_zoom_{fieldname}", snap.isnap)
+        saveplot(conf, fig, f"plates_zoom_{fieldname}", snap.isnap)
 
 
 def cmd() -> None:
@@ -408,7 +414,7 @@ def cmd() -> None:
     time = []
     istart, iend = None, None
 
-    oname = _helpers.out_name(f"plates_trenches_{view.stepstr}")
+    oname = _helpers.out_name(conf, f"plates_trenches_{view.stepstr}")
     with open(f"{oname}.dat", "w") as fid:
         fid.write(
             "#  istep     time   time_My   phi_trench  vel_trench  "
@@ -436,11 +442,11 @@ def cmd() -> None:
                 axis.hist(plate_sizes, 10, (0, np.pi))
                 axis.set_ylabel("Number of plates")
                 axis.set_xlabel(r"$\phi$-span")
-                saveplot(fig, "plates_size_distribution", step.isnap)
+                saveplot(conf, fig, "plates_size_distribution", step.isnap)
 
         if conf.plates.nbplates:
             figt, axis = plt.subplots()
             axis.plot(time, nb_plates)
             axis.set_xlabel("Time")
             axis.set_ylabel("Number of plates")
-            saveplot(figt, f"plates_{istart}_{iend}")
+            saveplot(conf, figt, f"plates_{istart}_{iend}")

stagpy/refstate.py

@@ -39,7 +39,7 @@ def plot_ref(sdat: StagyyData, var: str, conf: Optional[Config] = None) -> None:
     axis.set_ylabel("z Position")
     if len(adbts) > 2:
         axis.legend()
-    _helpers.saveplot(fig, f"refstate_{var}")
+    _helpers.saveplot(conf, fig, f"refstate_{var}")
 
 
 def cmd() -> None:

stagpy/rprof.py

@@ -66,10 +66,10 @@ def plot_rprofs(
             axes[0].invert_yaxis()
         ylabel = "Depth" if conf.rprof.depth else "Radius"
         axes[0].set_ylabel(ylabel)
-        _helpers.saveplot(fig, fname + stepstr)
+        _helpers.saveplot(conf, fig, fname + stepstr)
 
 
-def plot_grid(step: Step) -> None:
+def plot_grid(step: Step, conf: Optional[Config] = None) -> None:
     """Plot cell position and thickness.
 
     The figure is call grid_N.pdf where N is replace by the step index.
@@ -78,6 +78,8 @@ def plot_grid(step: Step) -> None:
         step (:class:`~stagpy._step.Step`): a step of a StagyyData
             instance.
     """
+    if conf is None:
+        conf = Config.default_()
     drprof = step.rprofs["dr"]
     fig, (ax1, ax2) = plt.subplots(2, sharex=True)
     ax1.plot(drprof.rad, "-ko")
@@ -86,7 +88,7 @@ def plot_grid(step: Step) -> None:
     ax2.set_ylabel("$dr$")
     ax2.set_xlim([-0.5, len(drprof.rad) - 0.5])
     ax2.set_xlabel("Cell number")
-    _helpers.saveplot(fig, "grid", step.istep)
+    _helpers.saveplot(conf, fig, "grid", step.istep)
 
 
 def cmd() -> None:
@@ -103,7 +105,7 @@ def cmd() -> None:
 
     if conf.rprof.grid:
         for step in view.filter(rprofs=True):
-            plot_grid(step)
+            plot_grid(step, conf)
 
     if conf.rprof.average:
         plot_rprofs(view.rprofs_averaged, conf.rprof.plot, conf)

stagpy/time_series.py

@@ -91,7 +91,7 @@ def plot_time_series(
         axes[-1].set_xlabel("Time")
         axes[-1].set_xlim(tstart, tend)
         axes[-1].tick_params()
-        _helpers.saveplot(fig, "_".join(fname))
+        _helpers.saveplot(conf, fig, "_".join(fname))
 
 
 def compstat(

tests/test_helpers.py

@@ -1,6 +1,5 @@
 import pytest
 
-import stagpy
 from stagpy import _helpers
 from stagpy.config import Config
 from stagpy.stagyydata import StagyyData
@@ -15,15 +14,16 @@ def test_walk_dflt(sdat: StagyyData) -> None:
 
 
 def test_out_name_conf() -> None:
+    conf = Config.default_()
     oname = "something_fancy"
-    stagpy.conf.core.outname = oname
+    conf.core.outname = oname
     stem = "teapot"
-    assert _helpers.out_name(stem) == oname + "_" + stem
-    del stagpy.conf.core.outname
+    assert _helpers.out_name(conf, stem) == oname + "_" + stem
 
 
 def test_out_name_number() -> None:
-    assert _helpers.out_name("T", 123) == "stagpy_T00123"
+    conf = Config.default_()
+    assert _helpers.out_name(conf, "T", 123) == "stagpy_T00123"
 
 
 def test_baredoc() -> None: