Improve code based on linter report

Author: Mark Gibbs

demo/demo/dash_apps.py

@@ -3,6 +3,9 @@
 TODO attribution here
 '''
 
+# The linter doesn't like the members of the html and dcc imports (as they are dynamic?)
+#pylint: disable=no-member
+
 import dash
 import dash_core_components as dcc
 import dash_html_components as html
@@ -25,16 +28,16 @@
 # I was using e.g. Bootstrap inconsistenyly across the dash layout. Staying consistent worked fine for me.
 dash_example1.layout = html.Div(id='main',
                                 children=[
-                                html.Div([dcc.Dropdown(id='my-dropdown1',
-                                                       options=[{'label': 'New York City', 'value': 'NYC'},
-                                                                {'label': 'Montreal', 'value': 'MTL'},
-                                                                {'label': 'San Francisco', 'value': 'SF'}
-                                                               ],
-                                                       value='NYC',
-                                                       className='col-md-12',
-                                                      ),
-                                          html.Div(id='test-output-div')
-                                         ]),
+                                    html.Div([dcc.Dropdown(id='my-dropdown1',
+                                                           options=[{'label': 'New York City', 'value': 'NYC'},
+                                                                    {'label': 'Montreal', 'value': 'MTL'},
+                                                                    {'label': 'San Francisco', 'value': 'SF'}
+                                                                   ],
+                                                           value='NYC',
+                                                           className='col-md-12',
+                                                          ),
+                                              html.Div(id='test-output-div')
+                                             ]),
 
                                     dcc.Dropdown(
                                         id='my-dropdown2',
@@ -49,7 +52,7 @@
 
                                     html.Div(id='test-output-div2')
 
-                                ]) # end of 'main'
+                                    ]) # end of 'main'
 
 @dash_example1.expanded_callback(
     dash.dependencies.Output('test-output-div', 'children'),
@@ -78,7 +81,7 @@ def callback_test(*args, **kwargs): #pylint: disable=unused-argument
 
     fig = dict(data=data, layout=layout)
     line_graph = dcc.Graph(id='line-area-graph2', figure=fig, style={'display':'inline-block', 'width':'100%',
-                                                                     'height':'100%;'} )
+                                                                     'height':'100%;'})
     children = [line_graph]
 
     return children
@@ -88,6 +91,7 @@ def callback_test(*args, **kwargs): #pylint: disable=unused-argument
     dash.dependencies.Output('test-output-div2', 'children'),
     [dash.dependencies.Input('my-dropdown2', 'value')])
 def callback_test2(*args, **kwargs):
+    'Callback to exercise session functionality'
 
     print(args)
     print(kwargs)

django_plotly_dash/dash_wrapper.py

@@ -36,6 +36,7 @@
 from plotly.utils import PlotlyJSONEncoder
 
 from .app_name import app_name, main_view_label
+from .middleware import EmbeddedHolder
 
 uid_counter = 0
 
@@ -466,6 +467,7 @@ def index(self, *args, **kwargs):  # pylint: disable=unused-argument
         metas = self._generate_meta_html()
         title = getattr(self, 'title', 'Dash')
         if self._favicon:
+            import flask
             favicon = '<link rel="icon" type="image/x-icon" href="{}">'.format(
                 flask.url_for('assets.static', filename=self._favicon))
         else:
@@ -484,7 +486,7 @@ def index(self, *args, **kwargs):  # pylint: disable=unused-argument
 
         return index
 
-    def interpolate_index(self, **kwargs):
+    def interpolate_index(self, **kwargs): #pylint: disable=arguments-differ
 
         if not self._return_embedded:
             resp = super(WrappedDash, self).interpolate_index(**kwargs)
@@ -497,6 +499,9 @@ def interpolate_index(self, **kwargs):
         return kwargs['app_entry']
 
     def set_embedded(self, embedded_holder=None):
+        'Set a handler for embedded references prior to evaluating a view function'
         self._return_embedded = embedded_holder if embedded_holder else EmbeddedHolder()
+
     def exit_embedded(self):
+        'Exit the embedded section after processing a view'
         self._return_embedded = False

django_plotly_dash/middleware.py

@@ -4,22 +4,34 @@
 This middleware enables the collection of items from templates for inclusion in the header and footer
 '''
 
+#pylint: disable=too-few-public-methods
+
 class EmbeddedHolder(object):
+    'Hold details of embedded content from processing a view'
     def __init__(self):
         self.css = ""
         self.config = ""
         self.scripts = ""
     def add_css(self, css):
+        'Add css content'
         if css:
             self.css = css
     def add_config(self, config):
+        'Add config content'
         if config:
             self.config = config
     def add_scripts(self, scripts):
+        'Add js content'
         if scripts:
             self.scripts = scripts
 
 class ContentCollector:
+    '''
+    Collect content during view processing, and substitute in response by finding magic strings.
+
+    This enables view functionality, such as template tags, to introduce content such as css and js
+    inclusion into the header and footer.
+    '''
     def __init__(self):
         self.header_placeholder = "DJANGO_PLOTLY_DASH_HEADER_PLACEHOLDER"
         self.footer_placeholder = "DJANGO_PLOTLY_DASH_FOOTER_PLACEHOLDER"
@@ -28,6 +40,7 @@ def __init__(self):
         self._encoding = "utf-8"
 
     def adjust_response(self, response):
+        'Locate placeholder magic strings and replace with content'
 
         c1 = self._replace(response.content,
                            self.header_placeholder,
@@ -48,6 +61,7 @@ def _encode(self, string):
         return string.encode(self._encoding)
 
 class BaseMiddleware:
+    'Django-plotly-dash middleware'
 
     def __init__(self, get_response):
         self.get_response = get_response

django_plotly_dash/tests.py

@@ -29,6 +29,8 @@
 
 import pytest
 
+#pylint: disable=bare-except
+
 def test_dash_app():
     'Test the import and formation of the dash app orm wrappers'
 
@@ -176,11 +178,11 @@ def test_injection_updating(client):
         have_thrown = False
 
         try:
-            response2 = client.post(url, json.dumps({'output':{'id':'test-output-div2', 'property':'children'},
-                                                     'inputs':[{'id':'my-dropdown2',
-                                                                'property':'value',
-                                                                'value':'TestIt'},
-                                                              ]}), content_type="application/json")
+            client.post(url, json.dumps({'output':{'id':'test-output-div2', 'property':'children'},
+                                         'inputs':[{'id':'my-dropdown2',
+                                                    'property':'value',
+                                                    'value':'TestIt'},
+                                                  ]}), content_type="application/json")
         except:
             have_thrown = True