Open browser after uvicorn is ready

Author: abdelq

sphinx_autobuild/__main__.py

@@ -5,6 +5,8 @@
 import argparse
 import shlex
 import sys
+import webbrowser
+from contextlib import asynccontextmanager
 from pathlib import Path
 
 import colorama
@@ -22,7 +24,7 @@
 from sphinx_autobuild.filter import IgnoreFilter
 from sphinx_autobuild.middleware import JavascriptInjectorMiddleware
 from sphinx_autobuild.server import RebuildServer
-from sphinx_autobuild.utils import find_free_port, open_browser, show_message
+from sphinx_autobuild.utils import find_free_port, show_message
 
 
 def main(argv=()):
@@ -81,32 +83,40 @@ def main(argv=()):
     ignore_dirs = list(filter(None, ignore_dirs))
     ignore_handler = IgnoreFilter(ignore_dirs, args.re_ignore)
 
-    app = _create_app(watch_dirs, ignore_handler, builder, serve_dir, url_host)
+    app = _create_app(
+        watch_dirs, ignore_handler, builder, serve_dir, url_host, args.open_browser
+    )
 
     if not args.no_initial_build:
         show_message("Starting initial build")
         builder(changed_paths=())
 
-    if args.open_browser:
-        open_browser(url_host)
-
     show_message("Waiting to detect changes...")
     try:
         uvicorn.run(app, host=host_name, port=port_num, log_level="warning")
     except KeyboardInterrupt:
         show_message("Server ceasing operations. Cheerio!")
 
 
-def _create_app(watch_dirs, ignore_handler, builder, out_dir, url_host):
+def _create_app(
+    watch_dirs, ignore_handler, builder, out_dir, url_host, open_browser=False
+):
     watcher = RebuildServer(watch_dirs, ignore_handler, change_callback=builder)
 
+    @asynccontextmanager
+    async def lifespan(app):
+        async with watcher.lifespan(app):
+            if open_browser:
+                webbrowser.open(f"http://{url_host}")
+            yield
+
     return Starlette(
         routes=[
             WebSocketRoute("/websocket-reload", watcher, name="reload"),
             Mount("/", app=StaticFiles(directory=out_dir, html=True), name="static"),
         ],
         middleware=[Middleware(JavascriptInjectorMiddleware, ws_url=url_host)],
-        lifespan=watcher.lifespan,
+        lifespan=lifespan,
     )
 
 

sphinx_autobuild/utils.py

@@ -4,7 +4,6 @@
 
 import shlex
 import socket
-import webbrowser
 
 from colorama import Fore, Style
 
@@ -20,10 +19,6 @@ def find_free_port():
         return s.getsockname()[1]
 
 
-def open_browser(url_host: str) -> None:
-    webbrowser.open(f"http://{url_host}")
-
-
 def _log(text, *, colour):
     print(f"{Fore.GREEN}[sphinx-autobuild] {colour}{text}{Style.RESET_ALL}")