add global_ctx optional parameter to pyscript.reload service; see #63

Author: craigbarratt

custom_components/pyscript/__init__.py

@@ -91,13 +91,16 @@ async def update_yaml_config(hass, config_entry):
         await hass.config_entries.flow.async_init(DOMAIN, context={"source": SOURCE_IMPORT}, data=config)
 
 
-def start_global_contexts():
+def start_global_contexts(global_ctx_only=None):
     """Start all the file and apps global contexts."""
     start_list = []
     for global_ctx_name, global_ctx in GlobalContextMgr.items():
         idx = global_ctx_name.find(".")
         if idx < 0 or global_ctx_name[0:idx] not in {"file", "apps"}:
             continue
+        if global_ctx_only is not None:
+            if global_ctx_name != global_ctx_only and not global_ctx_name.startswith(global_ctx_only + "."):
+                continue
         global_ctx.set_auto_start(True)
         start_list.append(global_ctx)
     for global_ctx in start_list:
@@ -139,11 +142,17 @@ async def reload_scripts_handler(call):
         await update_yaml_config(hass, config_entry)
         State.set_pyscript_config(config_entry.data)
 
-        await unload_scripts()
+        global_ctx_only = call.data.get("global_ctx", None)
 
-        await load_scripts(hass, config_entry.data)
+        if global_ctx_only is not None and not GlobalContextMgr.get(global_ctx_only):
+            _LOGGER.error("pyscript.reload: no global context '%s' to reload", global_ctx_only)
+            return
 
-        start_global_contexts()
+        await unload_scripts(global_ctx_only=global_ctx_only)
+
+        await load_scripts(hass, config_entry.data, global_ctx_only=global_ctx_only)
+
+        start_global_contexts(global_ctx_only=global_ctx_only)
 
     hass.services.async_register(DOMAIN, SERVICE_RELOAD, reload_scripts_handler)
 
@@ -224,22 +233,25 @@ async def async_unload_entry(hass, config_entry):
     return True
 
 
-async def unload_scripts(unload_all=False):
+async def unload_scripts(global_ctx_only=None, unload_all=False):
     """Unload all scripts from GlobalContextMgr with given name prefixes."""
     ctx_delete = {}
     for global_ctx_name, global_ctx in GlobalContextMgr.items():
         if not unload_all:
             idx = global_ctx_name.find(".")
             if idx < 0 or global_ctx_name[0:idx] not in {"file", "apps", "modules"}:
                 continue
+        if global_ctx_only is not None:
+            if global_ctx_name != global_ctx_only and not global_ctx_name.startswith(global_ctx_only + "."):
+                continue
         global_ctx.stop()
         ctx_delete[global_ctx_name] = global_ctx
     for global_ctx_name, global_ctx in ctx_delete.items():
         await GlobalContextMgr.delete(global_ctx_name)
 
 
 @bind_hass
-async def load_scripts(hass, data):
+async def load_scripts(hass, data, global_ctx_only=None):
     """Load all python scripts in FOLDER."""
 
     pyscript_dir = hass.config.path(FOLDER)
@@ -279,6 +291,9 @@ def glob_files(load_paths, data):
 
     source_files = await hass.async_add_executor_job(glob_files, load_paths, data)
     for global_ctx_name, source_file, rel_import_path, fq_mod_name in source_files:
+        if global_ctx_only is not None:
+            if global_ctx_name != global_ctx_only and not global_ctx_name.startswith(global_ctx_only + "."):
+                continue
         global_ctx = GlobalContext(
             global_ctx_name,
             global_sym_table={"__name__": fq_mod_name},

custom_components/pyscript/logbook.py

@@ -1,10 +1,10 @@
 """Describe logbook events."""
+import logging
+
 from homeassistant.core import callback
 
 from .const import DOMAIN
 
-import logging
-
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -42,4 +42,4 @@ def async_describe_logbook_event(event):  # type: ignore
             "entity_id": ev_entity_id,
         }
 
-    async_describe_event(DOMAIN, "pyscript_running", async_describe_logbook_event)
+    async_describe_event(DOMAIN, "pyscript_running", async_describe_logbook_event)

custom_components/pyscript/services.yaml

@@ -2,6 +2,10 @@
 
 reload:
   description: Reload all available pyscripts and restart triggers
+  fields:
+    global_ctx:
+      description: only reload this specific global context (file or app)
+      example: file.example
 
 jupyter_kernel_start:
   description: Start a jupyter kernel for interactive use; called by Jupyter front end

custom_components/pyscript/trigger.py

@@ -10,8 +10,8 @@
 
 from croniter import croniter
 
-import homeassistant.helpers.sun as sun
 from homeassistant.core import Context
+import homeassistant.helpers.sun as sun
 
 from .const import LOGGER_PATH
 from .eval import AstEval

docs/reference.rst

@@ -663,7 +663,7 @@ level will not appear in the log. Each log message function uses a log name of t
 
 where ``FUNCNAME`` is the name of the top-level Python function (e.g., the one called by a trigger
 or service), defined in the script file ``FILENAME.py``. See the `Global Context <#global-context>`__
-section to see the logging path for other cases.
+section for the logging paths for other cases.
 
 That allows you to set the log level for each Python top-level function separately if necessary.
 That setting also applies to any other Python functions that the top-level Python function calls.
@@ -919,8 +919,16 @@ Without Jupyter, the pyscript workflow involves editing scripts in the ``<config
 and calling the ``pyscript.reload`` service to reload the code. You will need to look at the log
 file for error messages (eg, syntax errors), or log output from your code.
 
-A much better alternative is to use Jupyter notebook to interactively deveop and test functions,
-triggers and services.
+The ``pyscript.reload`` service takes an optional parameter ``global_ctx`` which specifies the name
+of a specific global context to reload; all others are unaffected. For example, specifying
+``file.example`` will just reload ``example.py``, and ``apps.my_app1`` will just reload
+``apps/my_app1.py`` or ``apps/my_app1/__init__.py``.  See the `Global Context <#global-context>`__
+section for the mapping of file or app names to global context names. Specifying ``global_ctx``
+makes it convenient to just reload the script file or application you are developing without
+affecting the others.
+
+A much better alternative to repeatedly modifying a script file and reloading it is to use Jupyter
+notebook to interactively deveop and test functions, triggers and services.
 
 Jupyter auto-completion (with `<TAB>`) is supported in Jupyter notebook, console and lab. It should
 work after you have typed at least the first character. After you hit `<TAB>` you should see a list

tests/test_init.py

@@ -447,7 +447,22 @@ def func5(var_name=None, value=None):
         ), patch(
             "homeassistant.config.load_yaml_config_file", return_value={}
         ):
-            await hass.services.async_call("pyscript", "reload", {}, blocking=True)
+            reload_param = {}
+            if i % 2 == 1:
+                #
+                # on alternate times, just reload the specific file we are testing with
+                #
+                reload_param = {"global_ctx": "file.hello"}
+            await hass.services.async_call("pyscript", "reload", reload_param, blocking=True)
+            if i % 3 == 0:
+                #
+                # reload a file that doesn't exist; will log error and do nothing
+                #
+                await hass.services.async_call(
+                    "pyscript", "reload", {"global_ctx": "file.nosuchfile"}, blocking=True
+                )
+
+    assert "pyscript.reload: no global context 'file.nosuchfile' to reload" in caplog.text
 
 
 async def test_misc_errors(hass, caplog):