Enable kwargs forward dash (#312)

* allow to forward the kwargs arguments of DjangoDash to the WrappedDash (add test for external_stylesheets and external_scripts)

* remove pipfile that was added by mistake

* cleanup:
- use super() instead of super(...,self)
- fix typo in dataclass

* handled explicitly external_stylesheets/external_scripts arguments and warn when extra arguments are given

* fix typo in import

Co-authored-by: GFJ138 <[email protected]>

Author: sdementen

demo/demo/dash_apps.py

@@ -15,12 +15,12 @@
 from django_plotly_dash import DjangoDash
 
 #from .urls import app_name
-app_name = "DPD demo application"
+# app_name = "DPD demo application"
 
 dashboard_name1 = 'dash_example_1'
 dash_example1 = DjangoDash(name=dashboard_name1,
                            serve_locally=True,
-                           app_name=app_name
+                           # app_name=app_name
                           )
 
 # Below is a random Dash app.

demo/demo/plotly_apps.py

@@ -379,6 +379,31 @@ def multiple_callbacks_two(button_clicks, color_choice, **kwargs):
             ]
 
 
+
+external_scripts = [
+    'https://www.google-analytics.com/analytics.js',
+    {'src': 'https://cdn.polyfill.io/v2/polyfill.min.js'},
+    {
+        'src': 'https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.10/lodash.core.js',
+        'integrity': 'sha256-Qqd/EfdABZUcAxjOkMi8eGEivtdTkh3b65xCZL4qAQA=',
+        'crossorigin': 'anonymous'
+    }
+]
+external_stylesheets = [
+    'https://codepen.io/chriddyp/pen/bWLwgP.css',
+    {
+        'href': 'https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css',
+        'rel': 'stylesheet',
+        'integrity': 'sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO',
+        'crossorigin': 'anonymous'
+    }
+]
+external_scripts_stylesheets = DjangoDash("ExternalScriptStylesheets",
+                                          external_stylesheets=external_stylesheets,
+                                          external_scripts=external_scripts)
+
+external_scripts_stylesheets.layout = html.Div()
+
 flexible_expanded_callbacks = DjangoDash("FlexibleExpandedCallbacks")
 
 flexible_expanded_callbacks.layout = html.Div([

django_plotly_dash/consumers.py

@@ -55,7 +55,7 @@ async def async_send_to_pipe_channel(channel_name,
 class MessageConsumer(WebsocketConsumer):
     'Websocket handler for pipe to dash component'
     def __init__(self, *args, **kwargs):
-        super(MessageConsumer, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
         self.channel_maps = {}
 
@@ -67,7 +67,7 @@ def disconnect(self, reason):  # pylint: disable=arguments-differ
         for _, pipe_group_name in self.channel_maps.items():
             async_to_sync(self.channel_layer.group_discard)(pipe_group_name, self.channel_name)
 
-        return super(MessageConsumer, self).disconnect(reason)
+        return super().disconnect(reason)
 
     def pipe_value(self, message):
         'Send a new value into the ws pipe'

django_plotly_dash/dash_wrapper.py

@@ -27,6 +27,7 @@
 import itertools
 import json
 import inspect
+import warnings
 
 import dash
 from dash import Dash
@@ -50,7 +51,7 @@
     from dataclasses import dataclass
     from typing import Dict, List
 
-    @dataclass(frozen-True)
+    @dataclass(frozen=True)
     class CallbackContext:
         inputs_list : List
         inputs: Dict
@@ -162,7 +163,17 @@ class DjangoDash:
     def __init__(self, name=None, serve_locally=None,
                  add_bootstrap_links=False,
                  suppress_callback_exceptions=False,
-                 **kwargs): # pylint: disable=unused-argument, too-many-arguments
+                 external_stylesheets=None,
+                 external_scripts=None,
+                 **kwargs):  # pylint: disable=unused-argument, too-many-arguments
+
+        # store arguments to pass them later to the WrappedDash instance
+        self.external_stylesheets = external_stylesheets or []
+        self.external_scripts = external_scripts or []
+        self._kwargs = kwargs
+        if kwargs:
+            warnings.warn("You are passing extra arguments {kwargs} that will be passed to Dash(...) "
+                          "but may not be properly handled by django-plotly-dash.".format(kwargs=kwargs))
 
         if name is None:
             global uid_counter # pylint: disable=global-statement
@@ -268,7 +279,10 @@ def form_dash_instance(self, replacements=None, ndid=None, base_pathname=None):
         rd = WrappedDash(base_pathname=base_pathname,
                          replacements=replacements,
                          ndid=ndid,
-                         serve_locally=self._serve_locally)
+                         serve_locally=self._serve_locally,
+                         external_stylesheets=self.external_stylesheets,
+                         external_scripts=self.external_scripts,
+                         **self._kwargs)
 
         rd.layout = self.layout
         rd.config['suppress_callback_exceptions'] = self._suppress_callback_exceptions
@@ -408,8 +422,7 @@ def __init__(self,
         kwargs['url_base_pathname'] = self._base_pathname
         kwargs['server'] = self._notflask
 
-        super(WrappedDash, self).__init__(__name__,
-                                          **kwargs)
+        super().__init__(__name__, **kwargs)
 
         self.css.config.serve_locally = serve_locally
         self.scripts.config.serve_locally = serve_locally
@@ -577,9 +590,9 @@ def callback(self, output, inputs=[], state=[], events=[]): # pylint: disable=da
         else:
             fixed_outputs = self._fix_callback_item(output)
 
-        return super(WrappedDash, self).callback(fixed_outputs,
-                                                 [self._fix_callback_item(x) for x in inputs],
-                                                 [self._fix_callback_item(x) for x in state])
+        return super().callback(fixed_outputs,
+                                [self._fix_callback_item(x) for x in inputs],
+                                [self._fix_callback_item(x) for x in state])
 
     def clientside_callback(self, clientside_function, output, inputs=[], state=[]): # pylint: disable=dangerous-default-value
         'Invoke callback, adjusting variable names as needed'
@@ -589,10 +602,10 @@ def clientside_callback(self, clientside_function, output, inputs=[], state=[]):
         else:
             fixed_outputs = self._fix_callback_item(output)
 
-        return super(WrappedDash, self).clientside_callback(clientside_function,
-                                                            fixed_outputs,
-                                                            [self._fix_callback_item(x) for x in inputs],
-                                                            [self._fix_callback_item(x) for x in state])
+        return super().clientside_callback(clientside_function,
+                                           fixed_outputs,
+                                           [self._fix_callback_item(x) for x in inputs],
+                                           [self._fix_callback_item(x) for x in state])
 
     def dispatch(self):
         'Perform dispatch, using request embedded within flask global state'
@@ -750,7 +763,7 @@ def index(self, *args, **kwargs):  # pylint: disable=unused-argument
     def interpolate_index(self, **kwargs): #pylint: disable=arguments-differ
 
         if not self._return_embedded:
-            resp = super(WrappedDash, self).interpolate_index(**kwargs)
+            resp = super().interpolate_index(**kwargs)
             return resp
 
         self._return_embedded.add_css(kwargs['css'])

django_plotly_dash/finders.py

@@ -76,7 +76,7 @@ def __init__(self):
             self.storages[component_name] = storage
             self.components[path] = component_name
 
-        super(DashComponentFinder, self).__init__()
+        super().__init__()
 
     def find(self, path, all=False):
         matches = []
@@ -131,7 +131,7 @@ def __init__(self):
                 self.locations.append(app_config.name)
                 self.storages[app_config.name] = storage
 
-        super(DashAppDirectoryFinder, self).__init__()
+        super().__init__()
 
     #pylint: disable=redefined-builtin
     def find(self, path, all=False):
@@ -184,7 +184,7 @@ def __init__(self):
                 self.locations.append(component_name)
                 self.storages[component_name] = storage
 
-        super(DashAssetFinder, self).__init__()
+        super().__init__()
 
     #pylint: disable=redefined-builtin
     def find(self, path, all=False):

django_plotly_dash/models.py

@@ -57,7 +57,7 @@ def save(self, *args, **kwargs): # pylint: disable=arguments-differ
             exist_count = StatelessApp.objects.filter(slug__startswith=self.slug).count()
             if exist_count > 0:
                 self.slug = self.slug + str(exist_count+1)
-        return super(StatelessApp, self).save(*args, **kwargs)
+        return super().save(*args, **kwargs)
 
     def as_dash_app(self):
         '''
@@ -141,7 +141,7 @@ def save(self, *args, **kwargs): # pylint: disable=arguments-differ
             self.instance_name = "%s-%i" %(self.stateless_app.app_name, existing_count+1) # pylint: disable=no-member
         if not self.slug or len(self.slug) < 2:
             self.slug = slugify(self.instance_name)
-        super(DashApp, self).save(*args, **kwargs)
+        super().save(*args, **kwargs)
 
     def handle_current_state(self):
         '''

django_plotly_dash/tests.py

@@ -29,6 +29,7 @@
 
 import pytest
 import json
+from unittest.mock import patch
 
 #pylint: disable=bare-except
 from dash.dependencies import Input
@@ -171,6 +172,7 @@ def test_injection_app_access(client):
             assert did_fail
 
 
+
 @pytest.mark.django_db
 def test_injection_updating_multiple_callbacks(client):
     'Check updating of an app using demo test data for multiple callbacks'
@@ -446,6 +448,23 @@ def test_app_loading(client):
     assert response.status_code == 302
 
 
+@pytest.mark.django_db
+def test_external_scripts_stylesheets(client):
+    'Check external_stylesheets and external_scripts ends up in index'
+
+    from demo.plotly_apps import external_scripts_stylesheets
+    dash = external_scripts_stylesheets.as_dash_instance()
+
+    with patch.object(dash, "interpolate_index") as mock:
+        dash.index()
+
+    _, kwargs = mock.call_args
+    assert "https://codepen.io/chriddyp/pen/bWLwgP.css" in kwargs["css"]
+    assert "https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" in kwargs["css"]
+    assert "https://www.google-analytics.com/analytics.js" in kwargs["scripts"]
+    assert "https://cdn.polyfill.io/v2/polyfill.min.js" in kwargs["scripts"]
+    assert "https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.10/lodash.core.js" in kwargs["scripts"]
+
 def test_callback_decorator():
     inputs = [Input("one", "value"),
               Input("two", "value"),