Merge pull request #16 from sarnold/cleanup-bits

more config

Author: sarnold

.github/workflows/coverage.yml

@@ -125,7 +125,7 @@ jobs:
 
   cov_data:
     name: Generate test coverage data
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     permissions:
       contents: read
       pull-requests: write
@@ -137,7 +137,7 @@ jobs:
       coverage: ${{ steps.coverage.outputs.coverage }}
       coverage-rounded-display: ${{ steps.coverage.outputs.coverage-rounded-display }}
     env:
-      PLATFORM: ubuntu-20.04
+      PLATFORM: ubuntu-22.04
       PYTHON: '3.11'
       PYTHONIOENCODING: utf-8
       PIP_DOWNLOAD_CACHE: ${{ github.workspace }}/../.pip_download_cache

.pre-commit-config.yaml

@@ -48,7 +48,9 @@ repos:
         - --follow-imports=normal
         - --install-types
         - --non-interactive
-        - --ignore-missing-imports
+      additional_dependencies:
+        - "munch[yaml]"
+        - "munch-stubs @ git+https://github.com/VCTLabs/munch-stubs.git@main"
       files: procman/
 
   - repo: "https://github.com/asottile/blacken-docs"

docs/source/conf.py

@@ -13,6 +13,8 @@
 import os
 import sys
 
+from datetime import datetime
+
 if sys.version_info < (3, 8):
     from importlib_metadata import version
 else:
@@ -22,20 +24,22 @@
 
 # -- Project information -----------------------------------------------------
 
+# The full version, including alpha/beta/rc tags with setuptols-scm
+# workaround for extra-long dirty version string
+release = version('procman').split("+")[0]
+# screw the short X.Y version.
+version = release
+
 project = 'procman'
-copyright = '2023, Stephen L Arnold'
 author = 'Stephen Arnold'
-
-# The full version, including alpha/beta/rc tags
-release = version('procman')
-# The short X.Y version.
-version = '.'.join(release.split('.')[:2])
+copyright = '2023 - ' + str(datetime.now().year) + f' {author}'
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
 # needs_sphinx = '1.0'
+#needs_sphinx = "8.2.0"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -44,27 +48,33 @@
     'sphinx_git',
     'sphinxcontrib.apidoc',
     'sphinx.ext.autodoc',
+    'sphinx.ext.autodoc.typehints',
     'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
     'recommonmark',
 ]
 
-apidoc_module_dir = '../../procman/'
+# sphinxcontrib.apidoc
+apidoc_module_dir = '../../procman'
 apidoc_output_dir = 'api'
 apidoc_excluded_paths = ['tests']
+apidoc_include_private = True
 apidoc_separate_modules = True
 
+autodoc_typehints = 'description'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 # The master toctree document.
 master_doc = 'index'
@@ -86,19 +96,28 @@
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+#pygments_style = 'sphinx'
+pygments_style = 'manni'
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
+#html_theme = 'classic'  # still has a version
 html_theme = 'sphinx_rtd_theme'
 
+html_sidebars = {
+    '**': [
+        'searchfield.html',
+        'globaltoc.html',
+        'relations.html',
+    ]
+}
+
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
@@ -115,12 +134,12 @@
 #
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
-    '**': [
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-    ]
-}
+# html_sidebars = {
+    # '**': [
+        # 'relations.html',  # needs 'show_related': True theme option to display
+        # 'searchbox.html',
+    # ]
+# }
 
 
 # -- Options for HTMLHelp output ------------------------------------------

mypy.ini

@@ -0,0 +1,6 @@
+[mypy]
+warn_return_any = True
+warn_unused_configs = True
+
+[mypy-honcho.manager]
+ignore_missing_imports = True

procman/procman.py

@@ -7,12 +7,14 @@
 import logging
 import sys
 import warnings
+from pathlib import Path
 from threading import Timer
 
 from honcho.manager import Manager
 from munch import Munch
 
-from .utils import VERSION, get_userscripts, load_config
+from . import __version__ as VERSION
+from .utils import get_userscripts, load_config
 
 # from logging_tree import printout  # debug logger environment
 
@@ -54,10 +56,11 @@ def show_paths():
         print(mod.__doc__)
 
         print("User cfg file:")
-        _, cfg = mod.load_config()
-        print(f'  {cfg.resolve()}')
+        ucfg, cfg = mod.load_config()
+        cfgfile = cfg.resolve() if cfg.exists() else None
+        print(f'  {cfgfile}')
         print("User scripts:")
-        for item in mod.get_userscripts():
+        for item in mod.get_userscripts(ucfg, cfg):
             print(f'  {item}')
 
     except (NameError, KeyError, ModuleNotFoundError) as exc:
@@ -91,7 +94,7 @@ def main(argv=None):  # pragma: no cover
     parser.add_argument(
         '-d',
         '--dump-config',
-        help="dump active yaml configuration to stdout",
+        help="Dump active yaml configuration to stdout",
         action='store_true',
         dest="dump",
     )
@@ -101,7 +104,14 @@ def main(argv=None):  # pragma: no cover
         type=int,
         default='0',
         dest="runfor",
-        help="Runtime STOP timer in seconds - 0 means run until whenever",
+        help="Runtime STOP timer in seconds - 0 means run forever",
+    )
+    parser.add_argument(
+        'file',
+        nargs='?',
+        metavar="FILE",
+        type=str,
+        help="Path to user-defined yaml configuration",
     )
 
     args = parser.parse_args()
@@ -111,22 +121,30 @@ def main(argv=None):  # pragma: no cover
     logging.basicConfig(stream=sys.stdout, level=log_level)
     # printout()  # logging_tree
 
-    ucfg, ufile = load_config()
-    uscripts = get_userscripts(demo_mode=args.demo)
-
-    if len(argv) == 1 and not ufile.exists():
-        parser.print_help()
-        print('\nNo cfg file found; use the --demo arg or create a cfg file')
-        sys.exit(1)
     if args.show:
         show_paths()
         sys.exit(0)
-    if args.dump:
-        sys.stdout.write(Munch.toYAML(ucfg))
-        sys.exit(0)
     if args.test:
         self_test()
         sys.exit(0)
+    infile = args.file
+    if infile and not Path(infile).exists():
+        print(f'Input file {infile} not found!')
+        sys.exit(1)
+    if infile:
+        ufile = Path(infile)
+        ucfg, _ = load_config(ufile=infile)
+    else:
+        ucfg, ufile = load_config()
+    uscripts = get_userscripts(ucfg, ufile, demo_mode=args.demo)
+
+    if args.dump:
+        sys.stdout.write(Munch.toYAML(ucfg))
+        sys.exit(0)
+    if len(argv) == 1 and not ufile.exists():
+        parser.print_help()
+        print('\nNo cfg file found; use the --demo arg or create a cfg file')
+        sys.exit(1)
 
     mgr = Manager()
     for user_proc in uscripts:

procman/utils.py

@@ -6,46 +6,45 @@
 import os
 import sys
 from pathlib import Path
+from typing import List, Tuple
 
 from munch import Munch
 
-if sys.version_info < (3, 8):
-    from importlib_metadata import version
-else:
-    from importlib.metadata import version
-
 if sys.version_info < (3, 10):
-    import importlib_resources
+    import importlib_resources  # type: ignore[import-not-found]
 else:
     import importlib.resources as importlib_resources
 
-VERSION = version('procman')
-
 
 class FileTypeError(Exception):
     """Raise when the file extension is not '.yml' or '.yaml'"""
 
     __module__ = Exception.__module__
 
 
-def load_config(file_encoding='utf-8', file_extension='.yaml'):
+def load_config(
+    ufile: str = '', file_encoding: str = 'utf-8', file_extension: str = '.yaml'
+) -> Tuple[Munch, Path]:
     """
     Load yaml configuration file and munchify the data. If ENV path or local
     file is not found in current directory, the default cfg will be loaded.
 
+    :param ufile: path string for config file
+    :type ufile: str
     :param file_encoding: file encoding of config file
     :type file_encoding: str
     :param file_extension: file extension with leading separator
     :type file_extension: str
-    :return tuple: Munch cfg obj, Path obj
+    :return: Munch and Path objects
     :raises FileTypeError: if the input file is not yml
     """
     proc_cfg = os.getenv('PROCMAN_CFG', default='')
-    defconfig_file = f'.procman{file_extension}'
+    defconfig_file = ufile or f'.procman{file_extension}'
 
     cfgfile = Path(proc_cfg) if proc_cfg else Path(defconfig_file)
     if not cfgfile.name.lower().endswith(('.yml', '.yaml')):
-        raise FileTypeError(f"FileTypeError: unknown file extension: {cfgfile.name}")
+        msg = 'invalid YAML extension: %s' % cfgfile.name
+        raise (FileTypeError(msg))
     if not cfgfile.exists():
         cfgobj = load_base_config()
     else:
@@ -55,22 +54,23 @@ def load_config(file_encoding='utf-8', file_extension='.yaml'):
     return cfgobj, cfgfile.resolve()
 
 
-def get_userscripts(demo_mode=False, file_encoding='utf-8', file_extension='.yaml'):
+def get_userscripts(usr_cfg: Munch, usr_file: Path, demo_mode: bool = False) -> List[str]:
     """
     Get user scripts from Munchified user cfg.
 
     :return: list of scripts
     """
-    uscripts = []
-    usr_cfg, usr_file = load_config(file_encoding, file_extension)
+    uscripts: List = []
     ucfg = load_base_config() if not usr_file.exists() or demo_mode else usr_cfg
     for item in [x for x in ucfg.scripts if x.proc_enable]:
         proc_list = [item.proc_label]
         if demo_mode:
             if getattr(sys, 'frozen', False):
                 scripts_path = os.path.join(os.path.dirname(sys.executable), 'procman')
             else:
-                scripts_path = importlib_resources.files('procman')
+                pkg_path = importlib_resources.files('procman')
+                with importlib_resources.as_file(pkg_path) as path:
+                    scripts_path = str(path)
             proc_str = (
                 f'{item.proc_runner} ' if item.proc_runner else ''
             ) + f'{os.path.join(scripts_path, item.proc_dir, item.proc_name)}'
@@ -92,7 +92,7 @@ def get_userscripts(demo_mode=False, file_encoding='utf-8', file_extension='.yam
     return uscripts
 
 
-def load_base_config():
+def load_base_config() -> Munch:
     """
     Load initial procman config with our baseline example values. This is
     used to both run the example flask app and provide a user-facing example

pyproject.toml

@@ -15,6 +15,7 @@ log_cli =  true
 doctest_optionflags = ["ELLIPSIS", "NORMALIZE_WHITESPACE",]
 addopts = "--strict-markers"
 markers = "subscript"
+filterwarnings = ["ignore:currentThread:DeprecationWarning",]
 
 [tool.coverage.run]
 branch = true
@@ -31,7 +32,7 @@ omit = [
 source = ["procman"]
 
 [tool.coverage.report]
-fail_under = 10
+fail_under = 70
 show_missing = true
 
 [tool.black]

setup.cfg

@@ -49,7 +49,7 @@ doc =
     sphinx
     sphinx_git
     recommonmark
-    sphinx_rtd_theme
+    sphinx_rtd_theme<3.0
     sphinxcontrib-apidoc
 test =
     pytest

tests/test_misc.py

@@ -39,13 +39,14 @@ def test_load_config_bogus(monkeypatch):
     monkeypatch.setenv("PROCMAN_CFG", "testme.txt")
     with pytest.raises(FileTypeError) as excinfo:
         _, pfile = load_config()
-    assert 'unknown file extension' in str(excinfo.value)
+    assert 'invalid YAML extension' in str(excinfo.value)
     assert 'testme.txt' in str(excinfo.value)
 
 
 def test_get_userscripts():
-    uscripts = get_userscripts(True)
-    # print(uscripts)
+    popts, pfile = load_config()
+    uscripts = get_userscripts(popts, pfile, True)
+    print(uscripts)
 
     assert isinstance(uscripts, list)
     assert len(uscripts) == 2