feat: add CI configuration for testing and publishing; update version to 0.0.69

Author: dbotwinick

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags: ['v*']
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest pytest-cov python-dotenv
+          pip install -e .
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short
+
+  publish:
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build tools
+        run: python -m pip install --upgrade pip build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

scitrera_app_framework/core/plugins.py

@@ -5,7 +5,7 @@
 from logging import Logger
 from typing import Type, Iterable, Any, Optional
 
-from ..api import Variables, Plugin
+from ..api import Variables, Plugin, ext_parse_bool
 from .core import _get_default_vars_instance, get_logger
 
 _VAR_ASYNC_LOOP = '=|async_loop|'
@@ -14,6 +14,13 @@
 _NOT_INIT = object()
 
 
+def _plugin_logger(v: Variables = None) -> Logger:
+    logger = get_logger(v, name='plugins')
+    if not v.environ('SAF_DEBUG_PLUGINS', type_fn=ext_parse_bool, default=False):
+        logger.setLevel('INFO')
+    return logger
+
+
 def _plugin_registry(v: Variables = None) -> Variables:
     return v.get_or_set('=|PR|', value_fn=Variables)
 
@@ -64,8 +71,12 @@ def _init_plugin(name, v: Variables = None, _requested_by=None, _now=False, asyn
     er = _impl_registry(v)
     ext_name = plugin.extension_point_name(v)
 
+    # setup logger and announce (debug)
+    logger = _plugin_logger(v)
+
     # note that this approach means that a plugin cannot simultaneous be single & multi!
     if ext_name in er:  # return extension point registry result if plugin is marked as initialized
+        logger.debug('returning cached extension point result for plugin "%s"', name)
         return er[ext_name]
 
     is_single = plugin.is_enabled(v)
@@ -74,16 +85,15 @@ def _init_plugin(name, v: Variables = None, _requested_by=None, _now=False, asyn
     if not (is_single or is_multi):  # abort init of this plugin if it is disabled
         return
 
+    logger.debug('preparing to init plugin "%s" for extension point "%s", single=%s, multi=%s', name, ext_name, is_single, is_multi)
+
     # maintain expanding set of upstream extension point requests
     if _requested_by is None:
         _requested_by = {ext_name}
     else:
         _requested_by = _requested_by.copy()
         _requested_by.add(ext_name)
 
-    # setup logger and announce (debug)
-    logger = get_logger(v)  # TODO: decide logger context/name (and levels)
-
     # go through dependencies and try to initialize them as needed
     deps = plugin.get_dependencies(v)
     for dep in deps:
@@ -152,7 +162,7 @@ def shutdown_all_plugins(v: Variables = None, async_enabled: Optional[bool] = No
 
     pr = _plugin_registry(v)
     er = _impl_registry(v)
-    logger = get_logger(v)
+    logger = _plugin_logger(v)
     for plugin in reversed(pr.get_or_set('=|STARTUP_ORDER|', value_fn=list)):  # type: Plugin
         if plugin.initialized:
             name = plugin.name()
@@ -212,8 +222,8 @@ def register_plugin(plugin_type: Type[Plugin], v: Variables = None, init=False):
         is_single = instance.is_enabled(v)
         is_multi = instance.is_multi_extension(v)
 
-        get_logger(v).debug('Registering plugin: "%s" for extension point "%s", single=%s, multi=%s',
-                            name, ext_name, is_single, is_multi)
+        _plugin_logger(v).debug('Registering plugin: "%s" for extension point "%s", single=%s, multi=%s',
+                                name, ext_name, is_single, is_multi)
         pr[name] = instance
 
         # call on_registration hook (only called once, on first registration)
@@ -455,7 +465,7 @@ async def async_plugins_ready(v: Variables = None, *, capture_loop: bool = True)
     if capture_loop:
         capture_async_loop(v)
 
-    logger = get_logger(v)
+    logger = _plugin_logger(v)
     pr = _plugin_registry(v)
     startup_order = pr.get_or_set('=|STARTUP_ORDER|', value_fn=list)
 
@@ -486,7 +496,7 @@ async def async_plugins_stopping(v: Variables = None):
     if v is None:
         v = _get_default_vars_instance()
 
-    logger = get_logger(v)
+    logger = _plugin_logger(v)
     pr = _plugin_registry(v)
     startup_order = pr.get_or_set('=|STARTUP_ORDER|', value_fn=list)
 
@@ -530,8 +540,8 @@ def schedule_async_shutdown(v: Variables = None, timeout: float = 5.0) -> bool:
         future.result(timeout=timeout)
         return True
     except asyncio.TimeoutError:
-        get_logger(v).warning('Async shutdown timed out after %.1f seconds', timeout)
+        _plugin_logger(v).warning('Async shutdown timed out after %.1f seconds', timeout)
         return False
     except Exception as e:
-        get_logger(v).debug('Could not schedule async shutdown: %s', e)
+        _plugin_logger(v).debug('Could not schedule async shutdown: %s', e)
         return False

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="scitrera-app-framework",
-    version="0.0.68",
+    version="0.0.69",
     author="Scitrera LLC",
     author_email="[email protected]",
     description="Common Application Framework Code and Utilities",