Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
465 changes: 465 additions & 0 deletions .pylintrc

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ def __getattr__(self, key):
# to conform with __getattr__ spec
raise AttributeError(key)

# pylint: disable=inconsistent-return-statements
def first(self, *names):
for name in names:
value = self.get(name)
Expand Down
78 changes: 42 additions & 36 deletions dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@
import pkgutil
import warnings
from flask import Flask, Response
from flask_compress import Compress
import flask
from flask_compress import Compress
import plotly

import dash_renderer
Expand All@@ -17,16 +17,17 @@
from ._utils import AttributeDict as _AttributeDict


# pylint: disable=too-many-instance-attributes
class Dash(object):
def __init__(
self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs
):

self,
name=None,
server=None,
static_folder=None,
url_base_pathname='/',
**kwargs):

# pylint-disable: too-many-instance-attributes
if 'csrf_protect' in kwargs:
warnings.warn('''
`csrf_protect` is no longer used,
Expand DownExpand Up@@ -58,12 +59,13 @@ def __init__(
self.registered_paths = {}

# urls
def add_url(name, view_func, methods=['GET']):

def add_url(name, view_func, methods=('GET',)):
self.server.add_url_rule(
name,
view_func=view_func,
endpoint=name,
methods=methods
methods=list(methods)
)

add_url(
Expand All@@ -77,18 +79,16 @@ def add_url(name, view_func, methods=['GET']):

add_url(
'{}_dash-update-component'.format(
self.config['routes_pathname_prefix']
),
self.config['routes_pathname_prefix']),
self.dispatch,
['POST'])

add_url((
'{}_dash-component-suites'
'/<string:package_name>'
'/<path:path_in_package_dist>').format(
self.config['routes_pathname_prefix']
),
self.serve_component_suites)
self.config['routes_pathname_prefix']),
self.serve_component_suites)

add_url(
'{}_dash-routes'.format(self.config['routes_pathname_prefix']),
Expand DownExpand Up@@ -133,6 +133,7 @@ def layout(self, value):
self._layout = value

layout_value = self._layout_value()
# pylint: disable=protected-access
self.css._update_layout(layout_value)
self.scripts._update_layout(layout_value)
self._collect_and_register_resources(
Expand DownExpand Up@@ -223,6 +224,7 @@ def _generate_scripts_html(self):
# scripts have rendered.
# The rest of the scripts can just be loaded after React but before
# dash renderer.
# pylint: disable=protected-access
srcs = self._collect_and_register_resources(
self.scripts._resources._filter_resources(
dash_renderer._js_dist_dependencies
Expand DownExpand Up@@ -275,7 +277,7 @@ def serve_component_suites(self, package_name, path_in_package_dist):
mimetype=mimetype
)

def index(self, *args, **kwargs):
def index(self):
scripts = self._generate_scripts_html()
css = self._generate_css_dist_html()
config = self._generate_config_html()
Expand DownExpand Up@@ -315,13 +317,15 @@ def dependencies(self):
} for k, v in list(self.callback_map.items())
])

# pylint: disable=unused-argument, no-self-use
def react(self, *args, **kwargs):
raise exceptions.DashException(
'Yo! `react` is no longer used. \n'
'Use `callback` instead. `callback` has a new syntax too, '
'so make sure to call `help(app.callback)` to learn more.')

def _validate_callback(self, output, inputs, state, events):
# pylint: disable=too-many-branches
layout = self._cached_layout or self._layout_value()

if (layout is None and
Expand All@@ -337,10 +341,10 @@ def _validate_callback(self, output, inputs, state, events):
`app.config['suppress_callback_exceptions']=True`
'''.replace(' ', ''))

for args, object, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:
for args, obj, name in [([output], Output, 'Output'),
(inputs, Input, 'Input'),
(state, State, 'State'),
(events, Event, 'Event')]:

if not isinstance(args, list):
raise exceptions.IncorrectTypeException(
Expand All@@ -350,7 +354,7 @@ def _validate_callback(self, output, inputs, state, events):
))

for arg in args:
if not isinstance(arg, object):
if not isinstance(arg, obj):
raise exceptions.IncorrectTypeException(
'The {} argument `{}` is '
'not of type `dash.{}`.'.format(
Expand DownExpand Up@@ -398,12 +402,13 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as a property.\n
Here is a list of the available properties in "{}":
{}
'''.format(arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties
).replace(' ', ''))
'''.format(
arg.component_property,
arg.component_id,
arg.component_property,
arg.component_id,
component.available_properties).replace(
' ', ''))

if (hasattr(arg, 'component_event') and
arg.component_event not in
Expand All@@ -414,14 +419,14 @@ def _validate_callback(self, output, inputs, state, events):
"{}" doesn't have "{}" as an event.\n
Here is a list of the available events in "{}":
{}
'''.format(arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events
).replace(' ', ''))

if len(state) > 0 and len(events) == 0 and len(inputs) == 0:
'''.format(
arg.component_event,
arg.component_id,
arg.component_event,
arg.component_id,
component.available_events).replace(' ', ''))

if stateand not eventsand not inputs:
raise exceptions.MissingEventsException('''
This callback has {} `State` {}
but no `Input` elements or `Event` elements.\n
Expand DownExpand Up@@ -466,6 +471,7 @@ def _validate_callback(self, output, inputs, state, events):
# the dropdown.
# TODO - Check this map for recursive or other ill-defined non-tree
# relationships
# pylint: disable=dangerous-default-value
def callback(self, output, inputs=[], state=[], events=[]):
self._validate_callback(output, inputs, state, events)

Expand Down
4 changes: 4 additions & 0 deletions dash/dependencies.py
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
# pylint: disable=old-style-class, too-few-public-methods
class Output:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Input:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class State:
def __init__(self, component_id, component_property):
self.component_id = component_id
self.component_property = component_property


# pylint: disable=old-style-class, too-few-public-methods
class Event:
def __init__(self, component_id, component_event):
self.component_id = component_id
Expand Down
63 changes: 36 additions & 27 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,11 +10,21 @@ def is_number(s):
return False


def _check_if_has_indexable_children(item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError


class Component(collections.MutableMapping):
def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
if k not in self._prop_names:
if k not in self._prop_names: # pylint: disable=no-member
# TODO - What's the right exception here?
# pylint: disable=no-member
raise Exception(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -26,24 +36,21 @@ def __init__(self, **kwargs):
def to_plotly_json(self):
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'type': self._type,
'namespace': self._namespace
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}

return as_json

def _check_if_has_indexable_children(self, item):
if (not hasattr(item, 'children') or
(not isinstance(item.children, Component) and
not isinstance(item.children, collections.MutableSequence))):

raise KeyError

# pylint: disable=too-many-branches, too-many-return-statements
# pylint: disable=redefined-builtin, inconsistent-return-statements
def _get_set_or_delete(self, id, operation, new_item=None):
self._check_if_has_indexable_children(self)
_check_if_has_indexable_children(self)

# pylint: disable=access-member-before-definition,
# pylint: disable=attribute-defined-outside-init
if isinstance(self.children, Component):
if getattr(self.children, 'id', None) is not None:
# Woohoo! It's the item that we're looking for
Expand DownExpand Up@@ -110,7 +117,7 @@ def _get_set_or_delete(self, id, operation, new_item=None):
# - __iter__
# - __len__

def __getitem__(self, id):
def __getitem__(self, id): # pylint: disable=redefined-builtin
"""Recursively find the element with the given ID through the tree
of children.
"""
Expand All@@ -119,11 +126,11 @@ def __getitem__(self, id):
# or a list of components.
return self._get_set_or_delete(id, 'get')

def __setitem__(self, id, item):
def __setitem__(self, id, item): # pylint: disable=redefined-builtin
"""Set an element by its ID."""
return self._get_set_or_delete(id, 'set', item)

def __delitem__(self, id):
def __delitem__(self, id): # pylint: disable=redefined-builtin
"""Delete items by ID in the tree of children."""
return self._get_set_or_delete(id, 'delete')

Expand All@@ -139,7 +146,7 @@ def traverse(self):

# children is a list of components
elif isinstance(children, collections.MutableSequence):
for i in children:
for i in children: # pylint: disable=not-an-iterable
yield i

if isinstance(i, Component):
Expand DownExpand Up@@ -177,6 +184,7 @@ def __len__(self):
return length


# pylint: disable=unused-argument
def generate_class(typename, props, description, namespace):
# Dynamically generate classes to have nicely formatted docstrings,
# keyword arguments, and repr
Expand DownExpand Up@@ -229,6 +237,7 @@ def __repr__(self):
repr(getattr(self, self._prop_names[0], None)) + ')')
'''

# pylint: disable=unused-variable
filtered_props = reorder_props(filter_props(props))
list_of_valid_keys = repr(list(filtered_props.keys()))
docstring = create_docstring(
Expand All@@ -250,6 +259,7 @@ def __repr__(self):
d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
result = scope[typename]
return result
Expand DownExpand Up@@ -350,6 +360,7 @@ def js_to_py_type(type_object):
])),

# React's PropTypes.arrayOf
# pylint: disable=too-many-format-args
'arrayOf': lambda: 'list'.format(
'of {}s'.format(js_to_py_type(type_object['value']))
if js_to_py_type(type_object['value']) != ''
Expand DownExpand Up@@ -387,8 +398,7 @@ def js_to_py_type(type_object):
return ''
if js_type_name in js_to_py_types:
return js_to_py_types[js_type_name]()
else:
return ''
return ''


def argument_doc(arg_name, type_object, required, description):
Expand All@@ -404,12 +414,11 @@ def argument_doc(arg_name, type_object, required, description):
is_required='required' if required else 'optional'
)

else:
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
return '{name} ({type}{is_required}){description}'.format(
name=arg_name,
type='{}; '.format(py_type_name) if py_type_name else '',
description=(
': {}'.format(description) if description != '' else ''
),
is_required='required' if required else 'optional'
)
Loading