use non-editable install

Author: rmorshea

docs/Dockerfile

@@ -26,7 +26,7 @@ COPY setup.py ./
 COPY pyproject.toml ./
 COPY MANIFEST.in ./
 COPY README.md ./
-RUN pip install -e .[all]
+RUN pip install .[all]
 
 # COPY License
 # -----------

scripts/one_example.py

@@ -5,7 +5,7 @@
 
 import idom
 from docs.examples import all_example_names, get_example_files_by_name, load_one_example
-from idom.widgets import hotswap
+from idom.widgets import _hotswap
 
 
 EXAMPLE_NAME_SET = all_example_names()
@@ -32,7 +32,7 @@ def watch_for_change():
 def main():
     ex_name = _example_name_input()
 
-    mount, component = hotswap(update_on_change=True)
+    mount, component = _hotswap(update_on_change=True)
 
     def update_component():
         print(f"Loading example: {ex_name!r}")

src/idom/__init__.py

@@ -19,7 +19,7 @@
 from .core.serve import Stop
 from .core.vdom import vdom
 from .utils import Ref, html_to_vdom, vdom_to_html
-from .widgets import hotswap
+from .widgets import _hotswap
 
 
 __author__ = "idom-team"
@@ -32,7 +32,7 @@
     "create_context",
     "event",
     "hooks",
-    "hotswap",
+    "_hotswap",
     "html_to_vdom",
     "html",
     "Layout",

src/idom/testing/backend.py

@@ -4,13 +4,16 @@
 import logging
 from contextlib import AsyncExitStack
 from types import TracebackType
-from typing import Any, Optional, Tuple, Type, Union
+from typing import Any, Callable, Optional, Tuple, Type, Union
 from urllib.parse import urlencode, urlunparse
 
+from idom import component, use_effect, use_state
 from idom.backend import default as default_server
 from idom.backend.types import BackendImplementation
 from idom.backend.utils import find_available_port
-from idom.widgets import hotswap
+from idom.core.hooks import use_callback
+from idom.core.types import ComponentConstructor
+from idom.utils import Ref
 
 from .logs import LogAssertionError, capture_idom_logs, list_logged_exceptions
 
@@ -41,7 +44,7 @@ def __init__(
     ) -> None:
         self.host = host
         self.port = port or find_available_port(host, allow_reuse_waiting_ports=False)
-        self.mount, self._root_component = hotswap()
+        self.mount, self._root_component = _hotswap()
 
         if app is not None:
             if implementation is None:
@@ -146,3 +149,69 @@ async def __aexit__(
             raise LogAssertionError("Unexpected logged exception") from logged_errors[0]
 
         return None
+
+
+_MountFunc = Callable[["Callable[[], Any] | None"], None]
+
+
+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:
+        update_on_change: Whether or not all views of the layout should be udpated on a swap.
+
+    Example:
+        .. code-block:: python
+
+            import idom
+
+            show, root = idom.hotswap()
+            PerClientStateServer(root).run_in_thread("localhost", 8765)
+
+            @idom.component
+            def DivOne(self):
+                return {"tagName": "div", "children": [1]}
+
+            show(DivOne)
+
+            # displaying the output now will show DivOne
+
+            @idom.component
+            def DivTwo(self):
+                return {"tagName": "div", "children": [2]}
+
+            show(DivTwo)
+
+            # displaying the output now will show DivTwo
+    """
+    constructor_ref: Ref[Callable[[], Any]] = Ref(lambda: None)
+
+    set_constructor_callbacks: set[Callable[[Callable[[], Any]], None]] = set()
+
+    @component
+    def HotSwap() -> Any:
+        # new displays will adopt the latest constructor and arguments
+        constructor, _set_constructor = use_state(lambda: constructor_ref.current)
+        set_constructor = use_callback(lambda new: _set_constructor(lambda _: new))
+
+        def add_callback() -> Callable[[], None]:
+            set_constructor_callbacks.add(set_constructor)
+            return lambda: set_constructor_callbacks.remove(set_constructor)
+
+        use_effect(add_callback)
+
+        return constructor()
+
+    def swap(constructor: Callable[[], Any] | None) -> None:
+        constructor = constructor_ref.current = constructor or (lambda: None)
+
+        for set_constructor in set_constructor_callbacks:
+            set_constructor(constructor)
+
+        return None
+
+    return swap, HotSwap

src/idom/widgets.py

@@ -13,6 +13,7 @@
     TypeVar,
     Union,
 )
+from warnings import warn
 
 from typing_extensions import Protocol
 
@@ -22,6 +23,7 @@
 from .core import hooks
 from .core.component import component
 from .core.types import ComponentConstructor, VdomDict
+from .testing.backend import _hotswap, _MountFunc
 from .utils import Ref
 
 
@@ -107,85 +109,10 @@ def __call__(self, value: str) -> _CastTo:
         ...
 
 
-MountFunc = Callable[["Callable[[], Any] | None"], None]
-
-
-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:
-        update_on_change: Whether or not all views of the layout should be udpated on a swap.
-
-    Example:
-        .. code-block:: python
-
-            import idom
-
-            show, root = idom.hotswap()
-            PerClientStateServer(root).run_in_thread("localhost", 8765)
-
-            @idom.component
-            def DivOne(self):
-                return {"tagName": "div", "children": [1]}
-
-            show(DivOne)
-
-            # displaying the output now will show DivOne
-
-            @idom.component
-            def DivTwo(self):
-                return {"tagName": "div", "children": [2]}
-
-            show(DivTwo)
-
-            # displaying the output now will show DivTwo
-    """
-    constructor_ref: Ref[Callable[[], Any]] = Ref(lambda: None)
-
-    if update_on_change:
-        set_constructor_callbacks: Set[Callable[[Callable[[], Any]], None]] = set()
-
-        @component
-        def HotSwap() -> Any:
-            # new displays will adopt the latest constructor and arguments
-            constructor, set_constructor = _use_callable(constructor_ref.current)
-
-            def add_callback() -> Callable[[], None]:
-                set_constructor_callbacks.add(set_constructor)
-                return lambda: set_constructor_callbacks.remove(set_constructor)
-
-            hooks.use_effect(add_callback)
-
-            return constructor()
-
-        def swap(constructor: Callable[[], Any] | None) -> None:
-            constructor = constructor_ref.current = constructor or (lambda: None)
-
-            for set_constructor in set_constructor_callbacks:
-                set_constructor(constructor)
-
-            return None
-
-    else:
-
-        @component
-        def HotSwap() -> Any:
-            return constructor_ref.current()
-
-        def swap(constructor: Callable[[], Any] | None) -> None:
-            constructor_ref.current = constructor or (lambda: None)
-            return None
-
-    return swap, HotSwap
-
-
-_Func = Callable[..., Any]
-
-
-def _use_callable(initial_func: _Func) -> Tuple[_Func, Callable[[_Func], None]]:
-    state, set_state = hooks.use_state(lambda: initial_func)
-    return state, lambda new: set_state(lambda old: new)
+def hotswap(update_on_change: bool = False) -> Tuple[_MountFunc, ComponentConstructor]:
+    warn(
+        "The 'hotswap' function is deprecated and will be removed in a future release",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return _hotswap(update_on_change)

tests/test_widgets.py

@@ -9,51 +9,6 @@
 HERE = Path(__file__).parent
 
 
-async def test_hostwap_update_on_change(display: DisplayFixture):
-    """Ensure shared hotswapping works
-
-    This basically means that previously rendered views of a hotswap component get updated
-    when a new view is mounted, not just the next time it is re-displayed
-
-    In this test we construct a scenario where clicking a button will cause a pre-existing
-    hotswap component to be updated
-    """
-
-    def make_next_count_constructor(count):
-        """We need to construct a new function so they're different when we set_state"""
-
-        def constructor():
-            count.current += 1
-            return idom.html.div({"id": f"hotswap-{count.current}"}, count.current)
-
-        return constructor
-
-    @idom.component
-    def ButtonSwapsDivs():
-        count = idom.Ref(0)
-
-        async def on_click(event):
-            mount(make_next_count_constructor(count))
-
-        incr = idom.html.button({"onClick": on_click, "id": "incr-button"}, "incr")
-
-        mount, make_hostswap = idom.widgets.hotswap(update_on_change=True)
-        mount(make_next_count_constructor(count))
-        hotswap_view = make_hostswap()
-
-        return idom.html.div(incr, hotswap_view)
-
-    await display.show(ButtonSwapsDivs)
-
-    client_incr_button = await display.page.wait_for_selector("#incr-button")
-
-    await display.page.wait_for_selector("#hotswap-1")
-    await client_incr_button.click()
-    await display.page.wait_for_selector("#hotswap-2")
-    await client_incr_button.click()
-    await display.page.wait_for_selector("#hotswap-3")
-
-
 IMAGE_SRC_BYTES = b"""
 <svg width="400" height="110" xmlns="http://www.w3.org/2000/svg">
     <rect width="300" height="100" style="fill:rgb(0,0,255);" />