pass shared parameter to hotswap

Author: rmorshea

examples/example_utils.py

@@ -7,17 +7,16 @@
 
 
 def setup_example_server(
-    server: Type[AbstractRenderServer], host: str, port: int
+    server: Type[AbstractRenderServer], host: str, port: int, shared: bool = False,
 ) -> Tuple[str, AbstractRenderServer, Callable[..., Any]]:
-    server_instance, mount = imperative_server_mount(
-        server, host, port, {"access_log": False}, {"cors": True},
-    )
-
     localhost_idom_path = f"http://{host}:{port}"
     jupyterhub_idom_path = path_to_jupyterhub_proxy(port)
-
     path_to_idom = jupyterhub_idom_path or localhost_idom_path
 
+    server_instance, mount = imperative_server_mount(
+        server, host, port, shared, {"cors": True}, {"access_log": False}
+    )
+
     return path_to_idom, server_instance, mount
 
 

examples/introduction.ipynb

@@ -139,7 +139,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "display_href(server_url)"
+    "display_href(server_url + \"/client/index.html\")"
    ]
   },
   {
@@ -760,7 +760,9 @@
     "from idom.server.sanic import SharedClientState\n",
     "from example_utils import setup_example_server, display_href, pretty_dict_string\n",
     "\n",
-    "shared_server_url, shared_server, mount_shared = setup_example_server(SharedClientState, \"127.0.0.1\", 5678)\n",
+    "shared_server_url, shared_server, mount_shared = setup_example_server(\n",
+    "    SharedClientState, \"127.0.0.1\", 5678, shared=True\n",
+    ")\n",
     "\n",
     "def display_shared(element, *args, **kwargs):\n",
     "    mount_shared(element, *args, **kwargs)\n",

idom/server/__init__.py

@@ -27,10 +27,30 @@ def imperative_server_mount(
     server: Type[_S],
     host: str,
     port: int,
+    shared: bool = False,
+    server_options: Optional[Any] = None,
     run_options: Optional[Dict[str, Any]] = None,
-    server_options: Optional[Dict[str, Any]] = None,
 ) -> Tuple[_S, Callable[[ElementConstructor], None]]:
-    mount, element = hotswap()
-    server_instance = server(element).configure(server_options or {})
+    """Set up a server whose view can be swapped out on the fly.
+
+    In other words this allows the user to work with IDOM in an imperative manner.
+    Under the hood this uses the :func:`idom.widgets.common.hotswap` function to
+    switch out views on the fly.
+
+    Parameters:
+        server: The server type to start up as a daemon
+        host: The server hostname
+        port: The server port number
+        shared: Whether or not all views from the server should be updated when swapping
+        server_options: Value passed to :meth:`AbstractRenderServer.configure`
+        run_options: Keyword args passed to :meth:`AbstractRenderServer.daemon`
+
+    Returns:
+        The server instance and a function for swapping out the view.
+    """
+    mount, element = hotswap(shared)
+    server_instance = server(element)
+    if server_options:
+        server_instance.configure(server_options)
     server_instance.daemon(host, port, **(run_options or {}))
     return server_instance, mount