handle static files for multiple django configurations

Author: sdc50

bokeh_django/apps.py

@@ -43,7 +43,7 @@
 
 class DjangoBokehConfig(AppConfig):
 
-    name = 'bokeh-django'
+    name = 'bokeh_django'
     label = 'bokeh_django'
 
     _routes: RoutingConfiguration | None = None

bokeh_django/consumers.py

@@ -153,8 +153,8 @@ async def handle(self, body: bytes) -> None:
         resources_param = self.get_argument("resources", "default")
         resources = self.resources(server_url) if resources_param != "none" else None
 
-        resources = self.resources(server_url)
-        bundle = bundle_for_objs_and_resources(None, resources)
+        root_url = urljoin(absolute_url, self._prefix) if absolute_url else self._prefix
+        bundle = bundle_for_objs_and_resources(None, resources)  # , root_url=root_url) TODO add root_url argument in bokeh
 
         render_items = [RenderItem(token=session.token, elementid=element_id, use_for_title=False)]
         bundle.add(Script(script_for_render_items({}, render_items, app_path=app_path, absolute_url=absolute_url)))

bokeh_django/static.py

@@ -25,6 +25,8 @@
 from django.http import Http404
 from django.urls import re_path
 from django.views import static
+from django.contrib.staticfiles.finders import BaseFinder
+from django.utils._os import safe_join
 
 # Bokeh imports
 from bokeh.embed.bundle import extension_dirs
@@ -33,17 +35,66 @@
 # General API
 # -----------------------------------------------------------------------------
 
+class BokehExtensionFinder(BaseFinder):
+    """
+    A custom staticfiles finder class to find bokeh resources.
+
+    In Django settings:
+        When using `django.contrib.staticfiles' in `INSTALLED_APPS` then add
+        `bokeh_django.static.BokehExtensionFinder` to `STATICFILES_FINDERS`
+    """
+    _root = extension_dirs
+    _prefix = 'extensions/'
+
+    def find(self, path, all=False):
+        """
+        Given a relative file path, find an absolute file path.
+
+        If the ``all`` parameter is False (default) return only the first found
+        file path; if True, return a list of all found files paths.
+        """
+        matches = []
+        location = self.find_location(path, self._prefix)
+        if location:
+            if not all:
+                return location
+            else:
+                matches.append(location)
+
+        return matches
+
+    @classmethod
+    def find_location(cls, path, prefix=None, as_components=False):
+        """
+        Find the absolute path to a resouces given a relative path.
+
+        Args:
+            path (str): relative path to resource
+            prefix (str): if passed then verifies that path starts with `prefix` else returns `None`
+            as_components (bool): If `True` return tuple of (artifacts_dir, artifact_path) rather than absolute path.
+                Used when needing seperate components for `static.serve` function to manually serve resources.
+        """
+        prefix = prefix or ''
+        if not prefix or path.startswith(prefix):
+            path = path[len(prefix):]
+            try:
+                name, artifact_path = path.split(os.sep, 1)
+            except ValueError:
+                pass
+            else:
+                artifacts_dir = cls._root.get(name, None)
+                if artifacts_dir is not None:
+                    path = safe_join(artifacts_dir, artifact_path)
+                    if os.path.exists(path):
+                        if as_components:
+                            return artifacts_dir, artifact_path
+                        return path
 
-def serve_extensions(request, path):
-    root = extension_dirs
-
-    try:
-        name, artifact_path = path.split(os.sep, 1)
-    except ValueError:
-        raise Http404
 
-    artifacts_dir = root.get(name, None)
-    if artifacts_dir is not None:
+def serve_extensions(request, path):
+    components = BokehExtensionFinder.find_location(path, as_components=True)
+    if components is not None:
+        artifacts_dir, artifact_path = components
         return static.serve(request, artifact_path, document_root=artifacts_dir)
     else:
         raise Http404