migrating all network code out of dashboards_objs.py

Author: Kully

plotly/api/v2/__init__.py

@@ -1,4 +1,4 @@
 from __future__ import absolute_import
 
-from plotly.api.v2 import (files, folders, grids, images, plot_schema, plots,
-                           users)
+from plotly.api.v2 import (dashboards, files, folders, grids, images, plot_schema,
+                           plots, users)

plotly/dashboard_objs/dashboard_objs.py

@@ -56,6 +56,7 @@ def __init__(self, dashboard_json=None, backgroundColor='#FFFFFF',
                  boxHeaderBackgroundColor='#f8f8f8', foregroundColor='#333333',
                  headerBackgroundColor='#2E3A46', headerForegroundColor='#FFFFFF',
                  links=[], logoUrl='', title='Untitled Dashboard'):
+        # TODO: change name to box_id_to_path
         self.box_ids_dict = {}
         if not dashboard_json:
             self['layout'] = EmptyBox()
@@ -72,30 +73,33 @@ def __init__(self, dashboard_json=None, backgroundColor='#FFFFFF',
                 'logoUrl': logoUrl,
                 'title': title
             }
-            # TODO: change name to box_id_to_path
         else:
             self['layout'] = dashboard_json['layout']
-            self['version'] = dashboard_json['layout']
+            self['version'] = dashboard_json['version']
             self['settings'] = dashboard_json['settings']
 
-            all_nodes = []
-            node_gen = node_generator(dashboard_json['layout'])
+            self._assign_boxes_to_ids()
 
-            finished_iteration = False
-            while not finished_iteration:
-                try:
-                    all_nodes.append(node_gen.next())
-                except StopIteration:
-                    finished_iteration = True
+    def _assign_boxes_to_ids(self):
+        self.box_ids_dict = {}
+        all_nodes = []
+        node_gen = node_generator(self['layout'])
 
-            for node in all_nodes:
-                if (node[1] != () and node[0]['type'] == 'box' and
-                    node[0]['boxType'] != 'empty'):
-                    try:
-                        max_id = max(self.box_ids_dict.keys())
-                    except ValueError:
-                        max_id = 0
-                    self.box_ids_dict[max_id + 1] = list(node[1])
+        finished_iteration = False
+        while not finished_iteration:
+            try:
+                all_nodes.append(node_gen.next())
+            except StopIteration:
+                finished_iteration = True
+
+        for node in all_nodes:
+            if (node[1] != () and node[0]['type'] == 'box'
+                    and node[0]['boxType'] != 'empty'):
+                try:
+                    max_id = max(self.box_ids_dict.keys())
+                except ValueError:
+                    max_id = 0
+                self.box_ids_dict[max_id + 1] = list(node[1])
 
     def _insert(self, box_or_container, array_of_paths):
         """Performs user-unfriendly box and container manipulations."""
@@ -195,10 +199,10 @@ def insert(self, box, box_id=None, side='above'):
                 )
             if box_id not in self.box_ids_dict:
                 raise exceptions.PlotlyError(
-                    "Your box_id must a number which is pointing to a box in "
-                    "your dashboard."
+                    "Your box_id must a number in your dashboard. To view a "
+                    "representation of your dashboard run 'get_preview()'."
                 )
-
+            #self._assign_boxes_to_ids()
             if side == 'above':
                 old_box = self._get_box(box_id)
                 self._insert(
@@ -223,6 +227,12 @@ def insert(self, box, box_id=None, side='above'):
                     Container(old_box, box, direction='horizontal'),
                     self.box_ids_dict[box_id]
                 )
+            else:
+                raise exceptions.PlotlyError(
+                    "If there is at least one box in your dashboard, you "
+                    "must specify a valid side value. You must choose from "
+                    "'above', 'below', 'left', and 'right'."
+                )
 
 
 def upload_dashboard(dashboard_object, filename, world_readable,
@@ -255,48 +265,3 @@ def upload_dashboard(dashboard_object, filename, world_readable,
     url = res.json()['web_url']
     webbrowser.open_new(res.json()['web_url'])
     return url
-
-
-# little wrapper around requests.get
-def get(*args, **kwargs):
-    return requests.get(
-        *args, auth=(username, api_key), headers=headers, **kwargs
-    )
-
-
-def _get_all_dashboards():
-    """Grab a list of all users' dashboards."""
-    dashboards = []
-    res = get(build_url('dashboards')).json()
-
-    for dashboard in res['results']:
-        if not dashboard['deleted']:
-            dashboards.append(dashboard)
-    while res['next']:
-        res = get(res['next']).json()
-
-        for dashboard in res['results']:
-            if not dashboard['deleted']:
-                dashboards.append(dashboard)
-    return dashboards
-
-
-def _get_dashboard_json(dashboard_name):
-    dashboards = _get_all_dashboards()
-    for index, dboard in enumerate(dashboards):
-        if dboard['filename'] == dashboard_name:
-            break
-
-    dashboard = get(dashboards[index]['api_urls']['dashboards']).json()
-    dashboard_json = json.loads(dashboard['content'])
-    return dashboard_json
-
-
-def get_dashboard_names():
-    dashboards = _get_all_dashboards()
-    return [str(dboard['filename']) for dboard in dashboards]
-
-
-def get_dashboard(dashboard_name):
-    dashboard_json = _get_dashboard_json(dashboard_name)
-    return Dashboard(dashboard_json)

plotly/plotly/__init__.py

@@ -23,6 +23,11 @@
     file_ops,
     get_config,
     get_grid,
+    _get_all_dashboards,
+    _get_dashboard_json,
+    get_dashboard,
+    get_dashboard_names,
+    dashboard_ops,
     create_animations,
     icreate_animations
 )

plotly/plotly/plotly.py

@@ -17,8 +17,10 @@
 from __future__ import absolute_import
 
 import copy
+import json
 import os
 import warnings
+import webbrowser
 
 import six
 import six.moves
@@ -28,6 +30,7 @@
 from plotly.api import v1, v2
 from plotly.plotly import chunked_requests
 from plotly.grid_objs import Grid, Column
+from plotly.dashboard_objs import dashboard_objs as dashboard
 
 # This is imported like this for backwards compat. Careful if changing.
 from plotly.config import get_config, get_credentials
@@ -1342,6 +1345,97 @@ def get_grid(grid_url, raw=False):
     return Grid(parsed_content, fid)
 
 
+def _get_all_dashboards():
+    """Grab a list of all users' dashboards."""
+    dashboards = []
+    res = v2.dashboards.list().json()
+
+    for dashboard in res['results']:
+        if not dashboard['deleted']:
+            dashboards.append(dashboard)
+    while res['next']:
+        res = v2.utils.request('get', res['next']).json()
+
+        for dashboard in res['results']:
+            if not dashboard['deleted']:
+                dashboards.append(dashboard)
+    return dashboards
+
+
+def _get_dashboard_json(dashboard_name):
+    dashboards = _get_all_dashboards()
+    for index, dboard in enumerate(dashboards):
+        if dboard['filename'] == dashboard_name:
+            break
+
+    dashboard = v2.utils.request('get', dashboards[index]['api_urls']['dashboards']).json()
+    dashboard_json = json.loads(dashboard['content'])
+    return dashboard_json
+
+
+def get_dashboard(dashboard_name):
+    """
+    Some BETA pass of getting a dashboard from Plotly.
+
+    May need to put in dashboard_ops.
+    """
+    dashboard_json = _get_dashboard_json(dashboard_name)
+    return dashboard.Dashboard(dashboard_json)
+
+
+def get_dashboard_names():
+    dashboards = _get_all_dashboards()
+    return [str(dboard['filename']) for dboard in dashboards]
+
+
+class dashboard_ops:
+    """
+    Interface to Plotly's Dashboards API.
+    Plotly Dashboards are JSON blobs. They are made up by a bunch of
+    containers which contain either empty boxes or boxes with file urls.
+    """
+    @classmethod
+    def upload(cls, dashboard, filename,
+               sharing='public', auto_open=True):
+        """
+        BETA function for uploading dashboards to Plotly.
+
+        Functionality that we may need to consider adding:
+        - filename needs to be able to support `/` to create or use folders.
+          This'll require a few API calls.
+        - this function only works if the filename is unique. Need to call
+          `update` if this file already exists to overwrite the file.
+        - world_readable really should be `sharing` and allow `public`,
+          `private`, or `secret` like in `py.plot`.
+        - auto_open parameter for opening the result.
+        """
+        if sharing == 'public':
+            world_readable = True
+        elif sharing == 'private':
+            world_readable = False
+        elif sharing == 'secret':
+            world_readable = False
+
+        data = {
+            'content': json.dumps(dashboard),
+            'filename': filename,
+            'world_readable': world_readable
+        }
+
+        res = v2.dashboards.create(data)
+        res.raise_for_status()
+
+        url = res.json()['web_url']
+
+        if auto_open:
+            webbrowser.open_new(res.json()['web_url'])
+
+        if sharing == 'secret':
+            url = add_share_key_to_url(url)
+
+        return url
+
+
 def create_animations(figure, filename=None, sharing='public', auto_open=True):
     """
     BETA function that creates plots with animations via `frames`.