Merge pull request #6 from bokeh/support_url_args

URL args support and example

Author: sdc50

bokeh_django/__init__.py

@@ -9,3 +9,19 @@
 
 import_required("django", "django is required by bokeh-django")
 import_required("channels", "The package channels is required by bokeh-django and must be installed")
+
+
+def with_request(f):
+    def wrapper(doc):
+        return f(doc, doc.session_context.request)
+    return wrapper
+
+
+def with_url_args(handler):
+    def wrapper(doc):
+        request = doc.session_context.request
+        args = request.url_route['args']
+        kwargs = request.url_route['kwargs']
+        return handler(doc, *args, **kwargs)
+
+    return wrapper

bokeh_django/routing.py

@@ -10,15 +10,14 @@
 # -----------------------------------------------------------------------------
 from __future__ import annotations
 
-import logging # isort:skip
+import logging  # isort:skip
 log = logging.getLogger(__name__)
 
 # -----------------------------------------------------------------------------
 # Imports
 # -----------------------------------------------------------------------------
 
 # Standard library imports
-import re
 from pathlib import Path
 from typing import Callable, List, Union
 import weakref
@@ -192,18 +191,15 @@ def get_websocket_urlpatterns(self) -> List[URLPattern]:
     def _add_new_routing(self, routing: Routing) -> None:
         kwargs = dict(app_context=routing.app_context)
 
-        def join(*components):
-            return "/".join([component.strip("/") for component in components if component])
-
         def urlpattern(suffix=""):
-            return r"^{}$".format(join(re.escape(routing.url)) + suffix)
+            return f"^{routing.url.strip('^$/')}{suffix}$"
 
         if routing.document:
-            self._http_urlpatterns.append(re_path(urlpattern(), DocConsumer.as_asgi(), kwargs=kwargs))
+            self._http_urlpatterns.append(re_path(urlpattern(), DocConsumer.as_asgi(**kwargs)))
         if routing.autoload:
-            self._http_urlpatterns.append(re_path(urlpattern("/autoload.js"), AutoloadJsConsumer.as_asgi(), kwargs=kwargs))
+            self._http_urlpatterns.append(re_path(urlpattern("/autoload.js"), AutoloadJsConsumer.as_asgi(**kwargs)))
 
-        self._websocket_urlpatterns.append(re_path(urlpattern("/ws"), WSConsumer.as_asgi(), kwargs=kwargs))
+        self._websocket_urlpatterns.append(re_path(urlpattern("/ws"), WSConsumer.as_asgi(**kwargs)))
 
 # -----------------------------------------------------------------------------
 # Dev API

examples/django_embed/django_embed/shape_viewer.py

@@ -20,6 +20,7 @@ def _get_coords(self):
     def view(self):
         return self.figure
 
+
 class Circle(Shape):
 
     n = param.Integer(default=100, precedence=-1)
@@ -37,6 +38,7 @@ def update(self):
         xs, ys = self._get_coords()
         self.renderer.data_source.data.update({'x': xs, 'y': ys})
 
+
 class NGon(Circle):
 
     n = param.Integer(default=3, bounds=(3, 10), precedence=1)
@@ -46,8 +48,10 @@ def update(self):
         xs, ys = self._get_coords()
         self.renderer.data_source.data.update({'x': xs, 'y': ys})
 
+
 shapes = [NGon(), Circle()]
 
+
 class ShapeViewer(param.Parameterized):
 
     shape = param.ObjectSelector(default=shapes[0], objects=shapes)
@@ -78,4 +82,8 @@ def panel(self):
 
 
 def shape_viewer():
-    return ShapeViewer().panel()
+    shapes = [NGon(), Circle()]
+    viewer = ShapeViewer()
+    viewer.param.shape.objects = shapes
+    viewer.shape = shapes[0]
+    return viewer.panel()

examples/django_embed/django_embed/templates/index.html

@@ -31,6 +31,7 @@ <h2>Autoload Apps</h2>
     <li><a href="./sea-surface-temp">Sea Surface Temp</a></li>
     <li><a href="./my-sea-surface">Sea Surface Temp</a> (mapped to custom Bokeh handler URI)</li>
     <li><a href="./shapes">Shapes (Panel app)</a></li>
+    <li><a href="./shapes/custom-arg1/custom-arg2">Shapes</a> (with URL variables)</li>
 </ul>
 
 </body>

examples/django_embed/django_embed/urls.py

@@ -29,6 +29,7 @@
     path("sea-surface-temp", views.sea_surface),
     path("my-sea-surface", views.sea_surface_custom_uri),
     path("shapes", views.shapes),
+    path("shapes/<str:arg1>/<str:arg2>", views.shapes_with_args),
     # *static_extensions(),
     # *staticfiles_urlpatterns(),
 ]
@@ -44,5 +45,6 @@
     document("shape_viewer", views.shape_viewer_handler),
     autoload("sea-surface-temp", views.sea_surface_handler),
     autoload("sea_surface_custom_uri", views.sea_surface_handler),
-    autoload('shapes', views.shape_viewer_handler),
+    autoload("shapes", views.shape_viewer_handler),
+    autoload("shapes/(?P<arg1>[\w_\-]+)/(?P<arg2>[\w_\-]+)", views.shape_viewer_handler_with_args),
 ]

examples/django_embed/django_embed/views.py

@@ -1,5 +1,6 @@
 from os.path import join
 from typing import Any
+from bokeh_django import with_request, with_url_args
 
 from django.conf import settings
 from django.http import HttpRequest, HttpResponse
@@ -12,6 +13,7 @@
 from bokeh.plotting import figure
 from bokeh.sampledata.sea_surface_temperature import sea_surface_temperature
 from bokeh.themes import Theme
+import panel as pn
 
 from .shape_viewer import shape_viewer
 
@@ -27,6 +29,15 @@ def shape_viewer_handler(doc: Document) -> None:
     panel.server_doc(doc)
 
 
+@with_url_args
+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:
     df = sea_surface_temperature.copy()
     source = ColumnDataSource(data=df)
@@ -49,12 +60,6 @@ def callback(attr: str, old: Any, new: Any) -> None:
     doc.add_root(column(slider, plot))
 
 
-def with_request(f):
-    def wrapper(doc):
-        return f(doc, doc.session_context.request)
-    return wrapper
-
-
 @with_request
 def sea_surface_handler_with_template(doc: Document, request: Any) -> None:
     sea_surface_handler(doc)
@@ -76,15 +81,20 @@ def sea_surface_handler_with_template(doc: Document, request: Any) -> None:
 
 
 def sea_surface(request: HttpRequest) -> HttpResponse:
-    script = server_document(request.build_absolute_uri())
+    script = server_document(request.get_full_path())
     return render(request, "embed.html", dict(script=script))
 
 
 def sea_surface_custom_uri(request: HttpRequest) -> HttpResponse:
-    script = server_document(request._current_scheme_host + "/sea_surface_custom_uri")
+    script = server_document("/sea_surface_custom_uri")
     return render(request, "embed.html", dict(script=script))
 
 
 def shapes(request: HttpRequest) -> HttpResponse:
-    script = server_document(request.build_absolute_uri())
+    script = server_document(request.get_full_path())
+    return render(request, "embed.html", dict(script=script))
+
+
+def shapes_with_args(request: HttpRequest, arg1: str, arg2: str) -> HttpResponse:
+    script = server_document(request.get_full_path())
     return render(request, "embed.html", dict(script=script))