Sep 26, 2015 · Sep 15, 2015 · Sep 15, 2015 · Sep 15, 2015 · Sep 15, 2015 · Sep 15, 2015
diff --git a/plotly/graph_objs/graph_objs.py b/plotly/graph_objs/graph_objs.py
diff --git a/plotly/graph_objs/graph_objs_tools.py b/plotly/graph_objs/graph_objs_tools.py
diff --git a/plotly/graph_reference.py b/plotly/graph_reference.py
diff --git a/plotly/tests/test_core/test_graph_reference/test_graph_reference.py b/plotly/tests/test_core/test_graph_reference/test_graph_reference.py
diff --git a/plotly/tools.py b/plotly/tools.py
Original file line number	Diff line number	Diff line change
Expand Up		@@ -940,7 +940,7 @@ def create(object_name, args, *kwargs):
		"""
		if object_name not in graph_reference.OBJECTS:
		raise Exception('tbd') # TODO
	class_name = graph_reference.string_to_class_name(object_name)
	class_name = graph_reference.object_name_to_class_name(object_name)
		graph_object_class = globals()[class_name]

		return graph_object_class(args, *kwargs)
Expand All		@@ -964,14 +964,14 @@ def _add_classes_to_globals(globals):
		dict_class=PlotlyDict)
		doc = graph_objs_tools.make_doc(object_name)
		class_dict.update(__doc__=doc, __name__=class_name)
	cls = type(class_name, class_bases, class_dict)
	cls = type(str(class_name), class_bases, class_dict)

		globals[class_name] = cls

		for key, val in graph_reference.CLASS_NAMES_TO_OBJECT_NAMES.items():
		if val == object_name:
		class_dict.update(__name__=key)
	cls = type(key, class_bases, class_dict)
	cls = type(str(key), class_bases, class_dict)
		globals[key] = cls

		_add_classes_to_globals(globals())
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,7 +13,7 @@ def get_class_create_args(object_name, list_class=list, dict_class=dict):

		object_paths = graph_reference.OBJECTS[object_name]

	class_name = graph_reference.string_to_class_name(object_name)
	class_name = graph_reference.object_name_to_class_name(object_name)

		if object_paths:
		object_infos = [graph_reference.get_object_info(path, object_name)
Expand Down Expand Up		@@ -59,7 +59,7 @@ def _make_list_doc(name):

		# TODO: https://github.com/plotly/python-api/issues/289
		items = get_class_create_args(name)[2]['_items']
	items_classes = [graph_reference.string_to_class_name(item)
	items_classes = [graph_reference.object_name_to_class_name(item)
		for item in items]
		doc = 'Documentation for {}.\n'.format(name)
		doc = '\t' + '\n\t'.join(textwrap.wrap(doc, width=LINE_SIZE)) + '\n\n'
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,8 +18,10 @@
		'ColorBar': 'colorbar',
		'Area': 'scatter',
		'Font': 'textfont',
	'Histogram2d': 'histogram2d',
		'Histogram2dContour': 'histogram2dcontour',
		'RadialAxis': 'radialaxis',
	'Scatter3d': 'scatter3d',
		'XAxis': 'xaxis',
		'XBins': 'xbins',
		'YAxis': 'yaxis',
Expand Down Expand Up		@@ -70,22 +72,23 @@ def get_graph_reference():
		return utils.decode_unicode(graph_reference)


	def string_to_class_name(string):
	def object_name_to_class_name(object_name):
		"""
		Single function to handle turning object names into class names.

		GRAPH_REFERENCE has names like `error_y`, which we'll turn into `ErrorY`.

	:param (str) string: Presumably an object_name from GRAPH_REFERENCE.
	:param (str) object_name: Presumably an object_name from GRAPH_REFERENCE.
		:return: (str)

		"""
	string = _get_hr_name(object_name)

		# capitalize first letter
		string = re.sub(r'[A-Za-z]', lambda m: m.group().title(), string, count=1)

		# replace `_<c>` with `<C>` E.g., `Error_x` --> `ErrorX`
	string = re.sub(r'_[A-Za-z]+', lambda m: m.group()[1:].title(), string)
	string = re.sub(r'_[A-Za-z0-9]+', lambda m: m.group()[1:].title(), string)

		return string
Copy link Member @chriddyp chriddyp Sep 18, 2015 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. this is going to be so annoying to rewrite in liquid templating Copy link Member @chriddyp chriddyp Sep 18, 2015 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Not so bad: plotly/documentation@`76f2735` Copy link Member @chriddyp chriddyp Sep 18, 2015 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. So this depreciates `XBins` in favor of `Xbins`, and `XAxis` in favor of `Xaxis`, eh? Copy link Contributor Author @theengineear theengineear Sep 19, 2015 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. yeah, exactly. The funky thing about this is if we add an hr_name of `x_axis` at some point `Xaxis` would go away, making a backwards incompatible change... one way to prevent it is to use the object name and the hrName to create classes... which does a lot of doubling... I'm not sure what the right path is here.

Expand Down Expand Up		@@ -132,6 +135,20 @@ def attribute_is_array(attribute, parent_name):
		return False


	def _get_hr_name(object_name):
	"""Get human readable object name from reference ('hrName')."""
	object_paths = OBJECTS[object_name]

	if object_paths:
	object_infos = [get_object_info(path, object_name)
	for path in object_paths]
	else:
	object_info = get_object_info(None, object_name)
	object_infos = [object_info]

	return object_infos[0]['hr_name']


		def _get_objects():
		"""
		Return the main dict that we'll work with for graph objects.
Expand Down Expand Up		@@ -174,7 +191,7 @@ def _get_class_names_to_object_names():
		"""
		class_names_to_object_names = {}
		for object_name in OBJECTS:
	class_name = string_to_class_name(object_name)
	class_name = object_name_to_class_name(object_name)
		class_names_to_object_names[class_name] = object_name

		for class_name in _BACKWARDS_COMPAT_CLASS_NAME_TO_OBJECT_NAME:
Expand Down Expand Up		@@ -202,6 +219,7 @@ def _get_object_info_from_path(path, object_name):
		is_array = False
		parent = path[-1]
		name = parent[:-1]
	hr_name = attribute_container.get('hrName', name)
		description = attribute_container.get('description', '')
		attributes = {k: v for k, v in attribute_container.items()
		if k not in GRAPH_REFERENCE['defs']['metaKeys']}
Expand All		@@ -210,6 +228,7 @@ def _get_object_info_from_path(path, object_name):
		else:

		name = path[-1]
	hr_name = path_value.get('hrName', name)

		if path[-2] == 'attributes':
		parent = path[-3] # a trace
Expand Down Expand Up		@@ -238,6 +257,7 @@ def _get_object_info_from_path(path, object_name):
		'is_array': is_array,
		'parent': parent,
		'name': name,
	'hr_name': hr_name,
		'description': description,
		'attributes': attributes,
		'items': items
Expand Down Expand Up		@@ -265,15 +285,18 @@ def _get_object_info_from_name(object_name):
		description = 'A {} trace'.format(object_name)
		attributes = {k: v for k, v in trace['attributes'].items()}
		attributes['type'] = {'role': 'info'}
	hr_name = trace.get('hrName', object_name)

	return {'role': 'object', 'name': object_name, 'is_array': False,
	'parent': 'data', 'description': description,
	'attributes': attributes, 'items': None}
	return {'role': 'object', 'name': object_name, 'hr_name': hr_name,
	'is_array': False, 'parent': 'data',
	'description': description, 'attributes': attributes,
	'items': None}

		elif object_name == 'data':

	return {'role': 'object', 'name': 'data', 'is_array': True,
	'parent': 'figure', 'attributes': None, 'items': TRACE_NAMES,
	return {'role': 'object', 'name': 'data', 'hr_name': 'data',
	'is_array': True, 'parent': 'figure', 'attributes': None,
	'items': TRACE_NAMES,
		'description': 'Array container for trace objects.'}

		elif object_name == 'layout':
Expand All		@@ -297,17 +320,19 @@ def _get_object_info_from_name(object_name):
		if key not in GRAPH_REFERENCE['defs']['metaKeys']:
		attributes[key] = val

	return {'role': 'object', 'name': 'layout', 'is_array': False,
	'parent': 'figure', 'attributes': attributes, 'items': None,
	return {'role': 'object', 'name': 'layout', 'hr_name': 'layout',
	'is_array': False, 'parent': 'figure',
	'attributes': attributes, 'items': None,
		'description': 'Plot layout object container.'}

		else: # assume it's 'figure'

		attributes = {'data': _get_object_info_from_name('data'),
		'layout': _get_object_info_from_name('layout')}

	return {'role': 'object', 'name': 'figure', 'is_array': False,
	'parent': '', 'description': 'Top level of figure object.',
	return {'role': 'object', 'name': 'figure', 'hr_name': 'figure',
	'is_array': False, 'parent': '',
	'description': 'Top level of figure object.',
		'attributes': attributes, 'items': None}


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,19 +6,33 @@

		from unittest import TestCase

	from plotly.graph_reference import string_to_class_name
	from plotly.graph_reference import object_name_to_class_name


	class TestStringToClass(TestCase):
	class TestObjectNameToClass(TestCase):

		def test_capitalize_first_letter(self):
	strings = ['a', 'bee', 'see', 'dilla']
	class_names = ['A', 'Bee', 'See', 'Dilla']
	for string, class_name in zip(strings, class_names):
	self.assertEqual(string_to_class_name(string), class_name)

	object_names = ['marker', 'line', 'scatter']
	class_names = ['Marker', 'Line', 'Scatter']
	for object_name, class_name in zip(object_names, class_names):
	self.assertEqual(
	object_name_to_class_name(object_name), class_name
	)

		def test_capitalize_after_underscore(self):
	strings = ['any_thing', 'cat_paws']
	class_names = ['AnyThing', 'CatPaws']
	for string, class_name in zip(strings, class_names):
	self.assertEqual(string_to_class_name(string), class_name)

	object_names = ['error_y', 'error_x']
	class_names = ['ErrorY', 'ErrorX']
	for object_name, class_name in zip(object_names, class_names):
	self.assertEqual(
	object_name_to_class_name(object_name), class_name
	)

	def test_use_hr_name(self):

	# we should be checking for an hr_name in the plot schema.

	object_name = 'histogram2dcontour'
	class_name = 'Histogram2DContour'
	self.assertEqual(object_name_to_class_name(object_name), class_name)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1297,7 +1297,7 @@ def validate(obj, obj_type):
		from plotly.graph_objs import graph_objs

		if obj_type not in graph_reference.CLASS_NAMES_TO_OBJECT_NAMES:
	obj_type = graph_reference.string_to_class_name(obj_type)
	obj_type = graph_reference.object_name_to_class_name(obj_type)

		try:
		cls = getattr(graph_objs, obj_type)
Expand Down