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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Support for wildcard attributes, implement data-* attribute by rmarren1 · Pull Request #237 · plotly/dash · GitHub
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Support for wildcard attributes, implement data-* attribute by rmarren1 · Pull Request #237 · plotly/dash · GitHub
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Support for wildcard attributes, implement data-* attribute by rmarren1 · Pull Request #237 · plotly/dash · GitHub
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Support for wildcard attributes, implement data-* attribute by rmarren1 · Pull Request #237 · plotly/dash · GitHub
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Support for wildcard attributes, implement data-* attribute by rmarren1 · Pull Request #237 · plotly/dash · GitHub
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Support for wildcard attributes, implement data-* attribute by rmarren1 · Pull Request #237 · plotly/dash · GitHub
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Support for wildcard attributes, implement data-* attribute by rmarren1 · Pull Request #237 · plotly/dash · GitHub
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
## 0.21.1 - 2018-04-10
## Added
- `aria-*` and `data-*` attributes are now supported in all dash html components. (#40)
- These new keywords can be added using a dictionary expansion, e.g. `html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})`

## 0.21.0 - 2018-02-21
## Added
- #207 Dash now supports React components that use [Flow](https://flow.org/en/docs/react/).
Expand Down
4 changes: 3 additions & 1 deletion dash/dash.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -408,7 +408,9 @@ def _validate_callback(self, output, inputs, state, events):

if (hasattr(arg, 'component_property') and
arg.component_property not in
component.available_properties):
component.available_properties and not
any(arg.component_property.startswith(w) for w in
component.available_wildcard_properties)):
raise exceptions.NonExistantPropException('''
Attempting to assign a callback with
the property "{}" but the component
Expand Down
80 changes: 64 additions & 16 deletions dash/development/base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,7 +23,11 @@ def __init__(self, **kwargs):
# pylint: disable=super-init-not-called
for k, v in list(kwargs.items()):
# pylint: disable=no-member
if k not in self._prop_names:
k_in_propnames = k in self._prop_names
k_in_wildcards = any([k.startswith(w)
for w in
self._valid_wildcard_attributes])
if not k_in_propnames and not k_in_wildcards:
raise TypeError(
'Unexpected keyword argument `{}`'.format(k) +
'\nAllowed arguments: {}'.format(
Expand All@@ -34,10 +38,21 @@ def __init__(self, **kwargs):
setattr(self, k, v)

def to_plotly_json(self):
# Add normal properties
props = {
p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)
}
# Add the wildcard properties data-* and aria-*
props.update({
k: getattr(self, k)
for k in self.__dict__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, way better 👍

if any(k.startswith(w) for w in
self._valid_wildcard_attributes) # pylint:disable=no-member
})
as_json = {
'props': {p: getattr(self, p)
for p in self._prop_names # pylint: disable=no-member
if hasattr(self, p)},
'props': props,
'type': self._type, # pylint: disable=no-member
'namespace': self._namespace # pylint: disable=no-member
}
Expand DownExpand Up@@ -225,8 +240,12 @@ def __init__(self, {default_argtext}):
self._prop_names = {list_of_valid_keys}
self._type = '{typename}'
self._namespace = '{namespace}'
self._valid_wildcard_attributes =\
{list_of_valid_wildcard_attr_prefixes}
self.available_events = {events}
self.available_properties = {list_of_valid_keys}
self.available_wildcard_properties =\
{list_of_valid_wildcard_attr_prefixes}

for k in {required_args}:
if k not in kwargs:
Expand All@@ -236,15 +255,23 @@ def __init__(self, {default_argtext}):
super({typename}, self).__init__({argtext})

def __repr__(self):
if(any(getattr(self, c, None) is not None for c in self._prop_names
if c is not self._prop_names[0])):

return (
'{typename}(' +
', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])+')')

if(any(getattr(self, c, None) is not None
for c in self._prop_names
if c is not self._prop_names[0])
or any(getattr(self, c, None) is not None
for c in self.__dict__.keys()
if any(c.startswith(wc_attr)
for wc_attr in self._valid_wildcard_attributes))):
props_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self._prop_names
if getattr(self, c, None) is not None])
wilds_string = ', '.join([c+'='+repr(getattr(self, c, None))
for c in self.__dict__.keys()
if any([c.startswith(wc_attr)
for wc_attr in
self._valid_wildcard_attributes])])
return ('{typename}(' + props_string +
(', ' + wilds_string if wilds_string != '' else '') + ')')
else:
return (
'{typename}(' +
Expand All@@ -253,6 +280,8 @@ def __repr__(self):

filtered_props = reorder_props(filter_props(props))
# pylint: disable=unused-variable
list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
# pylint: disable=unused-variable
list_of_valid_keys = repr(list(filtered_props.keys()))
# pylint: disable=unused-variable
docstring = create_docstring(
Expand All@@ -273,11 +302,9 @@ def __repr__(self):

required_args = required_props(props)

d = c.format(**locals())

scope = {'Component': Component}
# pylint: disable=exec-used
exec(d, scope)
exec(c.format(**locals()), scope)
result = scope[typename]
return result

Expand DownExpand Up@@ -366,6 +393,27 @@ def parse_events(props):
return events


def parse_wildcards(props):
"""
Pull out the wildcard attributes from the Component props

Parameters
----------
props: dict
Dictionary with {propName: propMetadata} structure

Returns
-------
list
List of Dash valid wildcard prefixes
"""
list_of_valid_wildcard_attr_prefixes = []
for wildcard_attr in ["data-*", "aria-*"]:
if wildcard_attr in props.keys():
list_of_valid_wildcard_attr_prefixes.append(wildcard_attr[:-1])
return list_of_valid_wildcard_attr_prefixes


def reorder_props(props):
"""
If "children" is in props, then move it to the
Expand Down
2 changes: 1 addition & 1 deletion dash/version.py
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
__version__ = '0.21.0'
__version__ = '0.21.1'
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
dash_core_components>=0.4.0
dash_html_components>=0.5.0
dash_html_components>=0.11.0rc1
dash_flow_example==0.0.3
dash_renderer
percy
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ appnope==0.1.0
backports.shutil-get-terminal-size==1.0.0
click==6.7
dash-core-components==0.3.3
dash-html-components==0.4.0
dash-html-components==0.11.0rc1
dash-renderer==0.2.9
dash.ly==0.14.0
decorator==4.0.11
Expand Down
14 changes: 14 additions & 0 deletions tests/development/metadata_test.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -207,6 +207,20 @@
"required": false,
"description": ""
},
"data-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"aria-*": {
"type": {
"name": "string"
},
"required": false,
"description": ""
},
"id": {
"type": {
"name": "string"
Expand Down
36 changes: 36 additions & 0 deletions tests/development/test_base_component.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
Component._prop_names = ('id', 'a', 'children', 'style', )
Component._type = 'TestComponent'
Component._namespace = 'test_namespace'
Component._valid_wildcard_attributes = ['data-', 'aria-']


def nested_tree():
Expand DownExpand Up@@ -411,6 +412,25 @@ def to_dict(id, children):
)
"""

def test_to_plotly_json_with_wildcards(self):
c = Component(id='a', **{'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None})
c._prop_names = ('id',)
c._type = 'MyComponent'
c._namespace = 'basic'
self.assertEqual(
c.to_plotly_json(),
{'namespace': 'basic',
'props': {
'aria-expanded': 'true',
'data-toggle': 'toggled',
'data-none': None,
'id': 'a',
},
'type': 'MyComponent'}
)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


def test_len(self):
self.assertEqual(len(Component()), 0)
self.assertEqual(len(Component(children='Hello World')), 1)
Expand DownExpand Up@@ -580,6 +600,16 @@ def test_repr_nested_arguments(self):
"Table(Table(children=Table(id='1'), id='2'))"
)

def test_repr_with_wildcards(self):
c = self.ComponentClass(id='1', **{"data-one": "one",
"aria-two": "two"})
data_first = "Table(id='1', data-one='one', aria-two='two')"
aria_first = "Table(id='1', aria-two='two', data-one='one')"
repr_string = repr(c)
if not (repr_string == data_first or repr_string == aria_first):
raise Exception("%s\nDoes not equal\n%s\nor\n%s" %
(repr_string, data_first, aria_first))

def test_docstring(self):
assert_docstring(self.assertEqual, self.ComponentClass.__doc__)

Expand DownExpand Up@@ -674,6 +704,10 @@ def setUp(self):

['customArrayProp', 'list'],

['data-*', 'string'],

['aria-*', 'string'],

['id', 'string'],

['dashEvents', "a value equal to: 'restyle', 'relayout', 'click'"]
Expand DownExpand Up@@ -749,6 +783,8 @@ def assert_docstring(assertEqual, docstring):

"- customProp (optional)",
"- customArrayProp (list; optional)",
'- data-* (string; optional)',
'- aria-* (string; optional)',
'- id (string; optional)',
'',
"Available events: 'restyle', 'relayout', 'click'",
Expand Down
17 changes: 17 additions & 0 deletions tests/development/test_component_loader.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,20 @@
"description": "Children",
"required": false
},
"data-*": {
"type": {
"name": "string"
},
"description": "Wildcard data",
"required": false
},
"aria-*": {
"type": {
"name": "string"
},
"description": "Wildcard aria",
"required": false
},
"bar": {
"type": {
"name": "custom"
Expand DownExpand Up@@ -113,6 +127,9 @@ def test_loadcomponents(self):
'foo': 'Hello World',
'bar': 'Lah Lah',
'baz': 'Lemons',
'data-foo': 'Blah',
'aria-bar': 'Seven',
'baz': 'Lemons',
'children': 'Child'
}
AKwargs = {
Expand Down
Loading