Don’t auto-download graph reference on import.

Conflicts:
	plotly/api/v2/plot_schema.py
	plotly/graph_reference.py
	plotly/tests/test_core/test_api/test_v2/test_plot_schema.py
	plotly/tests/test_core/test_graph_reference/test_graph_reference.py

Author: theengineear

makefile

@@ -18,11 +18,12 @@ setup_subs :
 
 update_default_schema :
 	@echo "Making sure the default-schema.json file is up to date"
-	python -c "import json;\
-               from plotly.graph_reference import GRAPH_REFERENCE;\
+	python -c "import requests;/
+               from requests.compat import json as _json;\
+               response = requests.get('https://api.plot.ly/v2/plot-schema?sha1';/
                f = open('plotly/graph_reference/default-schema.json', 'w');\
-               json.dump(GRAPH_REFERENCE, f, indent=4, sort_keys=True,\
-                   separators=(',', ': '));\
+               _json.dump(response.json()['schema'], f, indent=4,\
+                          sort_keys=True, separators=(',', ': '));\
                f.close()"
 
 install : sync_subs

plotly/files.py

@@ -4,7 +4,6 @@
 PLOTLY_DIR = os.path.join(os.path.expanduser("~"), ".plotly")
 CREDENTIALS_FILE = os.path.join(PLOTLY_DIR, ".credentials")
 CONFIG_FILE = os.path.join(PLOTLY_DIR, ".config")
-GRAPH_REFERENCE_FILE = os.path.join(PLOTLY_DIR, ".graph_reference")
 TEST_DIR = os.path.join(os.path.expanduser("~"), ".test")
 TEST_FILE = os.path.join(PLOTLY_DIR, ".permission_test")
 

plotly/graph_reference.py

@@ -4,19 +4,14 @@
 """
 from __future__ import absolute_import
 
-import hashlib
-import json
 import os
 import re
 from pkg_resources import resource_string
 
-import requests
 import six
+from requests.compat import json as _json
 
-from plotly import files, utils
-
-GRAPH_REFERENCE_PATH = '/v2/plot-schema'
-GRAPH_REFERENCE_DOWNLOAD_TIMEOUT = 5  # seconds
+from plotly import utils
 
 
 # For backwards compat, we keep this list of previously known objects.
@@ -66,45 +61,14 @@
 
 def get_graph_reference():
     """
-    Attempts to load local copy of graph reference or makes GET request if DNE.
+    Load graph reference JSON (aka plot-schema)
 
     :return: (dict) The graph reference.
-    :raises: (PlotlyError) When graph reference DNE and GET request fails.
 
     """
-    default_config = files.FILE_CONTENT[files.CONFIG_FILE]
-    if files.check_file_permissions():
-        graph_reference = utils.load_json_dict(files.GRAPH_REFERENCE_FILE)
-        config = utils.load_json_dict(files.CONFIG_FILE)
-
-        # TODO: https://github.com/plotly/python-api/issues/293
-        plotly_api_domain = config.get('plotly_api_domain',
-                                       default_config['plotly_api_domain'])
-    else:
-        graph_reference = {}
-        plotly_api_domain = default_config['plotly_api_domain']
-
-    sha1 = hashlib.sha1(six.b(str(graph_reference))).hexdigest()
-
-    graph_reference_url = '{}{}?sha1={}'.format(plotly_api_domain,
-                                                GRAPH_REFERENCE_PATH, sha1)
-    try:
-        response = requests.get(graph_reference_url,
-                                timeout=GRAPH_REFERENCE_DOWNLOAD_TIMEOUT)
-        response.raise_for_status()
-    except requests.exceptions.RequestException:
-        if not graph_reference:
-            path = os.path.join('graph_reference', 'default-schema.json')
-            s = resource_string('plotly', path).decode('utf-8')
-            graph_reference = json.loads(s)
-    else:
-        if six.PY3:
-            content = str(response.content, encoding='utf-8')
-        else:
-            content = response.content
-        data = json.loads(content)
-        if data['modified']:
-            graph_reference = data['schema']
+    path = os.path.join('graph_reference', 'default-schema.json')
+    s = resource_string('plotly', path).decode('utf-8')
+    graph_reference = _json.loads(s)
 
     return utils.decode_unicode(graph_reference)
 

plotly/tests/test_core/test_graph_reference/test_graph_reference.py

@@ -13,46 +13,17 @@
 import six
 from nose.plugins.attrib import attr
 
-from plotly import files, graph_reference as gr, tools, utils
+from plotly import files, graph_reference as gr
 from plotly.graph_reference import string_to_class_name, get_role
 from plotly.tests.utils import PlotlyTestCase
 
 
 class TestGraphReferenceCaching(PlotlyTestCase):
 
-    def set_graph_reference(self, graph_reference):
-        if files.check_file_permissions():
-            utils.save_json_dict(files.GRAPH_REFERENCE_FILE, graph_reference)
-
-    @attr('slow')
-    def test_get_graph_reference_outdated(self):
-
-        # if the hash of the current graph reference doesn't match the hash of
-        # the graph reference a Plotly server has, we should update!
-
-        outdated_graph_reference = {'real': 'old'}
-        self.set_graph_reference(outdated_graph_reference)
-        graph_reference = gr.get_graph_reference()
-        self.assertNotEqual(graph_reference, outdated_graph_reference)
-
-    def test_get_graph_reference_bad_request_local_copy(self):
-
-        # if the request fails (mocked by using a bad url here) and a local
-        # copy of the graph reference exists, we can just use that.
-
-        tools.set_config_file(plotly_api_domain='api.am.not.here.ly')
-        local_graph_reference = {'real': 'local'}
-        self.set_graph_reference(local_graph_reference)
-        graph_reference = gr.get_graph_reference()
-        self.assertEqual(graph_reference, local_graph_reference)
-
-    def test_get_graph_reference_bad_request_no_copy(self):
+    def test_get_graph_reference(self):
 
         # if we don't have a graph reference we load an outdated default
 
-        tools.set_config_file(plotly_api_domain='api.am.not.here.ly')
-        empty_graph_reference = {}  # set it to a false-y value.
-        self.set_graph_reference(empty_graph_reference)
         path = os.path.join('graph_reference', 'default-schema.json')
         s = resource_string('plotly', path).decode('utf-8')
         default_graph_reference = json.loads(s)
@@ -62,8 +33,7 @@ def test_get_graph_reference_bad_request_no_copy(self):
     @attr('slow')
     def test_default_schema_is_up_to_date(self):
         api_domain = files.FILE_CONTENT[files.CONFIG_FILE]['plotly_api_domain']
-        graph_reference_url = '{}{}?sha1'.format(api_domain,
-                                                 gr.GRAPH_REFERENCE_PATH)
+        graph_reference_url = '{}{}?sha1'.format(api_domain, '/v2/plot-schema')
         response = requests.get(graph_reference_url)
         if six.PY3:
             content = str(response.content, encoding='utf-8')

plotly/tests/utils.py

@@ -37,18 +37,13 @@ def stash_files(self):
         if files.check_file_permissions():
             self._credentials = utils.load_json_dict(files.CREDENTIALS_FILE)
             self._config = utils.load_json_dict(files.CONFIG_FILE)
-            self._graph_reference = \
-                utils.load_json_dict(files.GRAPH_REFERENCE_FILE)
 
     def restore_files(self):
         if files.check_file_permissions():
             if self._credentials is not None:
                 utils.save_json_dict(files.CREDENTIALS_FILE, self._credentials)
             if self._config is not None:
                 utils.save_json_dict(files.CONFIG_FILE, self._config)
-            if self._graph_reference is not None:
-                utils.save_json_dict(files.GRAPH_REFERENCE_FILE,
-                                     self._graph_reference)
 
     def stash_session(self):
         self._session = copy.deepcopy(session._session)

plotly/tools.py

@@ -22,7 +22,7 @@
 from plotly import graph_reference
 from plotly import session
 from plotly.files import (CONFIG_FILE, CREDENTIALS_FILE, FILE_CONTENT,
-                          GRAPH_REFERENCE_FILE, check_file_permissions)
+                          check_file_permissions)
 
 DEFAULT_PLOTLY_COLORS = ['rgb(31, 119, 180)', 'rgb(255, 127, 14)',
                          'rgb(44, 160, 44)', 'rgb(214, 39, 40)',
@@ -146,11 +146,6 @@ def ensure_local_plotly_files():
                     del contents[key]
             utils.save_json_dict(fn, contents)
 
-        # make a request to get graph reference if DNE.
-        utils.ensure_file_exists(GRAPH_REFERENCE_FILE)
-        utils.save_json_dict(GRAPH_REFERENCE_FILE,
-                             graph_reference.GRAPH_REFERENCE)
-
     else:
         warnings.warn("Looks like you don't have 'read-write' permission to "
                       "your 'home' ('~') directory or to our '~/.plotly' "