Merge branch 'master' into embed-width-height

chriddyp · chriddyp · commit 7c68c295ffce · 2014-11-16T18:26:27.000-05:00
diff --git a/plotly/exceptions.py b/plotly/exceptions.py
@@ -16,6 +16,7 @@
 
 """
 import json
+import six
 
 ## Base Plotly Error ##
 
@@ -36,7 +37,9 @@ def __init__(self, requests_exception):
         if 'json' in content_type:
             content = requests_exception.response.content
             if content != '':
-                res_payload = json.loads(requests_exception.response.content)
+                res_payload = json.loads(
+                    requests_exception.response.content.decode('utf8')
+                )
                 if 'detail' in res_payload:
                     self.message = res_payload['detail']
                 else:
diff --git a/plotly/graph_objs/graph_objs.py b/plotly/graph_objs/graph_objs.py
@@ -215,7 +215,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with
@@ -323,14 +323,14 @@ def __setitem__(self, key, value):
         return super(PlotlyDict, self).__setitem__(key, value)
 
     def _assign_id_to_src(self, src_name, src_value):
-        if isinstance(src_value, basestring):
+        if isinstance(src_value, six.string_types):
             src_id = src_value
         else:
             try:
                 src_id = src_value.id
             except:
-                err = ("{} does not have an `id` property. "
-                       "{} needs to be assigned to either an "
+                err = ("{0} does not have an `id` property. "
+                       "{1} needs to be assigned to either an "
                        "object with an `id` (like a "
                        "plotly.grid_objs.Column) or a string. "
                        "The `id` is a unique identifier "
@@ -430,7 +430,7 @@ def strip_style(self):
                         elif not hasattr(self[key], '__iter__'):
                             del self[key]
                 except KeyError:  # TODO: Update the JSON
-                    # print "'type' not in {0} for {1}".format(obj_key, key)
+                    # print("'type' not in {0} for {1}".format(obj_key, key))
                     pass
 
     def get_data(self):
@@ -605,7 +605,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with
@@ -759,7 +759,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with
@@ -962,7 +962,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with
diff --git a/plotly/grid_objs/grid_objs.py b/plotly/grid_objs/grid_objs.py
@@ -35,7 +35,7 @@ def __str__(self):
     def __repr__(self):
         return 'Column("{}", {})'.format(self.data, self.name)
 
-    def to_json(self):
+    def to_plotly_json(self):
         return {'name': self.name, 'data': self.data}
 
 
diff --git a/plotly/plotly/plotly.py b/plotly/plotly/plotly.py
@@ -701,7 +701,7 @@ def _fill_in_response_column_ids(cls, request_columns,
         for req_col in request_columns:
             for resp_col in response_columns:
                 if resp_col['name'] == req_col.name:
-                    req_col.id = '{}/{}'.format(grid_id, resp_col['uid'])
+                    req_col.id = '{0}/{1}'.format(grid_id, resp_col['uid'])
                     response_columns.remove(resp_col)
 
     @classmethod
@@ -751,7 +751,7 @@ def upload(cls, grid, filename,
         grid.id = grid_id
 
         plotly_domain = get_config()['plotly_domain']
-        grid_url = '{}/~{}'.format(plotly_domain, grid_id.replace(':', '/'))
+        grid_url = '{0}/~{1}'.format(plotly_domain, grid_id.replace(':', '/'))
 
         if meta is not None:
             meta_ops.upload(meta, grid=grid)
@@ -800,8 +800,8 @@ def append_rows(cls, rows, grid=None, grid_url=None):
                     raise exceptions.InputError(
                         "The number of entries in "
                         "each row needs to equal the number of columns in "
-                        "the grid. Row {} has {} {} but your "
-                        "grid has {} {}. "
+                        "the grid. Row {0} has {1} {2} but your "
+                        "grid has {3} {4}. "
                         .format(row_i, len(row),
                                 'entry' if len(row) == 1 else 'entries',
                                 n_columns,
@@ -896,7 +896,7 @@ def parse_grid_id_args(cls, grid, grid_url):
             if supplied_arg_name == 'grid_url':
                 path = urlparse(grid_url).path
                 file_owner, file_id = path.replace("/~", "").split('/')[0:2]
-                return '{}:{}'.format(file_owner, file_id)
+                return '{0}:{1}'.format(file_owner, file_id)
             else:
                 return grid.id
 
@@ -913,7 +913,7 @@ def response_handler(cls, response):
                 'json' in response.headers['content-type'] and
                 len(response.content) > 0):
 
-            response_dict = json.loads(response.content)
+            response_dict = json.loads(response.content.decode('utf8'))
 
             if 'warnings' in response_dict and len(response_dict['warnings']):
                 warnings.warn('\n'.join(response_dict['warnings']))
@@ -922,16 +922,19 @@ def response_handler(cls, response):
 
     @classmethod
     def api_url(cls, resource):
-        return ('{}/v2/{}'.format(get_config()['plotly_api_domain'],
+        return ('{0}/v2/{1}'.format(get_config()['plotly_api_domain'],
                 resource))
 
     @classmethod
     def headers(cls):
         un, api_key = _get_session_username_and_key()
-        encoded_un_key_pair = base64.b64encode('{}:{}'.format(un, api_key))
+        encoded_un_key_pair = base64.b64encode(
+            six.b('{0}:{1}'.format(un, api_key))
+        ).decode('utf8')
+
         return {
             'authorization': 'Basic ' + encoded_un_key_pair,
-            'plotly-client-platform': 'python {}'.format(version.__version__)
+            'plotly-client-platform': 'python {0}'.format(version.__version__)
         }
 
 
diff --git a/plotly/tests/test_core/test_file/test_file.py b/plotly/tests/test_core/test_file/test_file.py
@@ -36,7 +36,7 @@ def test_create_folder():
 @with_setup(init)
 def test_create_nested_folders():
     first_folder = _random_filename()
-    nested_folder = '{}/{}'.format(first_folder, _random_filename())
+    nested_folder = '{0}/{1}'.format(first_folder, _random_filename())
     py.file_ops.mkdirs(nested_folder)
 
 
diff --git a/plotly/tests/test_core/test_get_requests/test_get_requests.py b/plotly/tests/test_core/test_get_requests/test_get_requests.py
@@ -144,6 +144,6 @@ def test_valid_request():
     # response_payload = content['payload']
     # figure = response_payload['figure']
     # if figure['data'][0]['x'] != [u'1', u'2', u'3']:
-    #     print 'ERROR'
+    #     print('ERROR')
     # return res
 
diff --git a/plotly/tests/test_core/test_graph_objs/nose_tools.py b/plotly/tests/test_core/test_graph_objs/nose_tools.py
@@ -10,28 +10,30 @@
 def compare_dict(dict1, dict2, equivalent=True, msg='', tol=10e-8):
     for key in dict1:
         if key not in dict2:
-            return False, "{} should be {}".format(list(dict1.keys()), list(dict2.keys()))
+            return (False,
+                    "{0} should be {1}".format(
+                        list(dict1.keys()), list(dict2.keys())))
     for key in dict1:
         if isinstance(dict1[key], dict):
             equivalent, msg = compare_dict(dict1[key],
                                            dict2[key],
                                            tol=tol)
         elif isinstance(dict1[key], Num) and isinstance(dict2[key], Num):
             if not comp_nums(dict1[key], dict2[key], tol):
-                return False, "['{}'] = {} should be {}".format(key,
-                                                                dict1[key],
-                                                                dict2[key])
+                return False, "['{0}'] = {1} should be {2}".format(key,
+                                                                   dict1[key],
+                                                                   dict2[key])
         elif is_num_list(dict1[key]) and is_num_list(dict2[key]):
             if not comp_num_list(dict1[key], dict2[key], tol):
-                return False, "['{}'] = {} should be {}".format(key,
-                                                                dict1[key],
-                                                                dict2[key])
+                return False, "['{0}'] = {1} should be {2}".format(key,
+                                                                   dict1[key],
+                                                                   dict2[key])
         elif not (dict1[key] == dict2[key]):
-                return False, "['{}'] = {} should be {}".format(key,
-                                                                dict1[key],
-                                                                dict2[key])
+                return False, "['{0}'] = {1} should be {2}".format(key,
+                                                                   dict1[key],
+                                                                   dict2[key])
         if not equivalent:
-            return False, "['{}']".format(key) + msg
+            return False, "['{0}']".format(key) + msg
     return equivalent, msg
 
 
diff --git a/plotly/tests/test_core/test_graph_objs/test_plotly_dict.py b/plotly/tests/test_core/test_graph_objs/test_plotly_dict.py
@@ -18,7 +18,7 @@ def test_trivial():
 
 # @raises(PlotlyError)  # TODO: decide if this SHOULD raise error...
 # def test_instantiation_error():
-#     print PlotlyDict(anything='something')
+#     print(PlotlyDict(anything='something'))
 
 
 def test_validate():
diff --git a/plotly/tests/test_core/test_graph_objs/test_plotly_trace.py b/plotly/tests/test_core/test_graph_objs/test_plotly_trace.py
@@ -18,7 +18,7 @@ def test_trivial():
 
 # @raises(PlotlyError)  # TODO: decide if this SHOULD raise error...
 # def test_instantiation_error():
-#     print Trace(anything='something')
+#     print(Trace(anything='something'))
 
 
 def test_validate():
diff --git a/plotly/tests/test_core/test_graph_objs/test_scatter.py b/plotly/tests/test_core/test_graph_objs/test_scatter.py
@@ -19,7 +19,7 @@ def test_trivial():
 
 # @raises(PlotlyError)  # TODO: decide if this SHOULD raise error...
 # def test_instantiation_error():
-#     print PlotlyDict(anything='something')
+#     print(PlotlyDict(anything='something'))
 
 
 def test_validate():
diff --git a/plotly/tests/test_core/test_graph_objs/test_to_string.py b/plotly/tests/test_core/test_graph_objs/test_to_string.py
@@ -35,4 +35,4 @@ def test_to_string():
 def test_nested_list():
     z = [[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12,
           13, 14, 15, 16, 17, 18, 19, 20, 21]]
-    print Contour(z=z).to_string()
+    print(Contour(z=z).to_string())
diff --git a/plotly/tests/test_core/test_grid/test_grid.py b/plotly/tests/test_core/test_grid/test_grid.py
@@ -55,7 +55,10 @@ def test_grid_upload():
 @with_setup(init)
 def test_grid_upload_in_new_folder():
     g = get_grid()
-    path = 'new folder: {}/grid in folder {}'.format(random_filename(), random_filename())
+    path = (
+        'new folder: {0}/grid in folder {1}'
+        .format(random_filename(), random_filename())
+    )
     py.grid_ops.upload(g, path, auto_open=False)
 
 
@@ -65,7 +68,10 @@ def test_grid_upload_in_existing_folder():
     folder = random_filename()
     filename = random_filename()
     py.file_ops.mkdirs(folder)
-    path = 'existing folder: {}/grid in folder {}'.format(folder, filename)
+    path =(
+        'existing folder: {0}/grid in folder {1}'
+        .format(folder, filename)
+    )
     py.grid_ops.upload(g, path, auto_open=False)
 
 
diff --git a/plotly/tests/test_optional/test_matplotlylib/test_date_times.py b/plotly/tests/test_optional/test_matplotlylib/test_date_times.py
@@ -37,8 +37,8 @@ def test_normal_mpl_dates(self):
         # convert this figure to plotly's graph_objs
         pfig = tls.mpl_to_plotly(fig)
 
-        print date_strings
-        print pfig['data'][0]['x']
+        print(date_strings)
+        print(pfig['data'][0]['x'])
         # we use the same format here, so we expect equality here
         self.assertEqual(
             fig.axes[0].lines[0].get_xydata()[0][0], 7.33776000e+05
diff --git a/plotly/tests/test_optional/test_utils/test_utils.py b/plotly/tests/test_optional/test_utils/test_utils.py
@@ -5,15 +5,17 @@
 from datetime import datetime as dt
 import numpy as np
 import json
+import pandas as pd
 
 from plotly import utils
 from plotly.grid_objs import Column
-from plotly.graph_objs import Scatter3d, Figure, Data
+from plotly.graph_objs import Scatter, Scatter3d, Figure, Data
 
 ## JSON encoding
 numeric_list = [1, 2, 3]
 np_list = np.array([1, 2, 3])
 mixed_list = [1, 'A', dt(2014, 1, 5)]
+pd = pd.DataFrame(columns=['col 1'], data=[1, 2, 3])
 
 
 def test_column_json_encoding():
@@ -22,17 +24,25 @@ def test_column_json_encoding():
         Column(mixed_list, 'col 2'),
         Column(np_list, 'col 3')
     ]
-    json_columns = json.dumps(columns, cls=utils._plotlyJSONEncoder)
+    json_columns = json.dumps(
+        columns, cls=utils._plotlyJSONEncoder, sort_keys=True
+    )
     assert('[{"data": [1, 2, 3], "name": "col 1"}, '
            '{"data": [1, "A", "2014-01-05"], "name": "col 2"}, '
            '{"data": [1, 2, 3], "name": "col 3"}]' == json_columns)
 
 
 def test_figure_json_encoding():
-    s = Scatter3d(x=numeric_list, y=np_list, z=mixed_list)
-    data = Data([s])
+    s1 = Scatter3d(x=numeric_list, y=np_list, z=mixed_list)
+    s2 = Scatter(x=pd['col 1'])
+    data = Data([s1, s2])
     figure = Figure(data=data)
 
-    json.dumps(s, cls=utils._plotlyJSONEncoder)
-    json.dumps(data, cls=utils._plotlyJSONEncoder)
-    json.dumps(figure, cls=utils._plotlyJSONEncoder)
+    js1 = json.dumps(s1, cls=utils._plotlyJSONEncoder, sort_keys=True)
+    js2 = json.dumps(s2, cls=utils._plotlyJSONEncoder, sort_keys=True)
+
+    assert(js1 == '{"type": "scatter3d", "x": [1, 2, 3], '+
+                  '"y": [1, 2, 3], "z": [1, "A", "2014-01-05"]}')
+    assert(js2 == '{"type": "scatter", "x": [1, 2, 3]}')
+    json.dumps(data, cls=utils._plotlyJSONEncoder, sort_keys=True)
+    json.dumps(figure, cls=utils._plotlyJSONEncoder, sort_keys=True)
diff --git a/plotly/tests/utils.py b/plotly/tests/utils.py
@@ -4,28 +4,30 @@
 def compare_dict(dict1, dict2, equivalent=True, msg='', tol=10e-8):
     for key in dict1:
         if key not in dict2:
-            return False, "{} should be {}".format(list(dict1.keys()), list(dict2.keys()))
+            return (False,
+                    "{0} should be {1}".format(
+                        list(dict1.keys()), list(dict2.keys())))
     for key in dict1:
         if isinstance(dict1[key], dict):
             equivalent, msg = compare_dict(dict1[key],
                                            dict2[key],
                                            tol=tol)
         elif isinstance(dict1[key], Num) and isinstance(dict2[key], Num):
             if not comp_nums(dict1[key], dict2[key], tol):
-                return False, "['{}'] = {} should be {}".format(key,
-                                                                dict1[key],
-                                                                dict2[key])
+                return False, "['{0}'] = {1} should be {2}".format(key,
+                                                                   dict1[key],
+                                                                   dict2[key])
         elif is_num_list(dict1[key]) and is_num_list(dict2[key]):
             if not comp_num_list(dict1[key], dict2[key], tol):
-                return False, "['{}'] = {} should be {}".format(key,
-                                                                dict1[key],
-                                                                dict2[key])
+                return False, "['{0}'] = {1} should be {2}".format(key,
+                                                                   dict1[key],
+                                                                   dict2[key])
         elif not (dict1[key] == dict2[key]):
-                return False, "['{}'] = {} should be {}".format(key,
-                                                                dict1[key],
-                                                                dict2[key])
+                return False, "['{0}'] = {1} should be {2}".format(key,
+                                                                   dict1[key],
+                                                                   dict2[key])
         if not equivalent:
-            return False, "['{}']".format(key) + msg
+            return False, "['{0}']".format(key) + msg
     return equivalent, msg
 
 
diff --git a/plotly/utils.py b/plotly/utils.py
@@ -128,7 +128,7 @@ def sageJSONEncoder(self, obj):
 
     def builtinJSONEncoder(self, obj):
         try:
-            return obj.to_json()
+            return obj.to_plotly_json()
         except AttributeError:
             return None
 
diff --git a/plotly/version.py b/plotly/version.py
@@ -1 +1 @@
-__version__ = '1.4.3'
+__version__ = '1.4.4'
