IDE with defaults

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5

dash/development/base_component.py

@@ -1,5 +1,8 @@
 import collections
 import copy
+import os
+import inspect
+import yaml
 
 
 def is_number(s):
@@ -18,7 +21,65 @@ def _check_if_has_indexable_children(item):
  raise KeyError
 
 
+def _explicitize_args(func):
+ # Python 2
+ if hasattr(func, 'func_code'):
+ varnames = func.func_code.co_varnames
+ # Python 3
+ else:
+ varnames = func.__code__.co_varnames
+
+ def wrapper(*args, **kwargs):
+ if '_explicit_args' in kwargs.keys():
+ raise Exception('Variable _explicit_args should not be set.')
+ kwargs['_explicit_args'] = \
+ list(
+ set(
+ list(varnames[:len(args)]) + [k for k, _ in kwargs.items()]
+ )
+ )
+ if 'self' in kwargs['_explicit_args']:
+ kwargs['_explicit_args'].remove('self')
+ return func(*args, **kwargs)
+
+ # If Python 3, we can set the function signature to be correct
+ if hasattr(inspect, 'signature'):
+ # pylint: disable=no-member
+ new_sig = inspect.signature(wrapper).replace(
+ parameters=inspect.signature(func).parameters.values()
+ )
+ wrapper.__signature__ = new_sig
+ return wrapper
+
+
+def _convert_js_arg(value):
+ if 'defaultValue' in value:
+ # Convert custom types
+ if value['type']['name'] == 'custom' and 'raw' in value['type']:
+ value['type']['name'] =\
+ value['type']['raw'].replace('PropTypes.', '')
+ type_string = js_to_py_type(type_object=value['type'])
+ default_value = value['defaultValue']['value']
+ if type_string == 'boolean':
+ return default_value == 'true'
+ elif type_string.startswith('dict'):
+ d = yaml.load(default_value)
+ return str(d)
+ elif type_string in ['string', 'list', 'number', 'integer']:
+ return default_value
+ return 'Component._NO_DEFAULT_ARG'
+
+
 class Component(collections.MutableMapping):
+ class NO_DEFAULT_ARG(object):
+ def __repr__(self):
+ return 'NO_DEFAULT_ARG'
+
+ def __str__(self):
+ return 'NO_DEFAULT_ARG'
+
+ _NO_DEFAULT_ARG = NO_DEFAULT_ARG()
+
  def __init__(self, **kwargs):
  # pylint: disable=super-init-not-called
  for k, v in list(kwargs.items()):
@@ -35,7 +96,8 @@ def __init__(self, **kwargs):
  ', '.join(sorted(self._prop_names))
  )
  )
- setattr(self, k, v)
+ if v is not self._NO_DEFAULT_ARG:
+ setattr(self, k, v)
 
  def to_plotly_json(self):
  # Add normal properties
@@ -200,9 +262,10 @@ def __len__(self):
 
 
 # pylint: disable=unused-argument
-def generate_class(typename, props, description, namespace):
+def generate_class_string(typename, props, description, namespace):
+ # pylint: disable=too-many-locals
  """
- Dynamically generate classes to have nicely formatted docstrings,
+ Dynamically generate class strings to have nicely formatted docstrings,
  keyword arguments, and repr
 
  Inspired by http://jameso.be/2013/08/06/namedtuple.html
@@ -216,6 +279,7 @@ def generate_class(typename, props, description, namespace):
 
  Returns
  -------
+ string
 
  """
  # TODO _prop_names, _type, _namespace, available_events,
@@ -236,7 +300,8 @@ def generate_class(typename, props, description, namespace):
  # not all component authors will supply those.
  c = '''class {typename}(Component):
  """{docstring}"""
- def __init__(self, {default_argtext}):
+ @_explicitize_args
+ def __init__(self, {default_argtext}, **kwargs):
  self._prop_names = {list_of_valid_keys}
  self._type = '{typename}'
  self._namespace = '{namespace}'
@@ -247,11 +312,16 @@ def __init__(self, {default_argtext}):
  self.available_wildcard_properties =\
  {list_of_valid_wildcard_attr_prefixes}
 
+ _explicit_args = kwargs.pop('_explicit_args')
+ _locals = locals()
+ args = {{k: _locals[k] for k in self._prop_names
+ if k != 'children' and not k.endswith('-*')}}
+ args.update(kwargs) # For wildcard attrs
+
  for k in {required_args}:
- if k not in kwargs:
+ if k not in _explicit_args:
  raise TypeError(
  'Required argument `' + k + '` was not specified.')
-
  super({typename}, self).__init__({argtext})
 
  def __repr__(self):
@@ -276,13 +346,15 @@ def __repr__(self):
  return (
  '{typename}(' +
  repr(getattr(self, self._prop_names[0], None)) + ')')
-'''
+'''
 
+ omitted_props = ['dashEvents', 'fireEvent', 'setProps']
  filtered_props = reorder_props(filter_props(props))
  # pylint: disable=unused-variable
  list_of_valid_wildcard_attr_prefixes = repr(parse_wildcards(props))
  # pylint: disable=unused-variable
- list_of_valid_keys = repr(list(filtered_props.keys()))
+ list_of_valid_keys = repr([str(x) for x in filtered_props.keys()
+ if x not in omitted_props])
  # pylint: disable=unused-variable
  docstring = create_docstring(
  component_name=typename,
@@ -292,19 +364,84 @@ def __repr__(self):
 
  # pylint: disable=unused-variable
  events = '[' + ', '.join(parse_events(props)) + ']'
+ prop_keys = list(props.keys())
  if 'children' in props:
- default_argtext = 'children=None, **kwargs'
+ exclude_children = True
+ default_argtext = "children=None, "
  # pylint: disable=unused-variable
- argtext = 'children=children, **kwargs'
+ argtext = 'children=children, **args'
  else:
- default_argtext = '**kwargs'
- argtext = '**kwargs'
+ exclude_children = False
+ default_argtext = ""
+ argtext = '**args'
+ default_argtext += ", ".join([
+ '{:s}={}'.format(
+ p, v
+ ) for p, v in [(p, _convert_js_arg(v)) for p, v in props.items()]
+ if not (
+ p.endswith("-*") or
+ (exclude_children and p == "children") or
+ p in omitted_props
+ )])
 
  required_args = required_props(props)
+ return c.format(**locals())
+
+
+# pylint: disable=unused-argument
+def generate_class_file(typename, props, description, namespace):
+ """
+ Generate a python class file (.py) given a class string
+
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ import_string =\
+ "# AUTO GENERATED FILE - DO NOT EDIT\n\n" + \
+ "from dash.development.base_component import " + \
+ "Component, _explicitize_args\n\n\n"
+ class_string = generate_class_string(
+ typename,
+ props,
+ description,
+ namespace
+ )
+ file_name = "{:s}.py".format(typename)
+
+ file_path = os.path.join(namespace, file_name)
+ with open(file_path, 'w') as f:
+ f.write(import_string)
+ f.write(class_string)
+
+
+# pylint: disable=unused-argument
+def generate_class(typename, props, description, namespace):
+ """
+ Generate a python class object given a class string
 
- scope = {'Component': Component}
+ Parameters
+ ----------
+ typename
+ props
+ description
+ namespace
+
+ Returns
+ -------
+
+ """
+ string = generate_class_string(typename, props, description, namespace)
+ scope = {'Component': Component, '_explicitize_args': _explicitize_args}
  # pylint: disable=exec-used
- exec(c.format(**locals()), scope)
+ exec(string, scope)
  result = scope[typename]
  return result
 
@@ -573,6 +710,7 @@ def map_js_to_py_types_prop_types(type_object):
  array=lambda: 'list',
  bool=lambda: 'boolean',
  number=lambda: 'number',
+ integer=lambda: 'integer',
  string=lambda: 'string',
  object=lambda: 'dict',
  any=lambda: 'boolean | number | string | dict | list',

dash/development/component_loader.py

@@ -1,6 +1,18 @@
 import collections
 import json
+import os
 from .base_component import generate_class
+from .base_component import generate_class_file
+
+
+def _get_metadata(metadata_path):
+ # Start processing
+ with open(metadata_path) as data_file:
+ json_string = data_file.read()
+ data = json\
+ .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
+ .decode(json_string)
+ return data
 
 
 def load_components(metadata_path,
@@ -20,12 +32,7 @@ def load_components(metadata_path,
 
  components = []
 
- # Start processing
- with open(metadata_path) as data_file:
- json_string = data_file.read()
- data = json\
- .JSONDecoder(object_pairs_hook=collections.OrderedDict)\
- .decode(json_string)
+ data = _get_metadata(metadata_path)
 
  # Iterate over each property name (which is a path to the component)
  for componentPath in data:
@@ -47,3 +54,56 @@ def load_components(metadata_path,
  components.append(component)
 
  return components
+
+
+def generate_classes(namespace, metadata_path='lib/metadata.json'):
+ """Load React component metadata into a format Dash can parse,
+ then create python class files.
+
+ Usage: generate_classes()
+
+ Keyword arguments:
+ namespace -- name of the generated python package (also output dir)
+
+ metadata_path -- a path to a JSON file created by
+ [`react-docgen`](https://github.com/reactjs/react-docgen).
+
+ Returns:
+ """
+
+ data = _get_metadata(metadata_path)
+ imports_path = os.path.join(namespace, '_imports_.py')
+
+ # Make sure the file doesn't exist, as we use append write
+ if os.path.exists(imports_path):
+ os.remove(imports_path)
+
+ # Iterate over each property name (which is a path to the component)
+ for componentPath in data:
+ componentData = data[componentPath]
+
+ # Extract component name from path
+ # e.g. src/components/MyControl.react.js
+ # TODO Make more robust - some folks will write .jsx and others
+ # will be on windows. Unfortunately react-docgen doesn't include
+ # the name of the component atm.
+ name = componentPath.split('/').pop().split('.')[0]
+ generate_class_file(
+ name,
+ componentData['props'],
+ componentData['description'],
+ namespace
+ )
+
+ # Add an import statement for this component
+ with open(imports_path, 'a') as f:
+ f.write('from .{0:s} import {0:s}\n'.format(name))
+
+ # Add the __all__ value so we can import * from _imports_
+ all_imports = [p.split('/').pop().split('.')[0] for p in data]
+ with open(imports_path, 'a') as f:
+ array_string = '[\n'
+ for a in all_imports:
+ array_string += ' "{:s}",\n'.format(a)
+ array_string += ']\n'
+ f.write('\n\n__all__ = {:s}'.format(array_string))

dash/version.py

@@ -1 +1 @@
-__version__ = '0.21.1'
+__version__ = '0.22.0'

dev-requirements.txt

@@ -13,3 +13,4 @@ plotly>=2.0.8
 requests[security]
 flake8
 pylint
+PyYAML

requirements.txt

@@ -35,6 +35,7 @@ py==1.4.33
 Pygments==2.2.0
 python-dateutil==2.5.3
 pytz==2017.2
+PyYAML==3.12.0
 requests==2.13.0
 requests-file==1.4.1
 scandir==1.5