rename daemon to run_in_thread + misc

Author: rmorshea

scripts/live_docs.py

@@ -38,7 +38,7 @@ def new_builder():
 
         server = PerClientStateServer(main.component, {"cors": True})
         _running_idom_servers.append(server)
-        server.daemon("127.0.0.1", 5555, debug=True)
+        server.run_in_thread("127.0.0.1", 5555, debug=True)
         old_builder()
 
     return new_builder

src/idom/server/base.py

@@ -18,9 +18,9 @@ class AbstractRenderServer(Generic[_App, _Config], abc.ABC):
     standalone and as an extension to an existing application.
 
     Standalone usage:
-        :meth:`AbstractServerExtension.run` or :meth:`AbstractServerExtension.daemon`
+        :meth:`~AbstractServerExtension.run` or :meth:`~AbstractServerExtension.run_in_thread`
     Register an extension:
-        :meth:`AbstractServerExtension.register`
+        :meth:`~AbstractServerExtension.register`
     """
 
     def __init__(
@@ -54,7 +54,7 @@ def run(self, host: str, port: int, *args: Any, **kwargs: Any) -> None:
                 self._config, app, host, port, args, kwargs
             )
 
-    def daemon(self, *args: Any, **kwargs: Any) -> Thread:
+    def run_in_thread(self, *args: Any, **kwargs: Any) -> Thread:
         """Run the standalone application in a seperate thread."""
         self._daemon_thread = thread = Thread(
             target=lambda: self.run(*args, **kwargs), daemon=True
@@ -67,6 +67,8 @@ def daemon(self, *args: Any, **kwargs: Any) -> Thread:
 
     def register(self: _Self, app: Optional[_App]) -> _Self:
         """Register this as an extension."""
+        if self._app is not None:
+            raise RuntimeError(f"Already registered {self._app}")
         self._setup_application(self._config, app)
         self._setup_application_did_start_event(
             self._config, app, self._server_did_start
@@ -84,10 +86,12 @@ def wait_until_server_start(self, timeout: float = 3.0) -> None:
     @abc.abstractmethod
     def stop(self) -> None:
         """Stop a currently running application"""
+        raise NotImplementedError()
 
     @abc.abstractmethod
     def _create_config(self, config: Optional[_Config]) -> _Config:
         """Return the default configuration options."""
+        raise NotImplementedError()
 
     @abc.abstractmethod
     def _default_application(self, config: _Config) -> _App:

src/idom/server/prefab.py

@@ -41,8 +41,9 @@ def run(
         server_config:
             Options passed to configure the server.
         run_kwargs:
-            Keyword arguments passed to the :meth:`~AbstractRenderServer.daemon`
-            or :meth:`~AbstractRenderServer.run` method of the server
+            Keyword arguments passed to the :meth:`AbstractRenderServer.run`
+            or :meth:`AbstractRenderServer.run_in_thread` methods of the server
+            depending on whether ``daemon`` is set or not.
         app:
             Register the server to an existing application and run that.
         daemon:
@@ -64,7 +65,7 @@ def run(
     if app is not None:  # pragma: no cover
         server.register(app)
 
-    run_server = server.run if not daemon else server.daemon
+    run_server = server.run if not daemon else server.run_in_thread
     run_server(host, port, **(run_kwargs or {}))  # type: ignore
 
     return server
@@ -89,7 +90,7 @@ def multiview_server(
         host: The server hostname
         port: The server port number
         server_config: Value passed to :meth:`AbstractRenderServer.configure`
-        run_kwargs: Keyword args passed to :meth:`AbstractRenderServer.daemon`
+        run_kwargs: Keyword args passed to :meth:`AbstractRenderServer.run_in_thread`
         app: Optionally provide a prexisting application to register to
 
     Returns:
@@ -132,7 +133,7 @@ def hotswap_server(
         host: The server hostname
         port: The server port number
         server_config: Value passed to :meth:`AbstractRenderServer.configure`
-        run_kwargs: Keyword args passed to :meth:`AbstractRenderServer.daemon`
+        run_kwargs: Keyword args passed to :meth:`AbstractRenderServer.run_in_thread`
         app: Optionally provide a prexisting application to register to
         sync_views: Whether to update all displays with newly mounted components
 

src/idom/server/utils.py

@@ -4,12 +4,18 @@
 from typing import Any, List, Type
 
 
+_SUPPORTED_PACKAGES = [
+    "sanic",
+    "fastapi",
+    "flask",
+    "tornado",
+]
+
+
 def find_builtin_server_type(type_name: str) -> Type[Any]:
     """Find first installed server implementation"""
-    supported_packages = ["sanic", "flask", "tornado"]
-
     installed_builtins: List[str] = []
-    for name in supported_packages:
+    for name in _SUPPORTED_PACKAGES:
         try:
             import_module(name)
         except ImportError:  # pragma: no cover
@@ -24,7 +30,7 @@ def find_builtin_server_type(type_name: str) -> Type[Any]:
     else:  # pragma: no cover
         if not installed_builtins:
             raise RuntimeError(
-                f"Found none of the following builtin server implementations {supported_packages}"
+                f"Found none of the following builtin server implementations {_SUPPORTED_PACKAGES}"
             )
         else:
             raise ImportError(

src/idom/widgets/utils.py

@@ -30,7 +30,7 @@ def hotswap(shared: bool = False) -> Tuple[MountFunc, ComponentConstructor]:
             import idom
 
             show, root = idom.hotswap()
-            PerClientState(root).daemon("localhost", 8765)
+            PerClientStateServer(root).run_in_thread("localhost", 8765)
 
             @idom.component
             def DivOne(self):

tests/test_server/test_base.py

@@ -1,15 +1,24 @@
 import pytest
+import sanic
 
 import idom
+from idom.server.sanic import PerClientStateServer
 from idom.server.utils import find_builtin_server_type
 
 
-def test_no_application_until_running():
-    @idom.component
-    def AnyComponent():
-        pass
+@idom.component
+def AnyComponent():
+    pass
 
-    server = find_builtin_server_type("PerClientStateServer")(AnyComponent)
 
+def test_no_application_until_running():
+    server = find_builtin_server_type("PerClientStateServer")(AnyComponent)
     with pytest.raises(RuntimeError, match="No application"):
         server.application
+
+
+def test_cannot_register_app_twice():
+    server = PerClientStateServer(AnyComponent)
+    server.register(sanic.Sanic())
+    with pytest.raises(RuntimeError, match="Already registered"):
+        server.register(sanic.Sanic())