Use api.v2.plot_schema to get GRAPH_REFERENCE.

There is a circular import issue that needed to be fixed here as well.

Author: theengineear

Diff for: plotly/graph_reference.py

@@ -10,12 +10,11 @@
 import re
 from pkg_resources import resource_string
 
-import requests
 import six
 
-from plotly import files, utils
+from plotly import exceptions, files, utils
+from plotly.api import v2
 
-GRAPH_REFERENCE_PATH = '/v2/plot-schema'
 GRAPH_REFERENCE_DOWNLOAD_TIMEOUT = 5  # seconds
 
 
@@ -72,37 +71,24 @@ def get_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:
+        response = v2.plot_schema.retrieve(
+            sha1, timeout=GRAPH_REFERENCE_DOWNLOAD_TIMEOUT
+        )
+    except exceptions.PlotlyRequestError:
         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)
+        data = response.json()
         if data['modified']:
             graph_reference = data['schema']
 

Diff for: plotly/plotly/plotly.py

@@ -26,6 +26,7 @@
 
 from plotly import exceptions, tools, utils, files
 from plotly.api import v1, v2
+from plotly.graph_reference import GRAPH_REFERENCE
 from plotly.plotly import chunked_requests
 from plotly.session import (sign_in, update_session_plot_options,
                             get_session_plot_options)
@@ -46,7 +47,7 @@
 }
 
 # test file permissions and make sure nothing is corrupted
-tools.ensure_local_plotly_files()
+tools.ensure_local_plotly_files(graph_reference=GRAPH_REFERENCE)
 
 
 # don't break backwards compatibility

Diff for: plotly/tests/test_core/test_graph_reference/test_graph_reference.py

@@ -14,9 +14,12 @@
 from nose.plugins.attrib import attr
 
 from plotly import files, graph_reference as gr, tools, utils
+from plotly.api import v2
 from plotly.graph_reference import string_to_class_name, get_role
 from plotly.tests.utils import PlotlyTestCase
 
+FAKE_API_DOMAIN = 'https://api.am.not.here.ly'
+
 
 class TestGraphReferenceCaching(PlotlyTestCase):
 
@@ -40,7 +43,7 @@ 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')
+        tools.set_config_file(plotly_api_domain=FAKE_API_DOMAIN)
         local_graph_reference = {'real': 'local'}
         self.set_graph_reference(local_graph_reference)
         graph_reference = gr.get_graph_reference()
@@ -50,7 +53,7 @@ def test_get_graph_reference_bad_request_no_copy(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')
+        tools.set_config_file(plotly_api_domain=FAKE_API_DOMAIN)
         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')
@@ -61,15 +64,8 @@ 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)
-        response = requests.get(graph_reference_url)
-        if six.PY3:
-            content = str(response.content, encoding='utf-8')
-        else:
-            content = response.content
-        schema = json.loads(content)['schema']
+        response = v2.plot_schema.retrieve('')
+        schema = response.json()['schema']
 
         path = os.path.join('graph_reference', 'default-schema.json')
         s = resource_string('plotly', path).decode('utf-8')

Diff for: plotly/tools.py

@@ -19,7 +19,6 @@
 from plotly import colors
 from plotly import utils
 from plotly import exceptions
-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)
@@ -127,7 +126,7 @@ def get_config_defaults():
     return dict(FILE_CONTENT[CONFIG_FILE])  # performs a shallow copy
 
 
-def ensure_local_plotly_files():
+def ensure_local_plotly_files(graph_reference=None):
     """Ensure that filesystem is setup/filled out in a valid way.
     If the config or credential files aren't filled out, then write them
     to the disk.
@@ -148,8 +147,9 @@ def ensure_local_plotly_files():
 
         # 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)
+        if graph_reference is not None:
+            # This is a workaround to keep from having weird circular imports.
+            utils.save_json_dict(GRAPH_REFERENCE_FILE, graph_reference)
 
     else:
         warnings.warn("Looks like you don't have 'read-write' permission to "
@@ -1362,6 +1362,7 @@ def validate(obj, obj_type):
 
     """
     # TODO: Deprecate or move. #283
+    from plotly import graph_reference
     from plotly.graph_objs import graph_objs
 
     if obj_type not in graph_reference.CLASSES: