cleaned up url parsing + moved json_to_grid functionality to __init__ in Grid()

Author: Kully

plotly/grid_objs/grid_objs.py

@@ -118,29 +118,63 @@ class Grid(MutableSequence):
     py.plot([trace], filename='graph from grid')
     ```
     """
-    def __init__(self, iterable_of_columns):
+    def __init__(self, columns_or_json):
         """
-        Initialize a grid with an iterable of
-        `plotly.grid_objs.Column objects
+        Initialize a grid with an iterable of `plotly.grid_objs.Column`
+        objects or a json/dict describing a grid. See second usage example
+        below for the necessary structure of the dict.
 
-        Usage example:
+        Example from iterable of columns:
         ```
         column_1 = Column([1, 2, 3], 'time')
         column_2 = Column([4, 2, 5], 'voltage')
         grid = Grid([column_1, column_2])
         ```
+        Example from json grid
+        ```
+        grid_json = {
+            'cols': {
+                'time': {'data': [1, 2, 3], 'order': 0, 'uid': '4cd7fc'},
+                'voltage': {'data': [4, 2, 5], 'order': 1, 'uid': u'2744be'}
+            }
+        }
+        grid = Grid(grid_json)
+        ```
         """
 
         # TODO: verify that columns are actually columns
-
-        column_names = [column.name for column in iterable_of_columns]
-        duplicate_name = utils.get_first_duplicate(column_names)
-        if duplicate_name:
-            err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(duplicate_name)
-            raise exceptions.InputError(err)
-
-        self._columns = list(iterable_of_columns)
-        self.id = ''
+        if isinstance(columns_or_json, (list, tuple)):
+            column_names = [column.name for column in columns_or_json]
+            duplicate_name = utils.get_first_duplicate(column_names)
+            if duplicate_name:
+                err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(duplicate_name)
+                raise exceptions.InputError(err)
+
+            self._columns = list(columns_or_json)
+            self.id = ''
+        elif isinstance(columns_or_json, dict):
+            # check if 'cols' is only root key
+            if 'cols' not in columns_or_json:
+                raise exceptions.PlotlyError(
+                    "'cols' must be the one and only key in your json grid."
+                )
+
+            # check if 'data', 'order' and 'uid' are not in columns
+            grid_col_keys = ['data', 'order', 'uid']
+
+            for column_name in columns_or_json['cols']:
+                for key in grid_col_keys:
+                    if key not in columns_or_json['cols'][column_name]:
+                        raise exceptions.PlotlyError(
+                            "Each column name of your dictionary must have "
+                            "'data', 'order' and 'uid' as keys."
+                        )
+
+            self._columns = [Column(columns_or_json['cols'][column_name]['data'], column_name)
+                             for column_name in columns_or_json['cols']]
+            # fill in uids
+            for column in self:
+                column.id = columns_or_json['cols'][column.name]['uid']
 
     def __repr__(self):
         return self._columns.__repr__()

plotly/plotly/plotly.py

@@ -33,7 +33,7 @@
 from plotly.session import (sign_in, update_session_plot_options,
                             get_session_plot_options, get_session_credentials,
                             get_session_config)
-from plotly.grid_objs import grid_objs
+from plotly.grid_objs import Grid, Column
 
 __all__ = None
 
@@ -1470,26 +1470,17 @@ def get_grid(grid_url, raw=False):
                'plotly-platform': 'python'}
     upload_url = _api_v2.api_url('grids')
 
-    tilda_index = grid_url.find('~')
-    if grid_url[-1] == '/':
-        fid_in_url = grid_url[tilda_index + 1: -1].replace('/', ':')
-    else:
-        fid_in_url = grid_url[tilda_index + 1: len(grid_url)]
-        fid_in_url = fid_in_url.replace('/', ':')
-    get_url = upload_url + '/' + fid_in_url + '/content'
+    # extract path in grid url
+    url_path = six.moves.urllib.parse.urlparse(grid_url)[2][2:]
+    if url_path[-1] == '/':
+        url_path = url_path[0: -1]
+    url_path = url_path.replace('/', ':')
+    get_url = upload_url + '/' + url_path + '/content'
 
     r = requests.get(get_url, headers=headers)
     json_res = json.loads(r.text)
     if raw is False:
-        # create a new grid
-        new_grid = grid_objs.Grid(
-            [grid_objs.Column(json_res['cols'][column]['data'], column)
-             for column in json_res['cols']]
-        )
-        # fill in uids
-        for column in new_grid:
-            column.id = json_res['cols'][column.name]['uid']
-        return new_grid
+        return Grid(json_res)
     else:
         return json_res