Add bokeh_dependency() to make it easier to render bokeh widgets (#85)

Author: cpsievert

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to shinywidgets will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [UNRELEASED]
+
+* Closed #14: Added a `bokeh_dependency()` function to simplify use of bokeh widgets. (#85)
+
 ## [0.1.6] - 2023-03-24
 
 * Closed #79: make shinywidgets compatible with ipywidgets 8.0.5. (#66)

README.md

@@ -235,8 +235,14 @@ To use `{bokeh}` in notebook, you have to run `bokeh.io.output_notebook()`. The
 equivalent thing in Shiny is to include the following in the UI definition:
 
 ```py
-from bokeh.resources import Resources
-head_content(HTML(Resources(mode="inline").render()))
+from shiny import ui
+from shinywidgets import bokeh_dependencies
+
+app_ui = ui.page_fluid(
+    bokeh_dependencies(),
+    # ...
+)
+```
 ```
 #### Other widgets?
 

examples/outputs/app.py

@@ -1,28 +1,11 @@
-import warnings
-
 import numpy as np
 import pandas as pd
-from htmltools import HTML, head_content
 from shiny import *
 
 from shinywidgets import *
 
-# TODO: jupyter_bokeh assumes this additional JS has been loaded into the
-# (in a notebook, this comes in via bokeh.io.output_notebook()).
-# We could probably insert this on widget construction, just before the comm
-# gets initialized (it's not currently working due to run_coro_sync() not working
-# when session._send_message() wants to send a big payload).
-bokeh_dependency = None
-try:
-    from bokeh.resources import Resources
-
-    bokeh_dependency = head_content(HTML(Resources(mode="inline").render()))
-except ImportError:
-    warnings.warn("Could not import bokeh", stacklevel=2)
-
-
 app_ui = ui.page_fluid(
-    bokeh_dependency,
+    bokeh_dependency(),
     ui.layout_sidebar(
         ui.panel_sidebar(
             ui.input_radio_buttons(

shinywidgets/__init__.py

@@ -2,8 +2,9 @@
 
 __author__ = """Carson Sievert"""
 __email__ = "carson@rstudio.com"
-__version__ = "0.1.6"
+__version__ = "0.1.6.9000"
 
+from ._dependencies import bokeh_dependency
 from ._shinywidgets import output_widget, reactive_read, register_widget, render_widget
 
-__all__ = ("output_widget", "register_widget", "render_widget", "reactive_read")
+__all__ = ("output_widget", "register_widget", "render_widget", "reactive_read", "bokeh_dependency")

shinywidgets/_dependencies.py

@@ -16,7 +16,7 @@
 from ipywidgets.widgets.domwidget import DOMWidget
 from ipywidgets.widgets.widget import Widget
 from jupyter_core.paths import jupyter_path  # type: ignore
-from shiny import Session
+from shiny import Session, ui
 
 from . import __version__
 
@@ -112,6 +112,13 @@ def require_dependency(w: Widget, session: Session) -> Optional[HTMLDependency]:
     )
 
 
+def bokeh_dependency() -> HTMLDependency:
+    from bokeh.resources import Resources 
+
+    resources = Resources(mode="inline").render()
+    return ui.head_content(ui.HTML(resources))
+
+
 def jupyter_extension_path(module_name: str) -> Optional[str]:
     paths: List[str] = jupyter_path()
     module_dir = None