do full reload if allow_all_imports or hass_is_global change; see #74

Author: craigbarratt

custom_components/pyscript/__init__.py

@@ -29,6 +29,7 @@
     CONF_ALLOW_ALL_IMPORTS,
     CONF_HASS_IS_GLOBAL,
     CONFIG_ENTRY,
+    CONFIG_ENTRY_OLD,
     DOMAIN,
     FOLDER,
     LOGGER_PATH,
@@ -100,6 +101,24 @@ async def update_yaml_config(hass, config_entry):
     if config != config_entry.data:
         await hass.config_entries.flow.async_init(DOMAIN, context={"source": SOURCE_IMPORT}, data=config)
 
+    #
+    # if hass_is_global or allow_all_imports have changed, we need to reload all scripts
+    # since they affect all scripts
+    #
+    config_save = {
+        param: config_entry.data.get(param, False) for param in {CONF_HASS_IS_GLOBAL, CONF_ALLOW_ALL_IMPORTS}
+    }
+    if DOMAIN not in hass.data:
+        hass.data.setdefault(DOMAIN, {})
+    if CONFIG_ENTRY_OLD in hass.data[DOMAIN]:
+        old_entry = hass.data[DOMAIN][CONFIG_ENTRY_OLD]
+        hass.data[DOMAIN][CONFIG_ENTRY_OLD] = config_save
+        for param in {CONF_HASS_IS_GLOBAL, CONF_ALLOW_ALL_IMPORTS}:
+            if old_entry.get(param, False) != config_entry.data.get(param, False):
+                return True
+    hass.data[DOMAIN][CONFIG_ENTRY_OLD] = config_save
+    return False
+
 
 def start_global_contexts(global_ctx_only=None):
     """Start all the file and apps global contexts."""
@@ -192,7 +211,7 @@ def check_event(event, do_reload):
     watchdog_q = asyncio.Queue(0)
     observer = watchdog.observers.Observer()
     if observer is not None:
-        # don't run watchdog when we are testing (it patches to None)
+        # don't run watchdog when we are testing (Observer() patches to None)
         hass.data[DOMAIN][WATCHDOG_OBSERVER] = observer
         hass.data[DOMAIN][WATCHDOG_TASK] = Function.create_task(task_watchdog(watchdog_q))
 
@@ -201,11 +220,13 @@ def check_event(event, do_reload):
 
 async def async_setup_entry(hass, config_entry):
     """Initialize the pyscript config entry."""
+    global_ctx_only = None
     if Function.hass:
         #
         # reload yaml if this isn't the first time (ie, on reload)
         #
-        await update_yaml_config(hass, config_entry)
+        if await update_yaml_config(hass, config_entry):
+            global_ctx_only = "*"
 
     Function.init(hass)
     Event.init(hass)
@@ -227,19 +248,20 @@ async def async_setup_entry(hass, config_entry):
     State.set_pyscript_config(config_entry.data)
 
     await install_requirements(hass, config_entry, pyscript_folder)
-    await load_scripts(hass, config_entry.data)
+    await load_scripts(hass, config_entry.data, global_ctx_only=global_ctx_only)
 
     async def reload_scripts_handler(call):
         """Handle reload service calls."""
         _LOGGER.debug("reload: yaml, reloading scripts, and restarting")
 
-        await update_yaml_config(hass, config_entry)
+        global_ctx_only = call.data.get("global_ctx", None) if call else None
+
+        if await update_yaml_config(hass, config_entry):
+            global_ctx_only = "*"
         State.set_pyscript_config(config_entry.data)
 
         await State.get_service_params()
 
-        global_ctx_only = call.data.get("global_ctx", None) if call else None
-
         await install_requirements(hass, config_entry, pyscript_folder)
         await load_scripts(hass, config_entry.data, global_ctx_only=global_ctx_only)
 
@@ -333,14 +355,13 @@ async def hass_stop(event):
 
 async def async_unload_entry(hass, config_entry):
     """Unload a config entry."""
-    # Unload scripts
+    _LOGGER.info("Unloading all scripts")
     await unload_scripts()
 
-    # Unsubscribe from listeners
     for unsub_listener in hass.data[DOMAIN][UNSUB_LISTENERS]:
         unsub_listener()
+    hass.data[DOMAIN][UNSUB_LISTENERS] = []
 
-    hass.data.pop(DOMAIN)
     return True
 
 

custom_components/pyscript/const.py

@@ -3,6 +3,7 @@
 DOMAIN = "pyscript"
 
 CONFIG_ENTRY = "config_entry"
+CONFIG_ENTRY_OLD = "config_entry_old"
 UNSUB_LISTENERS = "unsub_listeners"
 
 FOLDER = "pyscript"

docs/reference.rst

@@ -9,8 +9,8 @@ Configuration
 Pyscript can be configured using the UI, or via yaml. To use the UI, go to the
 Configuration -> Integrations page and selection "+" to add ``Pyscript Python scripting``.
 After that, you can change the settings anytime by selecting "Options" under Pyscript
-in the Configuration page. You will need to select "reload" under Pyscript, or call
-the ``pyscript.reload`` service for the new settings to take effect.
+in the Configuration -> Integrations page. You will need to select "reload" under Pyscript,
+or call the ``pyscript.reload`` service for the new settings to take effect.
 
 Alternatively, for yaml configuration, add ``pyscript:`` to ``<config>/configuration.yaml``.
 You can't mix these two methods - your initial choice determines how you should update
@@ -135,13 +135,13 @@ Reloading Scripts
 Manually reloading scripts via the ``pyscript.reload`` service is no longer necessary starting
 in 1.2.0, since changes are automatically detected and a reload is triggered.
 
-By default, reloading only reloads scripts, apps or modules that have changed since they were last
-loaded. A change means the script, app or module file contents or modification time has changed.
-Additionally, an app is considered changed if its yaml configuration has changed. When a change is
-detected, additional files are also reloaded if they depend on a changed file. Additional files
-include all other files in a particular module or app (meaning the entire module or app is reloaded
-if any of its files or imports are changed), and if a module has changed, any other module, app or
-script that imports that module directly or indirectly is reloaded too.
+By default, calling the reload service only reloads scripts, apps or modules that have changed since
+they were last loaded. A change means the script, app or module file contents or modification time
+has changed.  Additionally, an app is considered changed if its yaml configuration has changed. When
+a change is detected, additional files are also reloaded if they depend on a changed file.
+Additional files include all other files in a particular module or app (meaning the entire module or
+app is reloaded if any of its files or imports are changed), and if a module has changed, any other
+module, app or script that imports that module directly or indirectly is reloaded too.
 
 A file is also considered changed if it is newly created or deleted (or "commented" by renaming it
 or a parent directory to start with ``#``). When reload detects a deleted file, the prior global
@@ -157,7 +157,8 @@ Additional files might still be reloaded too (all other files in the module or a
 modules, apps or scripts that import a module if ``global_ctx`` was set to a module).
 
 If you want to manually reload all scripts, apps and modules, set ``global_ctx`` to ``*`` when
-you call ``pyscript.reload``.
+you call ``pyscript.reload``.  Alternatively, the ``Reload`` option under pyscript in the
+in the Configuration -> Integrations page will always do a full reload.
 
 Any function definitions, services and triggers in the reloaded files are re-created. Jupyter
 sessions are not affected. Any currently running functions (ie, functions that have been triggered

tests/test_unit_eval.py

@@ -703,6 +703,34 @@ def func(incr):
     ],
     [
         """
+def f1(value):
+    i = 1
+    def f2(value):
+        i = 2
+        def f3(value):
+            return value + i
+        return f3(2 * value)
+    return f2(2 * value)
+f1(10)
+""",
+        42,
+    ],
+    [
+        """
+def f1(value):
+    i = 1
+    def f2(value):
+        i = 2
+        def f3():
+            return value + i
+        return f3()
+    return f2(2 * value)
+f1(10)
+""",
+        22,
+    ],
+    [
+        """
 def foo():
     global f_bar
     def f_bar():