misc minor improvements

Author: rmorshea

docs/source/guides/getting-started/index.rst

@@ -56,7 +56,7 @@ To check that everything is working you can run the sample application:
 
 .. code-block:: bash
 
-    python -c "import idom; idom.run_sample_app(open_browser=True)"
+    python -c "import idom; idom.run(idom.sample.App, open_browser=True)"
 
 This should automatically open up a browser window to a page that looks like this:
 

src/idom/__init__.py

@@ -1,4 +1,4 @@
-from . import config, html, log, types, web
+from . import config, html, log, sample, types, web
 from .core import hooks
 from .core.component import component
 from .core.events import event
@@ -15,7 +15,6 @@
 from .core.layout import Layout
 from .core.serve import Stop
 from .core.vdom import vdom
-from .sample import run_sample_app
 from .server.utils import run
 from .utils import Ref, html_to_vdom
 from .widgets import hotswap, multiview
@@ -37,9 +36,9 @@
     "log",
     "multiview",
     "Ref",
-    "run_sample_app",
     "run",
     "Stop",
+    "sample",
     "types",
     "use_callback",
     "use_context",

src/idom/sample.py

@@ -3,7 +3,6 @@
 from . import html
 from .core.component import component
 from .core.types import VdomDict
-from .server.utils import run
 
 
 @component
@@ -20,18 +19,3 @@ def App() -> VdomDict:
             " to learn more.",
         ),
     )
-
-
-def run_sample_app(
-    host: str = "127.0.0.1",
-    port: int | None = None,
-    open_browser: bool = False,
-) -> None:
-    """Run a sample application.
-
-    Args:
-        host: host where the server should run
-        port: the port on the host to serve from
-        open_browser: whether to open a browser window after starting the server
-    """
-    run(App, host, port, open_browser=open_browser)

src/idom/server/default.py

@@ -5,23 +5,43 @@
 
 from idom.types import RootComponentConstructor
 
-from .utils import default_implementation
+from .types import ServerImplementation
+from .utils import all_implementations
 
 
 def configure(app: Any, component: RootComponentConstructor) -> None:
     """Configure the given app instance to display the given component"""
-    return default_implementation().configure(app, component)
+    return _default_implementation().configure(app, component)
 
 
 def create_development_app() -> Any:
     """Create an application instance for development purposes"""
-    return default_implementation().create_development_app()
+    return _default_implementation().create_development_app()
 
 
 async def serve_development_app(
     app: Any, host: str, port: int, started: asyncio.Event
 ) -> None:
     """Run an application using a development server"""
-    return await default_implementation().serve_development_app(
+    return await _default_implementation().serve_development_app(
         app, host, port, started
     )
+
+
+def _default_implementation() -> ServerImplementation[Any]:
+    """Get the first available server implementation"""
+    global _DEFAULT_IMPLEMENTATION
+
+    if _DEFAULT_IMPLEMENTATION is not None:
+        return _DEFAULT_IMPLEMENTATION
+
+    try:
+        implementation = next(all_implementations())
+    except StopIteration:
+        raise RuntimeError("No built-in server implementation installed.")
+    else:
+        _DEFAULT_IMPLEMENTATION = implementation
+        return implementation
+
+
+_DEFAULT_IMPLEMENTATION: ServerImplementation[Any] | None = None

src/idom/server/utils.py

@@ -2,7 +2,6 @@
 
 import asyncio
 import socket
-import sys
 import warnings
 import webbrowser
 from contextlib import closing
@@ -32,7 +31,7 @@ def run(
     host: str = "127.0.0.1",
     port: int | None = None,
     open_browser: bool = True,
-    implementation: ServerImplementation[Any] = sys.modules[__name__],
+    implementation: ServerImplementation[Any] | None = None,
 ) -> None:
     """Run a component with a development server"""
 
@@ -42,6 +41,9 @@ def run(
         stacklevel=2,
     )
 
+    if implementation is None:
+        from . import default as implementation
+
     app = implementation.create_development_app()
     implementation.configure(app, component)
 
@@ -91,25 +93,6 @@ def find_available_port(
     )
 
 
-def default_implementation() -> ServerImplementation[Any]:
-    """Get the first available server implementation"""
-    global _DEFAULT_IMPLEMENTATION
-
-    if _DEFAULT_IMPLEMENTATION is not None:
-        return _DEFAULT_IMPLEMENTATION
-
-    try:
-        implementation = next(all_implementations())
-    except StopIteration:
-        raise RuntimeError("No built-in server implementation installed.")
-    else:
-        _DEFAULT_IMPLEMENTATION = implementation
-        return implementation
-
-
-_DEFAULT_IMPLEMENTATION: ServerImplementation[Any] | None = None
-
-
 def all_implementations() -> Iterator[ServerImplementation[Any]]:
     """Yield all available server implementations"""
     for name in SUPPORTED_PACKAGES:

tests/test_sample.py

@@ -1,7 +1,8 @@
-from idom.sample import App, run_sample_app
-from idom.server.utils import find_available_port
+from idom.sample import App
 from idom.testing import DisplayFixture
 
 
 async def test_sample_app(display: DisplayFixture):
-    await display.show(App)
+    page = await display.show(App)
+    h1 = await page.wait_for_selector("h1")
+    assert (await h1.text_content()) == "Sample Application"