Several options are sequences instead of str

Splitting is made directly via TupleEntry from loam instead of
manually from a string option.

Author: amorison

stagpy/_helpers.py

@@ -9,7 +9,7 @@
 from . import conf
 
 if TYPE_CHECKING:
-    from typing import Optional, Any, List, Callable, NoReturn
+    from typing import Optional, Any, Callable, NoReturn
     from matplotlib.figure import Figure
     from numpy import ndarray
 
@@ -89,26 +89,6 @@ def baredoc(obj: object) -> str:
     return doc.rstrip(' .').lstrip()
 
 
-def list_of_vars(arg_plot: str) -> List[List[List[str]]]:
-    """Construct list of variables per plot.
-
-    Args:
-        arg_plot: variable names separated with ``-`` (figures),
-            ``.`` (subplots) and ``,`` (same subplot).
-    Returns:
-        three nested lists of str
-
-        - variables on the same subplot;
-        - subplots on the same figure;
-        - figures.
-    """
-    lovs = [[[var for var in svars.split(',') if var]
-             for svars in pvars.split('.') if svars]
-            for pvars in arg_plot.split('-') if pvars]
-    lovs = [[slov for slov in lov if slov] for lov in lovs if lov]
-    return [lov for lov in lovs if lov]
-
-
 def find_in_sorted_arr(value: Any, array: ndarray, after: bool = False) -> int:
     """Return position of element in a sorted array.
 

stagpy/commands.py

@@ -29,7 +29,6 @@ def info_cmd() -> None:
     Other Parameters:
         conf.info
     """
-    varlist = [var for var in conf.info.output.replace(',', ' ').split()]
     sdat = stagyydata.StagyyData()
     lsnap = sdat.snaps[-1]
     lstep = sdat.steps[-1]
@@ -53,7 +52,7 @@ def info_cmd() -> None:
             print(f', snapshot {step.isnap}/{lsnap.isnap}')
         else:
             print()
-        series = step.timeinfo.loc[varlist]
+        series = step.timeinfo.loc[list(conf.info.output)]
         if conf.scaling.dimensional:
             series = series.copy()
             dimensions = []

stagpy/config.py

@@ -17,6 +17,8 @@
 
 
 _indices = TupleEntry(inner_from_toml=lprs.slice_or_int_parser)
+_plots = TupleEntry.wrapping(
+    TupleEntry.wrapping(TupleEntry(str), str_sep="."), str_sep="-")
 
 HOME_DIR = Path.home()
 CONFIG_DIR = HOME_DIR / '.config' / 'stagpy'
@@ -87,9 +89,8 @@ class Scaling(Section):
 class Field(Section):
     """Options of the field command."""
 
-    plot: str = entry(
-        val='T,stream', cli_short='o',
-        cli_kwargs={'nargs': '?', 'const': '', 'type': str},
+    plot: Sequence[Sequence[Sequence[str]]] = _plots.entry(
+        default='T,stream', cli_short='o',
         doc="variables to plot (see stagpy var)")
     perturbation: bool = switch_opt(
         False, None, "plot departure from average profile")
@@ -120,9 +121,8 @@ class Field(Section):
 class Rprof(Section):
     """Options of the rprof command."""
 
-    plot: str = entry(
-        val="Tmean", cli_short='o',
-        cli_kwargs={'nargs': '?', 'const': ''},
+    plot: Sequence[Sequence[Sequence[str]]] = _plots.entry(
+        default="Tmean", cli_short='o',
         doc="variables to plot (see stagpy var)")
     style: str = entry(val='-', doc="matplotlib line style")
     average: bool = switch_opt(False, 'a', 'plot temporal average')
@@ -134,9 +134,8 @@ class Rprof(Section):
 class Time(Section):
     """Options of the time command."""
 
-    plot: str = entry(
-        val="Nutop,ebalance,Nubot.Tmean", cli_short='o',
-        cli_kwargs={'nargs': '?', 'const': ''},
+    plot: Sequence[Sequence[Sequence[str]]] = _plots.entry(
+        default="Nutop,ebalance,Nubot.Tmean", cli_short='o',
         doc="variables to plot (see stagpy var)")
     style: str = entry(val='-', doc="matplotlib line style")
     compstat: Sequence[str] = TupleEntry(str).entry(
@@ -159,19 +158,17 @@ class Time(Section):
 class Refstate(Section):
     """Options of the refstate command."""
 
-    plot: str = entry(
-        val='T', cli_short='o', cli_kwargs={'nargs': '?', 'const': ''},
-        doc="variables to plot (see stagpy var)")
+    plot: Sequence[str] = TupleEntry(str).entry(
+        default='T', cli_short='o', doc="variables to plot (see stagpy var)")
     style: str = entry(val='-', doc="matplotlib line style")
 
 
 @dataclass
 class Plates(Section):
     """Options of the plates command."""
 
-    plot: str = entry(
-        val='c.T.v2-v2.dv2-v2.topo_top', cli_short='o',
-        cli_kwargs={'nargs': '?', 'const': ''},
+    plot: Sequence[Sequence[Sequence[str]]] = _plots.entry(
+        default='c.T.v2-v2.dv2-v2.topo_top', cli_short='o',
         doc="variables to plot, can be a surface field, field, or dv2")
     field: str = entry(val='eta', doc="field to plot with plates info")
     stress: bool = switch_opt(
@@ -192,8 +189,9 @@ class Plates(Section):
 class Info(Section):
     """Options of the info command."""
 
-    output: str = entry(val='t,Tmean,vrms,Nutop,Nubot', cli_short='o',
-                        doc="time series to print")
+    output: Sequence[str] = TupleEntry(str).entry(
+        default='t,Tmean,vrms,Nutop,Nubot', cli_short='o',
+        doc="time series to print")
 
 
 @dataclass

stagpy/field.py

@@ -344,9 +344,8 @@ def cmd() -> None:
         conf.core
     """
     sdat = StagyyData()
-    lovs = _helpers.list_of_vars(conf.field.plot)
     # no more than two fields in a subplot
-    lovs = [[slov[:2] for slov in plov] for plov in lovs]
+    lovs = [[slov[:2] for slov in plov] for plov in conf.field.plot]
     minmax = {}
     if conf.plot.cminmax:
         conf.plot.vmin = None

stagpy/plates.py

@@ -194,17 +194,18 @@ def _continents_location(snap: Step, at_surface: bool = True) -> ndarray:
     return csurf >= 2
 
 
-def plot_at_surface(snap: Step, names: str) -> None:
+def plot_at_surface(
+    snap: Step, names: Sequence[Sequence[Sequence[str]]]
+) -> None:
     """Plot surface diagnostics.
 
     Args:
         snap: a :class:`~stagpy._step.Step` of a StagyyData instance.
-        names: names of requested surface diagnotics. They are separated by
-            ``-`` (figures), ``.`` (subplots) and ``,`` (same subplot).
-            Surface diagnotics can be valid surface field names, field names,
-            or `"dv2"` which is d(vphi)/dphi.
+        names: names of requested surface diagnotics. They are organized by
+            figures, plots and subplots.  Surface diagnotics can be valid
+            surface field names, field names, or `"dv2"` which is d(vphi)/dphi.
     """
-    for vfig in _helpers.list_of_vars(names):
+    for vfig in names:
         fig, axes = plt.subplots(nrows=len(vfig), sharex=True,
                                  figsize=(12, 2 * len(vfig)))
         axes = [axes] if len(vfig) == 1 else axes

stagpy/refstate.py

@@ -44,8 +44,5 @@ def cmd() -> None:
     """
     sdat = StagyyData()
 
-    lov = conf.refstate.plot.split(',')
-    if not lov:
-        return
-    for var in lov:
+    for var in conf.refstate.plot:
         plot_ref(sdat, var)

stagpy/rprof.py

@@ -9,22 +9,24 @@
 from .stagyydata import StagyyData
 
 if typing.TYPE_CHECKING:
+    from typing import Sequence
     from ._step import Step, _Rprofs
 
 
-def plot_rprofs(rprofs: _Rprofs, names: str) -> None:
+def plot_rprofs(
+    rprofs: _Rprofs, names: Sequence[Sequence[Sequence[str]]]
+) -> None:
     """Plot requested radial profiles.
 
     Args:
         rprofs: a radial profile collection, such as :attr:`Step.rprofs` or
             :attr:`_StepsView.rprofs_averaged`.
-        names: profile names separated by ``-`` (figures), ``.`` (subplots) and
-            ``,`` (same subplot).
+        names: profile names organized by figures, plots and subplots.
     """
     stepstr = rprofs.stepstr
     sdat = rprofs.step.sdat
 
-    for vfig in _helpers.list_of_vars(names):
+    for vfig in names:
         fig, axes = plt.subplots(ncols=len(vfig), sharey=True,
                                  figsize=(4 * len(vfig), 6))
         axes = [axes] if len(vfig) == 1 else axes

stagpy/time_series.py

@@ -12,7 +12,7 @@
 from .stagyydata import StagyyData
 
 if typing.TYPE_CHECKING:
-    from typing import Optional, List
+    from typing import Optional, List, Sequence
     from pandas import DataFrame
 
 
@@ -26,20 +26,21 @@ def _collect_marks(sdat: StagyyData) -> List[float]:
     return times
 
 
-def plot_time_series(sdat: StagyyData, names: str) -> None:
+def plot_time_series(
+    sdat: StagyyData, names: Sequence[Sequence[Sequence[str]]]
+) -> None:
     """Plot requested time series.
 
     Args:
         sdat: a :class:`~stagpy.stagyydata.StagyyData` instance.
-        names: time series names separated by ``-`` (figures), ``.`` (subplots)
-            and ``,`` (same subplot).
+        names: time series names organized by figures, plots and subplots.
 
     Other Parameters:
         conf.time.tstart: the starting time.
         conf.time.tend: the ending time.
     """
     time_marks = _collect_marks(sdat)
-    for vfig in _helpers.list_of_vars(names):
+    for vfig in names:
         tstart = conf.time.tstart
         tend = conf.time.tend
         fig, axes = plt.subplots(nrows=len(vfig), sharex=True,

tests/test_helpers.py

@@ -23,8 +23,3 @@ def test_baredoc():
     """
     expected = 'Badly formatted docstring'
     assert stagpy._helpers.baredoc(test_baredoc) == expected
-
-
-def test_list_of_vars():
-    expected = [[['a', 'b'], ['c', 'd', 'e']], [['f', 'g'], ['h']]]
-    assert stagpy._helpers.list_of_vars('a,b..c,d,,,e-f,g.h-,..,-') == expected