Merge pull request #88 from StagPython/rm-global-config

Remove global configuration folder

Author: amorison

docs/conf.py

@@ -20,9 +20,6 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
-# do not try to create/read config files
-os.environ["STAGPY_ISOLATED"] = "True"
-
 import stagpy
 
 html_theme = "sphinx_rtd_theme"

docs/sources/apiref/config.rst

@@ -4,21 +4,6 @@ config
 .. automodule:: stagpy.config
    :members:
 
-   .. data:: HOME_DIR
-      :annotation: = pathlib.Path.home()
-
-      Home directory.
-
-   .. data:: CONFIG_DIR
-      :annotation: = HOME_DIR / '.config' / 'stagpy'
-
-      StagPy configuration directory.
-
-   .. data:: CONFIG_FILE
-      :annotation: = CONFIG_DIR / 'config.toml'
-
-      Path of global configuration file.
-
    .. data:: CONFIG_LOCAL
       :annotation: = pathlib.Path('.stagpy.toml')
 

docs/sources/apiref/parfile.rst

@@ -4,11 +4,6 @@ parfile
 .. automodule:: stagpy.parfile
    :members:
 
-   .. data:: PAR_DFLT_FILE
-      :annotation: = config.CONFIG_DIR / 'par'
-
-      Path of default par file used to fill missing entries by :func:`readpar`.
-
    .. data:: PAR_DEFAULT
 
       Defaut value of all the StagYY input parameters used to fill missing

docs/sources/cli.rst

@@ -53,15 +53,5 @@ is displayed.
 
 .. option:: --create
 
-   Create a new config file from scratch. This is useful if your configuration
-   file is broken or you want to reset the modifications you made to your
-   configuration.
-
-.. option:: --update
-
-   Add missing entries to your config file (or create a new one if necessary).
-
-.. option:: --edit
-
-   Open your config file in ``vim``.
+   Create a new config file from scratch.
 

docs/sources/install.rst

@@ -32,18 +32,22 @@ for more information about installing Python packages.
 Some setup
 ----------
 
-Run the following once to create your config file (in ``~/.config/stagpy/``)::
+Run the following to create a local config file (``.stagpy.toml``)::
 
     % stagpy config --create
 
 You can enable command-line auto-completion if you use either bash or zsh.
 
-Add this to your ``~/.bashrc`` file::
+For bash::
 
-    source ~/.config/stagpy/bash/stagpy.sh
+    # adapt path as appropriate for your system
+    % mkdir -p ~/.local/share/bash-completion/completions
+    % cd !$
+    % stagpy completions --bash
 
-Or this to your ``~/.zshrc`` file::
+For zsh, with ``fpath+=~/.zfunc`` in your ``.zshrc``::
 
-    source ~/.config/stagpy/zsh/_stagpy.sh
+    % cd ~/.zfunc
+    % stagpy completions --zsh
 
 Enjoy!

docs/sources/stagyydata.rst

@@ -81,7 +81,7 @@ Parameters set in the ``par`` file are accessible through the
 a dictionary of dictionaries.  For example, to access the Rayleigh number from
 the ``refstate`` section of the par file, one can use
 ``sdat.par['refstate']['ra0']``. Parameters that are not set in the par file
-are given a default value according to the par file ``~/.config/stagpy/par``.
+are given a default value.
 
 Radial profiles
 ---------------

docs/sources/tuto.rst

@@ -112,13 +112,13 @@ use the :class:`~stagpy.stagyydata.StagyyData` class.
 Plotting style
 --------------
 
-StagPy defines two custom plotting styles for matplotlib, ``stagpy-paper`` (the
-default) and ``stagpy-slides``.  You can edit them to your convenience, they
-are in the ``~/.config/stagpy`` directory.  You can specify which style to use
-with ``plot.mplstyle``, available in the command line interface with the
-``--mplstyle`` option.  You can specify a space-separated list to combine
-several styles.  For example, if you want a dark-background figure with a
-font size adapted for slides, you can use the following command::
-
-   % stagpy field --mplstyle='dark_background stagpy-slides'
+For convenience, StagPy defines two custom plotting styles for matplotlib,
+``stagpy-paper`` (the default when using the CLI) and ``stagpy-slides``. You
+can specify which style to use with ``plot.mplstyle``, available in the command
+line interface with the ``--mplstyle`` option.  You can specify a
+comma-separated list to combine several styles.  For example, if you want a
+dark-background figure with a font size adapted for slides, you can use the
+following command::
+
+   % stagpy field --mplstyle='dark_background,stagpy-slides'
 

stagpy/__init__.py

@@ -4,9 +4,6 @@
 documentation at
 https://stagpy.readthedocs.io/en/stable/
 
-If the environment variable STAGPY_ISOLATED is set to a truthy value, StagPy
-does not attempt to read any configuration file (including mplstyle).
-
 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
@@ -18,17 +15,15 @@
 
 from __future__ import annotations
 
-import importlib.resources as imlr
 import os
-import shutil
 import signal
 import sys
 import typing
 
-from . import _styles, config
+from . import config
 
 if typing.TYPE_CHECKING:
-    from typing import Any, Iterator, NoReturn
+    from typing import Any, NoReturn
 
 
 def _env(var: str) -> bool:
@@ -38,7 +33,6 @@ def _env(var: str) -> bool:
 
 
 DEBUG = _env("STAGPY_DEBUG")
-ISOLATED = _env("STAGPY_ISOLATED")
 
 
 def sigint_handler(*_: Any) -> NoReturn:
@@ -51,28 +45,6 @@ def sigint_handler(*_: Any) -> NoReturn:
     sys.exit()
 
 
-def _iter_styles() -> Iterator[str]:
-    for resource in imlr.contents(_styles):
-        if resource.endswith(".mplstyle"):
-            yield resource
-
-
-def _check_config() -> None:
-    """Create config files as necessary."""
-    config.CONFIG_DIR.mkdir(parents=True, exist_ok=True)
-    verfile = config.CONFIG_DIR / ".version"
-    uptodate = verfile.is_file() and verfile.read_text() == __version__
-    if not uptodate:
-        verfile.write_text(__version__)
-    if not (uptodate and config.CONFIG_FILE.is_file()):
-        conf.to_file_(config.CONFIG_FILE)
-    for stfile in _iter_styles():
-        stfile_conf = config.CONFIG_DIR / stfile
-        if not (uptodate and stfile_conf.is_file()):
-            with imlr.path(_styles, stfile) as stfile_local:
-                shutil.copy(str(stfile_local), str(stfile_conf))
-
-
 if DEBUG:
     print(
         "StagPy runs in DEBUG mode because the environment variable",
@@ -89,11 +61,8 @@ def _check_config() -> None:
     __version__ = "unknown"
 
 conf = config.Config.default_()
-if not ISOLATED:
-    _check_config()
-    conf.update_from_file_(config.CONFIG_FILE)
-    if config.CONFIG_LOCAL.is_file():
-        conf.update_from_file_(config.CONFIG_LOCAL)
+if config.CONFIG_LOCAL.is_file():
+    conf.update_from_file_(config.CONFIG_LOCAL)
 
 if not DEBUG:
     signal.signal(signal.SIGINT, _PREV_INT)

stagpy/args.py

@@ -5,27 +5,25 @@
 import importlib.resources as imlr
 import typing
 from inspect import isfunction
+from pathlib import Path
 from types import MappingProxyType
 
 import matplotlib.pyplot as plt
 import matplotlib.style as mpls
 from loam.cli import CLIManager, Subcmd
 
+from . import __doc__ as doc_module
 from . import (
-    ISOLATED,
     _styles,
     commands,
     conf,
-    config,
     field,
     plates,
     refstate,
     rprof,
     time_series,
 )
-from . import __doc__ as doc_module
 from ._helpers import baredoc
-from .config import CONFIG_DIR
 
 if typing.TYPE_CHECKING:
     from typing import Any, Callable, List, Optional
@@ -47,11 +45,6 @@ def _load_mplstyle() -> None:
     """Try to load conf.plot.mplstyle matplotlib style."""
     for style in conf.plot.mplstyle:
         style_fname = style + ".mplstyle"
-        if not ISOLATED:
-            stfile = config.CONFIG_DIR / style_fname
-            if stfile.is_file():
-                mpls.use(str(stfile))
-                continue
         # try packaged version
         if imlr.is_resource(_styles, style_fname):
             with imlr.path(_styles, style_fname) as stfile:
@@ -90,14 +83,24 @@ def parse_args(arglist: Optional[List[str]] = None) -> Callable[[], None]:
     Returns:
         the function implementing the sub command to be executed.
     """
-    climan = CLIManager(conf, **SUB_CMDS)
-
-    bash_script = CONFIG_DIR / "bash" / "stagpy.sh"
-    bash_script.parent.mkdir(parents=True, exist_ok=True)
-    climan.bash_complete(bash_script, "stagpy")
-    zsh_script = CONFIG_DIR / "zsh" / "_stagpy.sh"
-    zsh_script.parent.mkdir(parents=True, exist_ok=True)
-    climan.zsh_complete(zsh_script, "stagpy", sourceable=True)
+
+    def compl_cmd() -> None:
+        if conf.completions.zsh:
+            filepath = Path("_stagpy.sh")
+            print(f"writing zsh completion file {filepath}")
+            climan.zsh_complete(filepath, "stagpy", sourceable=True)
+        elif conf.completions.bash:
+            filepath = Path("stagpy.sh")
+            print(f"writing bash completion file {filepath}")
+            climan.bash_complete(filepath, "stagpy")
+        else:
+            print("please choose a shell, `--help` for available options")
+
+    climan = CLIManager(
+        conf,
+        **SUB_CMDS,
+        completions=Subcmd("generate completion scripts", func=compl_cmd),
+    )
 
     cmd_args = climan.parse_args(arglist)
     sub_cmd = cmd_args.loam_sub_name

stagpy/commands.py

@@ -9,12 +9,11 @@
 from shutil import get_terminal_size
 from textwrap import TextWrapper, indent
 
-import loam.tools
 import pandas
 
 from . import __version__, conf, phyvars, stagyydata
 from ._helpers import baredoc
-from .config import CONFIG_FILE
+from .config import CONFIG_LOCAL
 
 if typing.TYPE_CHECKING:
     from typing import Callable, Iterable, Mapping, Optional, Sequence, Tuple, Union
@@ -200,11 +199,7 @@ def config_cmd() -> None:
     Other Parameters:
         conf.config
     """
-    if not (
-        conf.common.config
-        or conf.config.create
-        or conf.config.update
-        or conf.config.edit
-    ):
+    if conf.config.create:
+        conf.default_().to_file_(CONFIG_LOCAL)
+    else:
         config_pp(sec.name for sec in fields(conf))
-    loam.tools.config_cmd_handler(conf, conf.config, CONFIG_FILE)