Remove events

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {

.circleci/config.yml

@@ -35,25 +35,12 @@ jobs:
  paths:
  - "venv"
 
- - run:
- name: Run lint
- command: |
- . venv/bin/activate
- pylint dash setup.py --rcfile=$PYLINTRC
- pylint tests -d all -e C0410,C0411,C0412,C0413,W0109
- flake8 dash setup.py
- flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests
-
  - run:
  name: Run tests
  command: |
  . venv/bin/activate
  python --version
- python -m unittest tests.development.test_base_component
- python -m unittest tests.development.test_component_loader
- python -m unittest tests.test_integration
- python -m unittest tests.test_resources
- python -m unittest tests.test_configs
+ ./test.sh
 
  "python-3.6":
  <<: *test-template
@@ -80,4 +67,4 @@ workflows:
  jobs:
  - "python-2.7"
  - "python-3.6"
- - "python-3.7"
+ - "python-3.7"

.circleci/requirements/dev-requirements-py37.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components==0.12.0rc3
 dash-flow-example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

.circleci/requirements/dev-requirements.txt

@@ -2,7 +2,7 @@ dash_core_components>=0.40.2
 dash_html_components>=0.12.0rc3
 dash_flow_example==0.0.3
 dash-dangerously-set-inner-html
-dash_renderer
+git+git://github.com/plotly/dash-renderer@master#egg=dash_renderer
 percy
 selenium
 mock

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+## Removed
+- Removed support for `Event` system. Use event properties instead, for example the `n_clicks` property instead of the `click` event, see [#531](https://github.com/plotly/dash/issues/531) for details. `dash_renderer` MUST be upgraded to >=0.17.0 together with this, and it is recommended to update `dash_core_components` to >=0.43.0 and `dash_html_components` to >=0.14.0. [#550](https://github.com/plotly/dash/pull/550)
+
 ## [0.35.3] - 2019-01-23
 ## Fixed
 - Asset blueprint takes routes prefix into it's static path. [#547](https://github.com/plotly/dash/pull/547)

dash/dash.py

@@ -15,13 +15,14 @@
 
 from functools import wraps
 
-import plotly
-import dash_renderer
 import flask
 from flask import Flask, Response
 from flask_compress import Compress
 
-from .dependencies import Event, Input, Output, State
+import plotly
+import dash_renderer
+
+from .dependencies import Input, Output, State
 from .resources import Scripts, Css
 from .development.base_component import Component
 from . import exceptions
@@ -622,7 +623,6 @@ def dependencies(self):
  },
  'inputs': v['inputs'],
  'state': v['state'],
- 'events': v['events']
  } for k, v in self.callback_map.items()
  ])
 
@@ -633,7 +633,7 @@ def react(self, *args, **kwargs):
  '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):
+ def _validate_callback(self, output, inputs, state):
  # pylint: disable=too-many-branches
  layout = self._cached_layout or self._layout_value()
 
@@ -652,8 +652,7 @@ def _validate_callback(self, output, inputs, state, events):
 
  for args, obj, name in [([output], Output, 'Output'),
  (inputs, Input, 'Input'),
- (state, State, 'State'),
- (events, Event, 'Event')]:
+ (state, State, 'State')]:
 
  if not isinstance(args, list):
  raise exceptions.IncorrectTypeException(
@@ -721,32 +720,20 @@ def _validate_callback(self, output, inputs, state, events):
  component.available_properties).replace(
  ' ', ''))
 
- if (hasattr(arg, 'component_event') and
- arg.component_event not in
- component.available_events):
+ if hasattr(arg, 'component_event'):
  raise exceptions.NonExistentEventException('''
- Attempting to assign a callback with
- the event "{}" but the component
- "{}" 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(' ', ''))
+ Events have been removed.
+ Use the associated property instead.
+ ''')
 
- if state and not events and not inputs:
- raise exceptions.MissingEventsException('''
+ if state and not inputs:
+ raise exceptions.MissingInputsException('''
  This callback has {} `State` {}
- but no `Input` elements or `Event` elements.\n
- Without `Input` or `Event` elements, this callback
+ but no `Input` elements.\n
+ Without `Input` elements, this callback
  will never get called.\n
  (Subscribing to input components will cause the
- callback to be called whenever their values
- change and subscribing to an event will cause the
- callback to be called whenever the event is fired.)
+ callback to be called whenever their values change.)
  '''.format(
  len(state),
  'elements' if len(state) > 1 else 'element'
@@ -888,8 +875,8 @@ def _validate_value(val, index=None):
  # 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)
+ def callback(self, output, inputs=[], state=[]):
+ self._validate_callback(output, inputs, state)
 
  callback_id = '{}.{}'.format(
  output.component_id, output.component_property
@@ -902,10 +889,6 @@ def callback(self, output, inputs=[], state=[], events=[]):
  'state': [
  {'id': c.component_id, 'property': c.component_property}
  for c in state
- ],
- 'events': [
- {'id': c.component_id, 'event': c.component_event}
- for c in events
  ]
  }
 

dash/dependencies.py

@@ -17,10 +17,3 @@ 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
- self.component_event = component_event

dash/development/_py_components_generation.py

@@ -3,6 +3,7 @@
 import os
 
 from dash.development.base_component import _explicitize_args
+from dash.exceptions import NonExistentEventException
 from ._all_keywords import python_keywords
 from .base_component import Component
 
@@ -27,8 +28,7 @@ def generate_class_string(typename, props, description, namespace):
  string
 
  """
- # TODO _prop_names, _type, _namespace, available_events,
- # and available_properties
+ # TODO _prop_names, _type, _namespace, and available_properties
  # can be modified by a Dash JS developer via setattr
  # TODO - Tab out the repr for the repr of these components to make it
  # look more like a hierarchical tree
@@ -52,7 +52,6 @@ def __init__(self, {default_argtext}):
  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}
@@ -101,11 +100,11 @@ def __repr__(self):
  docstring = create_docstring(
  component_name=typename,
  props=filtered_props,
- events=parse_events(props),
  description=description).replace('\r\n', '\n')
 
+ prohibit_events(props)
+
  # pylint: disable=unused-variable
- events = '[' + ', '.join(parse_events(props)) + ']'
  prop_keys = list(props.keys())
  if 'children' in props:
  prop_keys.remove('children')
@@ -122,7 +121,7 @@ def __repr__(self):
  for p in prop_keys
  if not p.endswith("-*") and
  p not in python_keywords and
- p not in ['dashEvents', 'fireEvent', 'setProps']] + ['**kwargs']
+ p != 'setProps'] + ['**kwargs']
  )
 
  required_args = required_props(props)
@@ -233,7 +232,7 @@ def required_props(props):
  if prop['required']]
 
 
-def create_docstring(component_name, props, events, description):
+def create_docstring(component_name, props, description):
  """
  Create the Dash component docstring
 
@@ -243,8 +242,6 @@ def create_docstring(component_name, props, events, description):
  Component name
  props: dict
  Dictionary with {propName: propMetadata} structure
- events: list
- List of Dash events
  description: str
  Component description
 
@@ -259,9 +256,7 @@ def create_docstring(component_name, props, events, description):
  return (
  """A {name} component.\n{description}
 
-Keyword arguments:\n{args}
-
-Available events: {events}"""
+Keyword arguments:\n{args}"""
  ).format(
  name=component_name,
  description=description,
@@ -274,30 +269,26 @@ def create_docstring(component_name, props, events, description):
  description=prop['description'],
  indent_num=0,
  is_flow_type='flowType' in prop and 'type' not in prop)
- for p, prop in list(filter_props(props).items())),
- events=', '.join(events))
+ for p, prop in list(filter_props(props).items())))
 
 
-def parse_events(props):
+def prohibit_events(props):
  """
-Pull out the dashEvents from the Component props
+Events have been removed. Raise an error if we see dashEvents or fireEvents
 
  Parameters
  ----------
  props: dict
  Dictionary with {propName: propMetadata} structure
 
-Returns
+Raises
  -------
- list
- List of Dash event strings
+ ?
  """
- if 'dashEvents' in props and props['dashEvents']['type']['name'] == 'enum':
- events = [v['value'] for v in props['dashEvents']['type']['value']]
- else:
- events = []
-
- return events
+ if 'dashEvents' in props or 'fireEvents' in props:
+ raise NonExistentEventException(
+ 'Events are no longer supported by dash. Use properties instead, '
+ 'eg `n_clicks` instead of a `click` event.')
 
 
 def parse_wildcards(props):
@@ -349,7 +340,6 @@ def filter_props(props):
  Filter props from the Component arguments to exclude:
  - Those without a "type" or a "flowType" field
  - Those with arg.type.name in {'func', 'symbol', 'instanceOf'}
- - dashEvents as a name
 
  Parameters
  ----------
@@ -415,10 +405,6 @@ def filter_props(props):
  else:
  raise ValueError
 
- # dashEvents are a special oneOf property that is used for subscribing
- # to events but it's never set as a property
- if arg_name in ['dashEvents']:
- filtered_props.pop(arg_name)
  return filtered_props
 
 
@@ -518,7 +504,7 @@ def map_js_to_py_types_prop_types(type_object):
  ', '.join(
  "'{}'".format(t)
  for t in list(type_object['value'].keys())),
- 'Those keys have the following types:\n{}'.format(
+ 'Those keys have the following types:\n{}'.format(
  '\n'.join(create_prop_docstring(
  prop_name=prop_name,
  type_object=prop,
@@ -561,7 +547,7 @@ def map_js_to_py_types_flow_types(type_object):
  signature=lambda indent_num: 'dict containing keys {}.\n{}'.format(
  ', '.join("'{}'".format(d['key'])
  for d in type_object['signature']['properties']),
- '{}Those keys have the following types:\n{}'.format(
+ '{}Those keys have the following types:\n{}'.format(
  ' ' * indent_num,
  '\n'.join(
  create_prop_docstring(

dash/exceptions.py

@@ -30,7 +30,7 @@ class IncorrectTypeException(CallbackException):
  pass
 
 
-class MissingEventsException(CallbackException):
+class MissingInputsException(CallbackException):
  pass
 
 

dash/extract-meta.js

@@ -8,7 +8,7 @@ const componentPaths = process.argv.slice(3);
 const ignorePattern = new RegExp(process.argv[2]);
 
 const excludedDocProps = [
- 'setProps', 'id', 'className', 'style', 'dashEvents', 'fireEvent'
+ 'setProps', 'id', 'className', 'style'
 ];
 
 if (!componentPaths.length) {

test.sh

@@ -0,0 +1,20 @@
+EXIT_STATE=0
+
+python -m unittest tests.development.test_base_component || EXIT_STATE=$?
+python -m unittest tests.development.test_component_loader || EXIT_STATE=$?
+python -m unittest tests.test_integration || EXIT_STATE=$?
+python -m unittest tests.test_resources || EXIT_STATE=$?
+python -m unittest tests.test_configs || EXIT_STATE=$?
+
+pylint dash setup.py --rcfile=$PYLINTRC || EXIT_STATE=$?
+pylint tests -d all -e C0410,C0411,C0412,C0413,W0109 || EXIT_STATE=$?
+flake8 dash setup.py || EXIT_STATE=$?
+flake8 --ignore=E123,E126,E501,E722,E731,F401,F841,W503,W504 --exclude=metadata_test.py tests || EXIT_STATE=$?
+
+if [ $EXIT_STATE -ne 0 ]; then
+ echo "One or more tests failed"
+else
+ echo "All tests passed!"
+fi
+
+exit $EXIT_STATE

tests/development/TestReactComponent.react.js

@@ -91,19 +91,9 @@ ReactComponent.propTypes = {
  }
  }),
 
- // special dash events
-
  children: React.PropTypes.node,
 
  id: React.PropTypes.string,
-
-
- // dashEvents is a special prop that is used to events validation
- dashEvents: React.PropTypes.oneOf([
- 'restyle',
- 'relayout',
- 'click'
- ])
 };
 
 ReactComponent.defaultProps = {