0.2.0rc1

test async handlers in examples

Author: sdc50

bokeh_django/__init__.py

@@ -1,3 +1,5 @@
+import inspect
+
 # Bokeh imports
 from bokeh.util.dependencies import import_required
 
@@ -11,17 +13,34 @@
 import_required("channels", "The package channels is required by bokeh-django and must be installed")
 
 
-def with_request(f):
+def with_request(handler):
+    # Note that functools.wraps cannot be used here because Bokeh requires that the signature of the returned function
+    # must only accept single (Document) argument
     def wrapper(doc):
-        return f(doc, doc.session_context.request)
-    return wrapper
+        return handler(doc, doc.session_context.request)
+
+    async def async_wrapper(doc):
+        return await handler(doc, doc.session_context.request)
+
+    return async_wrapper if inspect.iscoroutinefunction(handler) else wrapper
+
+
+def _get_args_kwargs_from_doc(doc):
+    request = doc.session_context.request
+    args = request.url_route['args']
+    kwargs = request.url_route['kwargs']
+    return args, kwargs
 
 
 def with_url_args(handler):
+    # Note that functools.wraps cannot be used here because Bokeh requires that the signature of the returned function
+    # must only accept single (Document) argument
     def wrapper(doc):
-        request = doc.session_context.request
-        args = request.url_route['args']
-        kwargs = request.url_route['kwargs']
+        args, kwargs = _get_args_kwargs_from_doc(doc)
         return handler(doc, *args, **kwargs)
 
-    return wrapper
+    async def async_wrapper(doc):
+        args, kwargs = _get_args_kwargs_from_doc(doc)
+        return await handler(doc, *args, **kwargs)
+
+    return async_wrapper if inspect.iscoroutinefunction(handler) else wrapper

examples/django_embed/django_embed/settings.py

@@ -40,6 +40,7 @@
 # Application definition
 
 INSTALLED_APPS = [
+    'daphne',
     'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',

examples/django_embed/django_embed/templates/index.html

@@ -21,7 +21,7 @@ <h2>Document Apps</h2>
 <ul>
     <li><a href="./sea_surface_direct">Sea Surface Temp</a></li>
     <li><a href="./sea_surface_with_template">Sea Surface Temp</a> (with custom template rendered by Bokeh)</li>
-    <li><a href="./sea_surface_bokeh">Sea Surface Temp</a> (loaded using direct path to Bokeh app file - this is effectively the same as the Document app above.)</li>
+    <li><a href="./sea_surface_bokeh">Sea Surface Temp</a> (loaded using direct path to Bokeh app file - this is effectively the same as the Directory app above.)</li>
     <li><a href="./shape_viewer">Shapes (Panel app)</a></li>
 </ul>
 

examples/django_embed/django_embed/views.py

@@ -30,15 +30,15 @@ def shape_viewer_handler(doc: Document) -> None:
 
 
 @with_url_args
-def shape_viewer_handler_with_args(doc, arg1, arg2):
+async def shape_viewer_handler_with_args(doc, arg1, arg2):
     viewer = shape_viewer()
     pn.Column(
         viewer,
         pn.pane.Markdown(f'## This app has URL Args: {arg1} and {arg2}')
     ).server_doc(doc)
 
 
-def sea_surface_handler(doc: Document) -> None:
+async def sea_surface_handler(doc: Document) -> None:
     df = sea_surface_temperature.copy()
     source = ColumnDataSource(data=df)
 
@@ -61,8 +61,8 @@ def callback(attr: str, old: Any, new: Any) -> None:
 
 
 @with_request
-def sea_surface_handler_with_template(doc: Document, request: Any) -> None:
-    sea_surface_handler(doc)
+async def sea_surface_handler_with_template(doc: Document, request: Any) -> None:
+    await sea_surface_handler(doc)
     doc.template = """
 {% block title %}Embedding a Bokeh Apps In Django{% endblock %}
 {% block preamble %}
@@ -80,7 +80,7 @@ def sea_surface_handler_with_template(doc: Document, request: Any) -> None:
     doc.template_variables["username"] = request.user
 
 
-def sea_surface(request: HttpRequest) -> HttpResponse:
+async def sea_surface(request: HttpRequest) -> HttpResponse:
     script = server_document(request.get_full_path())
     return render(request, "embed.html", dict(script=script))
 

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bokeh-django"
-version = "0.1.0"
+version = "0.2.0rc1"
 description = "Utility to integrate Bokeh with Django Channels"
 readme = "README.md"
 authors = [
@@ -22,7 +22,7 @@ keywords = ["Bokeh", "Django", "Channels", "web", "visualization"]
 dependencies = [
     "bokeh",
     "django",
-    "channels<4",
+    "channels",
 ]
 requires-python = ">=3.7"