change shared to update_on_change

also adds reload capability for one_example script

Author: rmorshea

docs/source/examples/slideshow.py

@@ -10,8 +10,9 @@ def next_image(event):
 
     return idom.html.img(
         {
-            "src": f"https://picsum.photos/800/300?image={index}",
+            "src": f"https://picsum.photos/400/200?image={index}",
             "style": {"cursor": "pointer"},
+            "height": "300px",
             "onClick": next_image,
         }
     )

scripts/one_example.py

@@ -1,7 +1,11 @@
 import sys
+import time
+from os.path import getmtime
 from pathlib import Path
+from threading import Thread
 
 import idom
+from idom.widgets.utils import hotswap
 
 
 here = Path(__file__).parent
@@ -13,6 +17,19 @@
         continue
 
 
+def on_file_change(path, callback):
+    def watch_for_change():
+        last_modified = 0
+        while True:
+            modified_at = getmtime(path)
+            if modified_at != last_modified:
+                callback()
+                last_modified = modified_at
+            time.sleep(1)
+
+    Thread(target=watch_for_change, daemon=True).start()
+
+
 def main():
     try:
         ex_name = sys.argv[1]
@@ -29,16 +46,22 @@ def main():
         return
 
     idom_run = idom.run
-    idom.run = lambda component: idom_run(component, port=8000)
-
-    with example_file.open() as f:
-        exec(
-            f.read(),
-            {
-                "__file__": str(file),
-                "__name__": f"__main__.examples.{file.stem}",
-            },
-        )
+    idom.run, component = hotswap(update_on_change=True)
+
+    def update_component():
+        print(f"Reloading {ex_name}")
+        with example_file.open() as f:
+            exec(
+                f.read(),
+                {
+                    "__file__": str(file),
+                    "__name__": f"__main__.examples.{file.stem}",
+                },
+            )
+
+    on_file_change(example_file, update_component)
+
+    idom_run(component, port=8000)
 
 
 def _print_available_options():

src/idom/server/prefab.py

@@ -142,7 +142,7 @@ def hotswap_server(
         The server instance and a function for swapping views.
         See :func:`idom.widgets.common.hotswap` for details.
     """
-    mount, component = hotswap(shared=sync_views)
+    mount, component = hotswap(update_on_change=sync_views)
 
     server = run(
         component,

src/idom/widgets/utils.py

@@ -14,15 +14,15 @@
 MountFunc = Callable[[ComponentConstructor], None]
 
 
-def hotswap(shared: bool = False) -> Tuple[MountFunc, ComponentConstructor]:
+def hotswap(update_on_change: bool = False) -> Tuple[MountFunc, ComponentConstructor]:
     """Swap out components from a layout on the fly.
 
     Since you can't change the component functions used to create a layout
     in an imperative manner, you can use ``hotswap`` to do this so
     long as you set things up ahead of time.
 
     Parameters:
-        shared: Whether or not all views of the layout should be udpated on a swap.
+        update_on_change: Whether or not all views of the layout should be udpated on a swap.
 
     Example:
         .. code-block:: python
@@ -50,7 +50,7 @@ def DivTwo(self):
     """
     constructor_ref: Ref[Callable[[], Any]] = Ref(lambda: {"tagName": "div"})
 
-    if shared:
+    if update_on_change:
         set_constructor_callbacks: Set[Callable[[Callable[[], Any]], None]] = set()
 
         @component

tests/test_widgets/test_utils.py

@@ -10,7 +10,7 @@ def test_multiview_repr():
     assert str(idom.widgets.utils.MultiViewMount({})) == "MultiViewMount({})"
 
 
-def test_shared_hostwap(driver, display):
+def test_hostwap_update_on_change(driver, display):
     """Ensure shared hotswapping works
 
     This basically means that previously rendered views of a hotswap component get updated
@@ -39,7 +39,7 @@ async def on_click(event):
 
         incr = idom.html.button({"onClick": on_click, "id": "incr-button"}, "incr")
 
-        mount, make_hostswap = idom.widgets.hotswap(shared=True)
+        mount, make_hostswap = idom.widgets.hotswap(update_on_change=True)
         mount(make_next_count_constructor(count))
         hotswap_view = make_hostswap()