Merge pull request #89 from StagPython/globconf

remove global `Config` instance and `scaling.dimensional`

Author: amorison

Examples/annulus/par

@@ -1,4 +1,5 @@
 &switches
+    dimensional_units = .false.
 /
 
 &geometry

docs/conf.py

@@ -20,7 +20,7 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
-import stagpy
+from stagpy.config import Config
 
 html_theme = "sphinx_rtd_theme"
 
@@ -93,7 +93,8 @@
         """
         )
     )
-    for sec_fld in fields(stagpy.conf):
+    stagpy_conf = Config.default_()
+    for sec_fld in fields(stagpy_conf):
         sec_name = sec_fld.name
         fid.write(
             dedent(
@@ -107,7 +108,7 @@
             """.format(sec_name)
             )
         )
-        section = getattr(stagpy.conf, sec_name)
+        section = getattr(stagpy_conf, sec_name)
         for fld in fields(section):
             opt = fld.name
             entry = section.meta_(opt).entry

docs/index.rst

@@ -43,6 +43,7 @@ Welcome to StagPy's documentation!
    sources/apiref/commands
    sources/apiref/config
    sources/apiref/datatypes
+   sources/apiref/dimensions
    sources/apiref/error
    sources/apiref/field
    sources/apiref/parfile

docs/sources/apiref/dimensions.rst

@@ -0,0 +1,5 @@
+dimensions
+==========
+
+.. automodule:: stagpy.dimensions
+   :members:

docs/sources/apiref/phyvars.rst

@@ -56,4 +56,4 @@ phyvars
 
       Dictionary mapping dimension strings (**dim** fields in ``Var*``) to
       functions which are themselves mapping from
-      :class:`~stagpy.stagyydata.StagyyData` to the scale for that dimension.
+      :class:`~stagpy.dimensions.Scales` to the scale for that dimension.

docs/sources/apiref/stagpy.rst

@@ -12,8 +12,3 @@ stagpy
       commits since the last stable version and the last commit hash. If you
       made modifications to the code that are not committed yet, the date of
       the last modification appears in the ``'.dYYYYMMDD'`` segment.
-
-   .. data:: conf
-
-      Global :class:`loam.manager.ConfigurationManager` instance, holding
-      configuration options.

docs/sources/apiref/stagyydata.rst

@@ -2,5 +2,5 @@ stagyydata
 =============
 
 .. automodule:: stagpy.stagyydata
-   :members: _Scales, _Refstate, _Tseries, _RprofsAveraged, _Steps, _Snaps,
-             _StepsView, StagyyData
+   :members: StagyyData
+   :private-members: _Refstate, _Tseries, _RprofsAveraged, _Steps, _Snaps, _StepsView

stagpy/__init__.py

@@ -4,65 +4,12 @@
 documentation at
 https://stagpy.readthedocs.io/en/stable/
 
-When using the CLI interface, if the environment variable STAGPY_DEBUG is set
-to a truthy value, warnings are issued normally and StagpyError are raised.
-Otherwise, warnings are ignored and only a short form of encountered
-StagpyErrors is printed.
-
-Truthy values for environment variables are 'true', 't', 'yes', 'y', 'on', '1',
-and uppercase versions of those.
+When using the CLI interface, warnings are ignored and only a short form of
+encountered StagpyErrors is printed. Set the environment variable STAGPY_DEBUG
+to issue warnings normally and raise StagpyError.
 """
 
-from __future__ import annotations
-
-import os
-import signal
-import sys
-import typing
-
-from . import config
-
-if typing.TYPE_CHECKING:
-    from typing import Any, NoReturn
-
-
-def _env(var: str) -> bool:
-    """Return whether var is set to True."""
-    val = os.getenv(var, default="").lower()
-    return val in ("true", "t", "yes", "y", "on", "1")
-
-
-DEBUG = _env("STAGPY_DEBUG")
-
-
-def sigint_handler(*_: Any) -> NoReturn:
-    """Handler of SIGINT signal.
-
-    It is set when you use StagPy as a command line tool to handle gracefully
-    keyboard interruption.
-    """
-    print("\nSo long, and thanks for all the fish.")
-    sys.exit()
-
-
-if DEBUG:
-    print(
-        "StagPy runs in DEBUG mode because the environment variable",
-        'STAGPY_DEBUG is set to "True"',
-        sep="\n",
-        end="\n\n",
-    )
-else:
-    _PREV_INT = signal.signal(signal.SIGINT, sigint_handler)
-
 try:
     from ._version import version as __version__
 except ImportError:
     __version__ = "unknown"
-
-conf = config.Config.default_()
-if config.CONFIG_LOCAL.is_file():
-    conf.update_from_file_(config.CONFIG_LOCAL)
-
-if not DEBUG:
-    signal.signal(signal.SIGINT, _PREV_INT)

stagpy/__main__.py

@@ -1,23 +1,46 @@
 """The stagpy module is callable."""
 
+from __future__ import annotations
+
+import os
 import signal
 import sys
 import warnings
+from typing import Any, NoReturn
+
 
-from . import DEBUG, sigint_handler
+def sigint_handler(*_: Any) -> NoReturn:
+    """Handler of SIGINT signal.
+
+    It is set when you use StagPy as a command line tool to handle gracefully
+    keyboard interruption.
+    """
+    print("\nSo long, and thanks for all the fish.")
+    sys.exit()
 
 
 def main() -> None:
     """Implement StagPy entry point."""
-    if not DEBUG:
+    debug = os.getenv("STAGPY_DEBUG") is not None
+    if debug:
+        print(
+            "env variable 'STAGPY_DEBUG' is set: StagPy runs in DEBUG mode",
+            end="\n\n",
+        )
+    else:
         signal.signal(signal.SIGINT, sigint_handler)
         warnings.simplefilter("ignore")
-    from . import args, error
+
+    from . import args, config, error
+
+    conf = config.Config.default_()
+    if config.CONFIG_LOCAL.is_file():
+        conf.update_from_file_(config.CONFIG_LOCAL)
 
     try:
-        args.parse_args()()
+        args.parse_args(conf)(conf)
     except error.StagpyError as err:
-        if DEBUG:
+        if debug:
             raise
         errtype = type(err).__name__
         print(

stagpy/_helpers.py

@@ -7,16 +7,24 @@
 
 import matplotlib.pyplot as plt
 
-from . import conf
-
 if typing.TYPE_CHECKING:
     from typing import Any, Optional
 
     from matplotlib.figure import Figure
     from numpy import ndarray
 
+    from .config import Config
+    from .stagyydata import StagyyData, _StepsView
+
+
+def walk(sdat: StagyyData, conf: Config) -> _StepsView:
+    """Return view on configured steps slice."""
+    if conf.core.timesteps:
+        return sdat.steps[conf.core.timesteps]
+    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:
@@ -25,9 +33,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
@@ -54,7 +59,11 @@ def scilabel(value: float, precision: int = 2) -> str:
 
 
 def saveplot(
-    fig: Figure, *name_args: Any, close: bool = True, **name_kwargs: Any
+    conf: Config,
+    fig: Figure,
+    stem: str,
+    timestep: Optional[int] = None,
+    close: bool = True,
 ) -> None:
     """Save matplotlib figure.
 
@@ -63,11 +72,11 @@ def saveplot(
 
     Args:
         fig: the :class:`matplotlib.figure.Figure` to save.
+        stem: short description of file content.
+        timestep: timestep if relevant.
         close: whether to close the figure.
-        name_args: positional arguments passed on to :func:`out_name`.
-        name_kwargs: keyword arguments passed on to :func:`out_name`.
     """
-    oname = out_name(*name_args, **name_kwargs)
+    oname = out_name(conf, stem, timestep)
     fig.savefig(
         f"{oname}.{conf.plot.format}", format=conf.plot.format, bbox_inches="tight"
     )