args and cmds do not depend on global conf

Author: amorison

stagpy/__main__.py

@@ -12,10 +12,10 @@ def main() -> None:
     if not DEBUG:
         signal.signal(signal.SIGINT, sigint_handler)
         warnings.simplefilter("ignore")
-    from . import args, error
+    from . import args, conf, error
 
     try:
-        args.parse_args()()
+        args.parse_args(conf)(conf)
     except error.StagpyError as err:
         if DEBUG:
             raise

stagpy/args.py

@@ -16,14 +16,14 @@
 from . import (
     _styles,
     commands,
-    conf,
     field,
     plates,
     refstate,
     rprof,
     time_series,
 )
 from ._helpers import baredoc
+from .config import Config
 
 if typing.TYPE_CHECKING:
     from typing import Any, Callable, List, Optional
@@ -35,13 +35,13 @@ def _sub(cmd: Any, *sections: str) -> Subcmd:
     return Subcmd(baredoc(cmd), *sections, func=cmd_func)
 
 
-def _bare_cmd() -> None:
+def _bare_cmd(conf: Config) -> None:
     """Print help message when no arguments are given."""
     print(doc_module)
     print("Run `stagpy -h` for usage")
 
 
-def _load_mplstyle() -> None:
+def _load_mplstyle(conf: Config) -> None:
     """Try to load conf.plot.mplstyle matplotlib style."""
     for style in conf.plot.mplstyle:
         style_fname = style + ".mplstyle"
@@ -71,11 +71,11 @@ def _load_mplstyle() -> None:
 )
 
 
-def parse_args(arglist: Optional[List[str]] = None) -> Callable[[], None]:
+def parse_args(
+    conf: Config, arglist: Optional[List[str]] = None
+) -> Callable[[Config], None]:
     """Parse cmd line arguments.
 
-    Update :attr:`stagpy.conf` accordingly.
-
     Args:
         arglist: the list of cmd line arguments. If set to None, the arguments
             are taken from :attr:`sys.argv`.
@@ -84,7 +84,7 @@ def parse_args(arglist: Optional[List[str]] = None) -> Callable[[], None]:
         the function implementing the sub command to be executed.
     """
 
-    def compl_cmd() -> None:
+    def compl_cmd(conf: Config) -> None:
         if conf.completions.zsh:
             filepath = Path("_stagpy.sh")
             print(f"writing zsh completion file {filepath}")
@@ -111,6 +111,6 @@ def compl_cmd() -> None:
     if conf.common.config:
         commands.config_pp(climan.sections_list(sub_cmd), conf)
 
-    _load_mplstyle()
+    _load_mplstyle(conf)
 
     return cmd_args.func

stagpy/commands.py

@@ -21,14 +21,12 @@
     from .datatypes import Varf, Varr, Vart
 
 
-def info_cmd() -> None:
+def info_cmd(conf: Config) -> None:
     """Print basic information about StagYY run.
 
     Other Parameters:
         conf.info
     """
-    from . import conf
-
     sdat = stagyydata.StagyyData(conf.core.path)
     lsnap = sdat.snaps[-1]
     lstep = sdat.steps[-1]
@@ -114,14 +112,12 @@ def _layout(
     _pretty_print(desc, min_col_width=26)
 
 
-def var_cmd() -> None:
+def var_cmd(conf: Config) -> None:
     """Print a list of available variables.
 
     See :mod:`stagpy.phyvars` where the lists of variables organized by command
     are defined.
     """
-    from . import conf
-
     print_all = not any(getattr(conf.var, fld.name) for fld in fields(conf.var))
     if print_all or conf.var.field:
         print("field:")
@@ -145,7 +141,7 @@ def var_cmd() -> None:
         print()
 
 
-def version_cmd() -> None:
+def version_cmd(conf: Config) -> None:
     """Print StagPy version.
 
     Use :data:`stagpy.__version__` to obtain the version in a script.
@@ -177,14 +173,12 @@ def config_pp(subs: Iterable[str], conf: Config) -> None:
             print()
 
 
-def config_cmd() -> None:
+def config_cmd(conf: Config) -> None:
     """Configuration handling.
 
     Other Parameters:
         conf.config
     """
-    from . import conf
-
     if conf.config.create:
         conf.default_().to_file_(CONFIG_LOCAL)
     else:

stagpy/field.py

@@ -354,15 +354,8 @@ def _findminmax(
     return minmax
 
 
-def cmd() -> None:
-    """Implementation of field subcommand.
-
-    Other Parameters:
-        conf.field
-        conf.core
-    """
-    from . import conf
-
+def cmd(conf: Config) -> None:
+    """Implementation of field subcommand."""
     sdat = StagyyData(conf.core.path)
     view = _helpers.walk(sdat, conf)
     # no more than two fields in a subplot

stagpy/plates.py

@@ -394,17 +394,8 @@ def plot_scalar_field(
         saveplot(conf, fig, f"plates_zoom_{fieldname}", snap.isnap)
 
 
-def cmd() -> None:
-    """Implementation of plates subcommand.
-
-    Other Parameters:
-        conf.plates
-        conf.scaling
-        conf.plot
-        conf.core
-    """
-    from . import conf
-
+def cmd(conf: Config) -> None:
+    """Implementation of plates subcommand."""
     sdat = StagyyData(conf.core.path)
     view = _helpers.walk(sdat, conf)
 

stagpy/refstate.py

@@ -42,15 +42,8 @@ def plot_ref(sdat: StagyyData, var: str, conf: Optional[Config] = None) -> None:
     _helpers.saveplot(conf, fig, f"refstate_{var}")
 
 
-def cmd() -> None:
-    """Implementation of refstate subcommand.
-
-    Other Parameters:
-        conf.core
-        conf.plot
-    """
-    from . import conf
-
+def cmd(conf: Config) -> None:
+    """Implementation of refstate subcommand."""
     sdat = StagyyData(conf.core.path)
 
     for var in conf.refstate.plot:

stagpy/rprof.py

@@ -91,15 +91,13 @@ def plot_grid(step: Step, conf: Optional[Config] = None) -> None:
     _helpers.saveplot(conf, fig, "grid", step.istep)
 
 
-def cmd() -> None:
+def cmd(conf: Config) -> None:
     """Implementation of rprof subcommand.
 
     Other Parameters:
         conf.rprof
         conf.core
     """
-    from . import conf
-
     sdat = StagyyData(conf.core.path)
     view = _helpers.walk(sdat, conf)
 

stagpy/time_series.py

@@ -124,15 +124,13 @@ def compstat(
     return stats
 
 
-def cmd() -> None:
+def cmd(conf: Config) -> None:
     """Implementation of time subcommand.
 
     Other Parameters:
         conf.time
         conf.core
     """
-    from . import conf
-
     sdat = StagyyData(conf.core.path)
     if sdat.tseries is None:
         return

tests/test_args.py

@@ -3,11 +3,14 @@
 import pytest
 from pytest import CaptureFixture
 
-import stagpy.args
+import stagpy
+from stagpy.args import parse_args
+from stagpy.config import Config
 
 
 def test_no_args(capsys: CaptureFixture) -> None:
-    stagpy.args.parse_args([])()
+    conf = Config.default_()
+    parse_args(conf, [])(conf)
     output = capsys.readouterr()
     expected = re.compile(
         r"StagPy is a tool to.*" r"Run `stagpy -h` for usage\n$", flags=re.DOTALL
@@ -16,8 +19,9 @@ def test_no_args(capsys: CaptureFixture) -> None:
 
 
 def test_help(capsys: CaptureFixture) -> None:
+    conf = Config.default_()
     with pytest.raises(SystemExit):
-        stagpy.args.parse_args(["-h"])
+        parse_args(conf, ["-h"])
     output = capsys.readouterr()
     expected = re.compile(
         r"^usage:.*\nStagPy is a tool to.*\n"
@@ -29,8 +33,9 @@ def test_help(capsys: CaptureFixture) -> None:
 
 
 def test_invalid_argument(capsys: CaptureFixture) -> None:
+    conf = Config.default_()
     with pytest.raises(SystemExit):
-        stagpy.args.parse_args(["-dummyinvalidarg"])
+        parse_args(conf, ["-dummyinvalidarg"])
     output = capsys.readouterr()
     expected = re.compile(
         r"^usage: .*error: unrecognized arguments:.*\n$", flags=re.DOTALL
@@ -39,48 +44,57 @@ def test_invalid_argument(capsys: CaptureFixture) -> None:
 
 
 def test_invalid_subcmd(capsys: CaptureFixture) -> None:
+    conf = Config.default_()
     with pytest.raises(SystemExit):
-        stagpy.args.parse_args(["dummyinvalidcmd"])
+        parse_args(conf, ["dummyinvalidcmd"])
     output = capsys.readouterr()
     expected = re.compile(r"^usage: .*error:.*invalid choice:.*\n$", flags=re.DOTALL)
     assert expected.fullmatch(output.err)
 
 
 def test_field_subcmd() -> None:
-    func = stagpy.args.parse_args(["field"])
+    conf = Config.default_()
+    func = parse_args(conf, ["field"])
     assert func is stagpy.field.cmd
 
 
 def test_rprof_subcmd() -> None:
-    func = stagpy.args.parse_args(["rprof"])
+    conf = Config.default_()
+    func = parse_args(conf, ["rprof"])
     assert func is stagpy.rprof.cmd
 
 
 def test_time_cmd() -> None:
-    func = stagpy.args.parse_args(["time"])
+    conf = Config.default_()
+    func = parse_args(conf, ["time"])
     assert func is stagpy.time_series.cmd
 
 
 def test_plates_subcmd() -> None:
-    func = stagpy.args.parse_args(["plates"])
+    conf = Config.default_()
+    func = parse_args(conf, ["plates"])
     assert func is stagpy.plates.cmd
 
 
 def test_info_subcmd() -> None:
-    func = stagpy.args.parse_args(["info"])
+    conf = Config.default_()
+    func = parse_args(conf, ["info"])
     assert func is stagpy.commands.info_cmd
 
 
 def test_var_subcmd() -> None:
-    func = stagpy.args.parse_args(["var"])
+    conf = Config.default_()
+    func = parse_args(conf, ["var"])
     assert func is stagpy.commands.var_cmd
 
 
 def test_version_subcmd() -> None:
-    func = stagpy.args.parse_args(["version"])
+    conf = Config.default_()
+    func = parse_args(conf, ["version"])
     assert func is stagpy.commands.version_cmd
 
 
 def test_config_subcmd() -> None:
-    func = stagpy.args.parse_args(["config"])
+    conf = Config.default_()
+    func = parse_args(conf, ["config"])
     assert func is stagpy.commands.config_cmd

tests/test_commands.py

@@ -3,36 +3,37 @@
 
 from pytest import CaptureFixture
 
-import stagpy.commands
+from stagpy import __version__, commands
+from stagpy.config import Config
 
 
 def test_info_cmd(capsys: CaptureFixture, example_dir: Path) -> None:
-    stagpy.conf.core.path = example_dir
-    stagpy.commands.info_cmd()
+    conf = Config.default_()
+    conf.core.path = example_dir
+    commands.info_cmd(conf)
     output = capsys.readouterr()
     expected = re.compile(
         r"^StagYY run in.*\n.* x .*\n\nStep.*, snapshot.*\n  t.*\n\n$", flags=re.DOTALL
     )
     assert expected.fullmatch(output.out)
-    del stagpy.conf.core.path
 
 
 def test_var_cmd(capsys: CaptureFixture) -> None:
-    stagpy.commands.var_cmd()
+    commands.var_cmd(Config.default_())
     output = capsys.readouterr()
     expected = re.compile(r"field:\n.*\nrprof:\n.*\ntime:\n.*\n.*$", flags=re.DOTALL)
     assert expected.fullmatch(output.out)
 
 
 def test_version_cmd(capsys: CaptureFixture) -> None:
-    stagpy.commands.version_cmd()
+    commands.version_cmd(Config.default_())
     output = capsys.readouterr()
-    expected = "stagpy version: {}\n".format(stagpy.__version__)
+    expected = "stagpy version: {}\n".format(__version__)
     assert output.out == expected
 
 
 def test_config_cmd(capsys: CaptureFixture) -> None:
-    stagpy.commands.config_cmd()
+    commands.config_cmd(Config.default_())
     output = capsys.readouterr()
     expected = "(c|f): available only as CLI argument/in the config file"
     assert output.out.startswith(expected)